mirror of
https://github.com/rclone/rclone.git
synced 2024-12-11 17:51:12 +01:00
116 lines
4.8 KiB
Go
116 lines
4.8 KiB
Go
|
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
|
||
|
|
|
||
|
|
// Package sqs provides the client and types for making API
|
||
|
|
// requests to Amazon Simple Queue Service.
|
||
|
|
//
|
||
|
|
// Welcome to the Amazon Simple Queue Service API Reference.
|
||
|
|
//
|
||
|
|
// Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted
|
||
|
|
// queue for storing messages as they travel between applications or microservices.
|
||
|
|
// Amazon SQS moves data between distributed application components and helps
|
||
|
|
// you decouple these components.
|
||
|
|
//
|
||
|
|
// Standard queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html)
|
||
|
|
// are available in all regions. FIFO queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html)
|
||
|
|
// are available in US West (Oregon) and US East (Ohio).
|
||
|
|
//
|
||
|
|
// You can use AWS SDKs (http://aws.amazon.com/tools/#sdk) to access Amazon
|
||
|
|
// SQS using your favorite programming language. The SDKs perform tasks such
|
||
|
|
// as the following automatically:
|
||
|
|
//
|
||
|
|
// * Cryptographically sign your service requests
|
||
|
|
//
|
||
|
|
// * Retry requests
|
||
|
|
//
|
||
|
|
// * Handle error responses
|
||
|
|
//
|
||
|
|
// Additional Information
|
||
|
|
//
|
||
|
|
// * Amazon SQS Product Page (http://aws.amazon.com/sqs/)
|
||
|
|
//
|
||
|
|
// * Amazon SQS Developer Guide
|
||
|
|
//
|
||
|
|
// Making API Requests (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/MakingRequestsArticle.html)
|
||
|
|
//
|
||
|
|
// Using Amazon SQS Message Attributes (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html)
|
||
|
|
//
|
||
|
|
// Using Amazon SQS Dead Letter Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
|
||
|
|
//
|
||
|
|
// * Amazon Web Services General Reference
|
||
|
|
//
|
||
|
|
// Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region)
|
||
|
|
//
|
||
|
|
// See https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05 for more information on this service.
|
||
|
|
//
|
||
|
|
// See sqs package documentation for more information.
|
||
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/
|
||
|
|
//
|
||
|
|
// Using the Client
|
||
|
|
//
|
||
|
|
// To use the client for Amazon Simple Queue Service you will first need
|
||
|
|
// to create a new instance of it.
|
||
|
|
//
|
||
|
|
// When creating a client for an AWS service you'll first need to have a Session
|
||
|
|
// already created. The Session provides configuration that can be shared
|
||
|
|
// between multiple service clients. Additional configuration can be applied to
|
||
|
|
// the Session and service's client when they are constructed. The aws package's
|
||
|
|
// Config type contains several fields such as Region for the AWS Region the
|
||
|
|
// client should make API requests too. The optional Config value can be provided
|
||
|
|
// as the variadic argument for Sessions and client creation.
|
||
|
|
//
|
||
|
|
// Once the service's client is created you can use it to make API requests the
|
||
|
|
// AWS service. These clients are safe to use concurrently.
|
||
|
|
//
|
||
|
|
// // Create a session to share configuration, and load external configuration.
|
||
|
|
// sess := session.Must(session.NewSession())
|
||
|
|
//
|
||
|
|
// // Create the service's client with the session.
|
||
|
|
// svc := sqs.New(sess)
|
||
|
|
//
|
||
|
|
// See the SDK's documentation for more information on how to use service clients.
|
||
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/
|
||
|
|
//
|
||
|
|
// See aws package's Config type for more information on configuration options.
|
||
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
|
||
|
|
//
|
||
|
|
// See the Amazon Simple Queue Service client SQS for more
|
||
|
|
// information on creating the service's client.
|
||
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/#New
|
||
|
|
//
|
||
|
|
// Once the client is created you can make an API request to the service.
|
||
|
|
// Each API method takes a input parameter, and returns the service response
|
||
|
|
// and an error.
|
||
|
|
//
|
||
|
|
// The API method will document which error codes the service can be returned
|
||
|
|
// by the operation if the service models the API operation's errors. These
|
||
|
|
// errors will also be available as const strings prefixed with "ErrCode".
|
||
|
|
//
|
||
|
|
// result, err := svc.AddPermission(params)
|
||
|
|
// if err != nil {
|
||
|
|
// // Cast err to awserr.Error to handle specific error codes.
|
||
|
|
// aerr, ok := err.(awserr.Error)
|
||
|
|
// if ok && aerr.Code() == <error code to check for> {
|
||
|
|
// // Specific error code handling
|
||
|
|
// }
|
||
|
|
// return err
|
||
|
|
// }
|
||
|
|
//
|
||
|
|
// fmt.Println("AddPermission result:")
|
||
|
|
// fmt.Println(result)
|
||
|
|
//
|
||
|
|
// Using the Client with Context
|
||
|
|
//
|
||
|
|
// The service's client also provides methods to make API requests with a Context
|
||
|
|
// value. This allows you to control the timeout, and cancellation of pending
|
||
|
|
// requests. These methods also take request Option as variadic parameter to apply
|
||
|
|
// additional configuration to the API request.
|
||
|
|
//
|
||
|
|
// ctx := context.Background()
|
||
|
|
//
|
||
|
|
// result, err := svc.AddPermissionWithContext(ctx, params)
|
||
|
|
//
|
||
|
|
// See the request package documentation for more information on using Context pattern
|
||
|
|
// with the SDK.
|
||
|
|
// https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
|
||
|
|
package sqs
|