Skip to content

Commit 9f4b6df

Browse files
authored
docs(supplemental-docs): add documentation for using queue names with SQS Client (#6337)
Co-authored-by: RanVaknin <[email protected]>
1 parent d8f767a commit 9f4b6df

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

supplemental-docs/CLIENTS.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,4 +618,30 @@ new S3Client({
618618
619619
### SQS
620620
621-
TODO e.g. `useQueueUrlAsEndpoint`
621+
#### Using Queue Names with SQS Client
622+
623+
When using the SQS client, set the `useQueueUrlAsEndpoint` configuration to `false` to allow for providing the `QueueUrl` parameter as a queue name rather than a full queue URL.
624+
625+
```js
626+
import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs";
627+
628+
const sqs = new SQSClient({
629+
region: "us-east-1",
630+
useQueueUrlAsEndpoint: false,
631+
});
632+
633+
const QueueName = "foo"; // directly use the queue name
634+
// const QueueUrl = "https://sqs.us-east-1.amazonaws.com/123456789012/foo"; // full URL for reference
635+
636+
try {
637+
await sqs.send(
638+
new SendMessageCommand({
639+
QueueUrl: QueueName,
640+
MessageBody: "Sample message",
641+
})
642+
);
643+
console.log("message sent successfully");
644+
} catch (error) {
645+
console.log("SendMessage Failure", error);
646+
}
647+
```

0 commit comments

Comments
 (0)