@aws-sdk/client-sqs-node v0.1.0-preview.2
@aws-sdk/client-sqs-node
Description
Installing
To install the this package using NPM, simply type the following into a terminal window:
npm install @aws-sdk/client-sqs-node
Getting Started
Import
The AWS SDK is modulized by clients and commends in CommonJS modules. To send a request, you only need to import the client(SQSClient
) and the commands you need, for example AddPermissionCommand
:
//javascript
const { SQSClient } = require('@aws-sdk/client-sqs-node/SQSClient');
const { AddPermissionCommand } = require('@aws-sdk/client-sqs-node/commands/AddPermissionCommand');
//typescript
const { SQSClient } = import '@aws-sdk/client-sqs-node/SQSClient';
const { AddPermissionCommand } = import '@aws-sdk/client-sqs-node/commands/AddPermissionCommand';
Usage
To send a request, you:
- Initiate client with configurations.(credentials, region). For more information you can refer to the API reference.
- Initiate command with input parameters.
- Call
send
operation of client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const sQS = new SQSClient({region: 'region'});
//clients can be shared by different commands
const params = {
QueueUrl: /**a string value*/,
Label: /**a string value*/,
AWSAccountIds: [ /**a list of string*/ ],
Actions: [ /**a list of string*/ ],
};
const addPermissionCommand = new AddPermissionCommand(params);
sQS.send(addPermissionCommand).then(data => {
// do something
}).catch(error => {
// error handling
})
Besides using promise style, there are 2 other ways to send a request:
// async/await
try {
const data = await sQS.send(addPermissionCommand);
// do something
} catch(error) {
// error handling
}
// callback
sQS.send(addPermissionCommand, (err, data) => {
//do something
})
Besides using send()
, the SDK can also send requests using the simplified callback style in version 2 of the SDK.
import * as AWS from '@aws-sdk/@aws-sdk/client-sqs-node/SQS';
const sQS = new AWS.SQS({region: 'region'})
sQS.addPermission(params, (err, data) => {
//do something
})
Troubleshooting
When the service returns an exception, inpecting the exceptions is always helpful. You can not only access the exception information but also response metadata(i.e request id).
try {
const data = await sQS.send(addPermissionCommand);
// do something
} catch(error) {
const metadata = error.$metadata;
console.log(
`requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
);
/*
The keys within exceptions are also parsed, you can access them by specifying exception names like below:
if(error.name === 'SomeServiceException') {
const value = error.specialKeyInException;
}
*/
}
Getting Help
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
- Ask a question on StackOverflow and tag it with
aws-sdk-js
- Come join the AWS JavaScript community on gitter
- If it turns out that you may have found a bug, please open an issue
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-sqs-node' package is updated. To contribute to SDK you can checkout our code generator package.
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago