Crate aws_sdk_sqs

Welcome to the Amazon SQS API Reference.

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.

For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.

You can use Amazon Web Services SDKs 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

• Amazon SQS Developer Guide

  • Making API Requests

  • Amazon SQS Message Attributes

  • Amazon SQS Dead-Letter Queues

• Amazon SQS in the Command Line Interface

• Amazon Web Services General Reference

  • Regions and Endpoints

Crate Organization

The entry point for most customers will be Client. Client exposes one method for each API offered by the service.

Some APIs require complex or nested arguments. These exist in model.

Lastly, errors that can be returned by the service are contained within error. Error defines a meta error encompassing all possible errors that can be returned by the service.

The other modules within this crate are not required for normal usage.

Examples

Examples can be found here.

Modules

client

Client and fluent builders for calling the service.

config

Configuration for the service.

endpoint

Endpoint resolution functionality

error

All error types that operations can return. Documentation on these types is copied from the model.

input

Input structures for operations. Documentation on these types is copied from the model.

middleware

Base Middleware Stack

model

Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.

operation

All operations that this crate can perform.

output

Output structures for operations. Documentation on these types is copied from the model.

paginator

Paginators for the service

types

Data primitives referenced by other data types.

Structs

AppName

App name that can be configured with an AWS SDK client to become part of the user agent string.

Client

Client for Amazon Simple Queue Service

Config

Service config.

Credentials

AWS SDK Credentials

EndpointDeprecated

API Endpoint

Region

The region to send requests to.

Enums

Error

All possible error types for this service.

Statics

PKG_VERSION

Crate version number.