awsquerycompatible

Documentation

Overview

Package awsquerycompatible provides the client and types for making API requests to AWSQuery Compatible Service.

See https://docs.aws.amazon.com/goto/WebAPI/awsquerycompatible-2012-11-05 for more information on this service.

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

Using the Client

To contact AWSQuery Compatible 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 AWSQuery Compatible Service client AwsQueryCompatible for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/awsquerycompatible/#New

Index

• Constants
• type AwsQueryCompatible
  • func New(p client.ConfigProvider, cfgs ...*aws.Config) *AwsQueryCompatible
  • func (c *AwsQueryCompatible) CreateQueue(input *CreateQueueInput) (*CreateQueueOutput, error)
  • func (c *AwsQueryCompatible) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, output *CreateQueueOutput)
  • func (c *AwsQueryCompatible) CreateQueueWithContext(ctx aws.Context, input *CreateQueueInput, opts ...request.Option) (*CreateQueueOutput, error)
• type CreateQueueInput
  • func (s CreateQueueInput) GoString() string
  • func (s *CreateQueueInput) SetQueueName(v string) *CreateQueueInput
  • func (s CreateQueueInput) String() string
  • func (s *CreateQueueInput) Validate() error
• type CreateQueueOutput
  • func (s CreateQueueOutput) GoString() string
  • func (s *CreateQueueOutput) SetQueueUrl(v string) *CreateQueueOutput
  • func (s CreateQueueOutput) String() string
• type QueueDeletedRecently
  • func (s *QueueDeletedRecently) Code() string
  • func (s *QueueDeletedRecently) Error() string
  • func (s QueueDeletedRecently) GoString() string
  • func (s *QueueDeletedRecently) Message() string
  • func (s *QueueDeletedRecently) OrigErr() error
  • func (s *QueueDeletedRecently) RequestID() string
  • func (s *QueueDeletedRecently) StatusCode() int
  • func (s QueueDeletedRecently) String() string
• type QueueNameExists
  • func (s *QueueNameExists) Code() string
  • func (s *QueueNameExists) Error() string
  • func (s QueueNameExists) GoString() string
  • func (s *QueueNameExists) Message() string
  • func (s *QueueNameExists) OrigErr() error
  • func (s *QueueNameExists) RequestID() string
  • func (s *QueueNameExists) StatusCode() int
  • func (s QueueNameExists) String() string

Constants

const (

	// ErrCodeQueueDeletedRecently for service response error code
	// "QueueDeletedRecently".
	ErrCodeQueueDeletedRecently = "QueueDeletedRecently"

	// ErrCodeQueueNameExists for service response error code
	// "QueueNameExists".
	ErrCodeQueueNameExists = "QueueNameExists"
)

const (
	ServiceName = "AWSQueryCompatible"    // Name of service.
	EndpointsID = "awsqc-exampleendpoint" // ID to lookup a service endpoint with.
	ServiceID   = "AWSQueryCompatible"    // ServiceID is a unique identifier of a specific service.
)

Service information constants

Types

type AwsQueryCompatible

type AwsQueryCompatible struct {
	*client.Client
}

AwsQueryCompatible provides the API operation methods for making requests to AWSQuery Compatible Service. See this package's package overview docs for details on the service.

AwsQueryCompatible 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) *AwsQueryCompatible

New creates a new instance of the AwsQueryCompatible 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 AwsQueryCompatible client from just a session.
svc := awsquerycompatible.New(mySession)

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

func (*AwsQueryCompatible) CreateQueue

func (c *AwsQueryCompatible) CreateQueue(input *CreateQueueInput) (*CreateQueueOutput, error)

CreateQueue API operation for AWSQuery Compatible 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 AWSQuery Compatible Service's API operation CreateQueue for usage and error information.

Returned Error Types:

• QueueDeletedRecently

• QueueNameExists

See also, https://docs.aws.amazon.com/goto/WebAPI/awsquerycompatible-2012-11-05/CreateQueue

func (*AwsQueryCompatible) CreateQueueRequest

func (c *AwsQueryCompatible) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, output *CreateQueueOutput)

CreateQueueRequest generates a "aws/request.Request" representing the client's request for the CreateQueue 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 CreateQueue for more information on using the CreateQueue 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 CreateQueueRequest method.
req, resp := client.CreateQueueRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/awsquerycompatible-2012-11-05/CreateQueue

func (*AwsQueryCompatible) CreateQueueWithContext

func (c *AwsQueryCompatible) CreateQueueWithContext(ctx aws.Context, input *CreateQueueInput, opts ...request.Option) (*CreateQueueOutput, error)

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

See CreateQueue 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.

type CreateQueueInput

type CreateQueueInput struct {

	// QueueName is a required field
	QueueName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQueueInput) GoString

func (s CreateQueueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQueueInput) SetQueueName

func (s *CreateQueueInput) SetQueueName(v string) *CreateQueueInput

SetQueueName sets the QueueName field's value.

func (CreateQueueInput) String

func (s CreateQueueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQueueInput) Validate

func (s *CreateQueueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateQueueOutput

type CreateQueueOutput struct {
	QueueUrl *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateQueueOutput) GoString

func (s CreateQueueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateQueueOutput) SetQueueUrl

func (s *CreateQueueOutput) SetQueueUrl(v string) *CreateQueueOutput

SetQueueUrl sets the QueueUrl field's value.

func (CreateQueueOutput) String

func (s CreateQueueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueueDeletedRecently

type QueueDeletedRecently struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
	Code_        *string

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

func (*QueueDeletedRecently) Code

func (s *QueueDeletedRecently) Code() string

Code returns the exception type name.

func (*QueueDeletedRecently) Error

func (s *QueueDeletedRecently) Error() string

func (QueueDeletedRecently) GoString

func (s QueueDeletedRecently) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueueDeletedRecently) Message

func (s *QueueDeletedRecently) Message() string

Message returns the exception's message.

func (*QueueDeletedRecently) OrigErr

func (s *QueueDeletedRecently) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*QueueDeletedRecently) RequestID

func (s *QueueDeletedRecently) RequestID() string

RequestID returns the service's response RequestID for request.

func (*QueueDeletedRecently) StatusCode

func (s *QueueDeletedRecently) StatusCode() int

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

func (QueueDeletedRecently) String

func (s QueueDeletedRecently) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueueNameExists

type QueueNameExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
	Code_        *string

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

func (*QueueNameExists) Code

func (s *QueueNameExists) Code() string

Code returns the exception type name.

func (*QueueNameExists) Error

func (s *QueueNameExists) Error() string

func (QueueNameExists) GoString

func (s QueueNameExists) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueueNameExists) Message

func (s *QueueNameExists) Message() string

Message returns the exception's message.

func (*QueueNameExists) OrigErr

func (s *QueueNameExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*QueueNameExists) RequestID

func (s *QueueNameExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*QueueNameExists) StatusCode

func (s *QueueNameExists) StatusCode() int

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

func (QueueNameExists) String

func (s QueueNameExists) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".