@aws-sdk/client-sqs 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/dist-cjs/protocols/Aws_query.js +17 -78
  2. package/dist-es/protocols/Aws_query.js +17 -78
  3. package/dist-types/SQS.d.ts +21 -0
  4. package/dist-types/SQSClient.d.ts +24 -4
  5. package/dist-types/commands/AddPermissionCommand.d.ts +16 -0
  6. package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +16 -0
  7. package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateQueueCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteMessageBatchCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteMessageCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteQueueCommand.d.ts +16 -0
  12. package/dist-types/commands/GetQueueAttributesCommand.d.ts +16 -0
  13. package/dist-types/commands/GetQueueUrlCommand.d.ts +16 -0
  14. package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListQueueTagsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListQueuesCommand.d.ts +16 -0
  17. package/dist-types/commands/PurgeQueueCommand.d.ts +16 -0
  18. package/dist-types/commands/ReceiveMessageCommand.d.ts +16 -0
  19. package/dist-types/commands/RemovePermissionCommand.d.ts +16 -0
  20. package/dist-types/commands/SendMessageBatchCommand.d.ts +16 -0
  21. package/dist-types/commands/SendMessageCommand.d.ts +16 -0
  22. package/dist-types/commands/SetQueueAttributesCommand.d.ts +16 -0
  23. package/dist-types/commands/TagQueueCommand.d.ts +16 -0
  24. package/dist-types/commands/UntagQueueCommand.d.ts +16 -0
  25. package/dist-types/models/SQSServiceException.d.ts +2 -0
  26. package/dist-types/models/models_0.d.ts +81 -5
  27. package/dist-types/pagination/Interfaces.d.ts +3 -0
  28. package/dist-types/pagination/ListDeadLetterSourceQueuesPaginator.d.ts +3 -0
  29. package/dist-types/pagination/ListQueuesPaginator.d.ts +3 -0
  30. package/package.json +31 -31
@@ -1715,12 +1715,7 @@ const deserializeAws_queryBatchRequestTooLong = (output, context) => {
1715
1715
  return contents;
1716
1716
  };
1717
1717
  const deserializeAws_queryBatchResultErrorEntry = (output, context) => {
1718
- const contents = {
1719
- Id: undefined,
1720
- SenderFault: undefined,
1721
- Code: undefined,
1722
- Message: undefined,
1723
- };
1718
+ const contents = {};
1724
1719
  if (output["Id"] !== undefined) {
1725
1720
  contents.Id = (0, smithy_client_1.expectString)(output["Id"]);
1726
1721
  }
@@ -1750,10 +1745,7 @@ const deserializeAws_queryBinaryList = (output, context) => {
1750
1745
  });
1751
1746
  };
1752
1747
  const deserializeAws_queryChangeMessageVisibilityBatchResult = (output, context) => {
1753
- const contents = {
1754
- Successful: undefined,
1755
- Failed: undefined,
1756
- };
1748
+ const contents = {};
1757
1749
  if (output.ChangeMessageVisibilityBatchResultEntry === "") {
1758
1750
  contents.Successful = [];
1759
1751
  }
@@ -1769,9 +1761,7 @@ const deserializeAws_queryChangeMessageVisibilityBatchResult = (output, context)
1769
1761
  return contents;
1770
1762
  };
1771
1763
  const deserializeAws_queryChangeMessageVisibilityBatchResultEntry = (output, context) => {
1772
- const contents = {
1773
- Id: undefined,
1774
- };
1764
+ const contents = {};
1775
1765
  if (output["Id"] !== undefined) {
1776
1766
  contents.Id = (0, smithy_client_1.expectString)(output["Id"]);
1777
1767
  }
@@ -1785,19 +1775,14 @@ const deserializeAws_queryChangeMessageVisibilityBatchResultEntryList = (output,
1785
1775
  });
1786
1776
  };
1787
1777
  const deserializeAws_queryCreateQueueResult = (output, context) => {
1788
- const contents = {
1789
- QueueUrl: undefined,
1790
- };
1778
+ const contents = {};
1791
1779
  if (output["QueueUrl"] !== undefined) {
1792
1780
  contents.QueueUrl = (0, smithy_client_1.expectString)(output["QueueUrl"]);
1793
1781
  }
1794
1782
  return contents;
1795
1783
  };
1796
1784
  const deserializeAws_queryDeleteMessageBatchResult = (output, context) => {
1797
- const contents = {
1798
- Successful: undefined,
1799
- Failed: undefined,
1800
- };
1785
+ const contents = {};
1801
1786
  if (output.DeleteMessageBatchResultEntry === "") {
1802
1787
  contents.Successful = [];
1803
1788
  }
@@ -1813,9 +1798,7 @@ const deserializeAws_queryDeleteMessageBatchResult = (output, context) => {
1813
1798
  return contents;
1814
1799
  };
1815
1800
  const deserializeAws_queryDeleteMessageBatchResultEntry = (output, context) => {
1816
- const contents = {
1817
- Id: undefined,
1818
- };
1801
+ const contents = {};
1819
1802
  if (output["Id"] !== undefined) {
1820
1803
  contents.Id = (0, smithy_client_1.expectString)(output["Id"]);
1821
1804
  }
@@ -1833,9 +1816,7 @@ const deserializeAws_queryEmptyBatchRequest = (output, context) => {
1833
1816
  return contents;
1834
1817
  };
1835
1818
  const deserializeAws_queryGetQueueAttributesResult = (output, context) => {
1836
- const contents = {
1837
- Attributes: undefined,
1838
- };
1819
+ const contents = {};
1839
1820
  if (output.Attribute === "") {
1840
1821
  contents.Attributes = {};
1841
1822
  }
@@ -1845,9 +1826,7 @@ const deserializeAws_queryGetQueueAttributesResult = (output, context) => {
1845
1826
  return contents;
1846
1827
  };
1847
1828
  const deserializeAws_queryGetQueueUrlResult = (output, context) => {
1848
- const contents = {
1849
- QueueUrl: undefined,
1850
- };
1829
+ const contents = {};
1851
1830
  if (output["QueueUrl"] !== undefined) {
1852
1831
  contents.QueueUrl = (0, smithy_client_1.expectString)(output["QueueUrl"]);
1853
1832
  }
@@ -1870,10 +1849,7 @@ const deserializeAws_queryInvalidMessageContents = (output, context) => {
1870
1849
  return contents;
1871
1850
  };
1872
1851
  const deserializeAws_queryListDeadLetterSourceQueuesResult = (output, context) => {
1873
- const contents = {
1874
- queueUrls: undefined,
1875
- NextToken: undefined,
1876
- };
1852
+ const contents = {};
1877
1853
  if (output.QueueUrl === "") {
1878
1854
  contents.queueUrls = [];
1879
1855
  }
@@ -1886,10 +1862,7 @@ const deserializeAws_queryListDeadLetterSourceQueuesResult = (output, context) =
1886
1862
  return contents;
1887
1863
  };
1888
1864
  const deserializeAws_queryListQueuesResult = (output, context) => {
1889
- const contents = {
1890
- NextToken: undefined,
1891
- QueueUrls: undefined,
1892
- };
1865
+ const contents = {};
1893
1866
  if (output["NextToken"] !== undefined) {
1894
1867
  contents.NextToken = (0, smithy_client_1.expectString)(output["NextToken"]);
1895
1868
  }
@@ -1902,9 +1875,7 @@ const deserializeAws_queryListQueuesResult = (output, context) => {
1902
1875
  return contents;
1903
1876
  };
1904
1877
  const deserializeAws_queryListQueueTagsResult = (output, context) => {
1905
- const contents = {
1906
- Tags: undefined,
1907
- };
1878
+ const contents = {};
1908
1879
  if (output.Tag === "") {
1909
1880
  contents.Tags = {};
1910
1881
  }
@@ -1914,15 +1885,7 @@ const deserializeAws_queryListQueueTagsResult = (output, context) => {
1914
1885
  return contents;
1915
1886
  };
1916
1887
  const deserializeAws_queryMessage = (output, context) => {
1917
- const contents = {
1918
- MessageId: undefined,
1919
- ReceiptHandle: undefined,
1920
- MD5OfBody: undefined,
1921
- Body: undefined,
1922
- Attributes: undefined,
1923
- MD5OfMessageAttributes: undefined,
1924
- MessageAttributes: undefined,
1925
- };
1888
+ const contents = {};
1926
1889
  if (output["MessageId"] !== undefined) {
1927
1890
  contents.MessageId = (0, smithy_client_1.expectString)(output["MessageId"]);
1928
1891
  }
@@ -1953,13 +1916,7 @@ const deserializeAws_queryMessage = (output, context) => {
1953
1916
  return contents;
1954
1917
  };
1955
1918
  const deserializeAws_queryMessageAttributeValue = (output, context) => {
1956
- const contents = {
1957
- StringValue: undefined,
1958
- BinaryValue: undefined,
1959
- StringListValues: undefined,
1960
- BinaryListValues: undefined,
1961
- DataType: undefined,
1962
- };
1919
+ const contents = {};
1963
1920
  if (output["StringValue"] !== undefined) {
1964
1921
  contents.StringValue = (0, smithy_client_1.expectString)(output["StringValue"]);
1965
1922
  }
@@ -2053,9 +2010,7 @@ const deserializeAws_queryReceiptHandleIsInvalid = (output, context) => {
2053
2010
  return contents;
2054
2011
  };
2055
2012
  const deserializeAws_queryReceiveMessageResult = (output, context) => {
2056
- const contents = {
2057
- Messages: undefined,
2058
- };
2013
+ const contents = {};
2059
2014
  if (output.Message === "") {
2060
2015
  contents.Messages = [];
2061
2016
  }
@@ -2065,10 +2020,7 @@ const deserializeAws_queryReceiveMessageResult = (output, context) => {
2065
2020
  return contents;
2066
2021
  };
2067
2022
  const deserializeAws_querySendMessageBatchResult = (output, context) => {
2068
- const contents = {
2069
- Successful: undefined,
2070
- Failed: undefined,
2071
- };
2023
+ const contents = {};
2072
2024
  if (output.SendMessageBatchResultEntry === "") {
2073
2025
  contents.Successful = [];
2074
2026
  }
@@ -2084,14 +2036,7 @@ const deserializeAws_querySendMessageBatchResult = (output, context) => {
2084
2036
  return contents;
2085
2037
  };
2086
2038
  const deserializeAws_querySendMessageBatchResultEntry = (output, context) => {
2087
- const contents = {
2088
- Id: undefined,
2089
- MessageId: undefined,
2090
- MD5OfMessageBody: undefined,
2091
- MD5OfMessageAttributes: undefined,
2092
- MD5OfMessageSystemAttributes: undefined,
2093
- SequenceNumber: undefined,
2094
- };
2039
+ const contents = {};
2095
2040
  if (output["Id"] !== undefined) {
2096
2041
  contents.Id = (0, smithy_client_1.expectString)(output["Id"]);
2097
2042
  }
@@ -2120,13 +2065,7 @@ const deserializeAws_querySendMessageBatchResultEntryList = (output, context) =>
2120
2065
  });
2121
2066
  };
2122
2067
  const deserializeAws_querySendMessageResult = (output, context) => {
2123
- const contents = {
2124
- MD5OfMessageBody: undefined,
2125
- MD5OfMessageAttributes: undefined,
2126
- MD5OfMessageSystemAttributes: undefined,
2127
- MessageId: undefined,
2128
- SequenceNumber: undefined,
2129
- };
2068
+ const contents = {};
2130
2069
  if (output["MD5OfMessageBody"] !== undefined) {
2131
2070
  contents.MD5OfMessageBody = (0, smithy_client_1.expectString)(output["MD5OfMessageBody"]);
2132
2071
  }
@@ -1672,12 +1672,7 @@ const deserializeAws_queryBatchRequestTooLong = (output, context) => {
1672
1672
  return contents;
1673
1673
  };
1674
1674
  const deserializeAws_queryBatchResultErrorEntry = (output, context) => {
1675
- const contents = {
1676
- Id: undefined,
1677
- SenderFault: undefined,
1678
- Code: undefined,
1679
- Message: undefined,
1680
- };
1675
+ const contents = {};
1681
1676
  if (output["Id"] !== undefined) {
1682
1677
  contents.Id = __expectString(output["Id"]);
1683
1678
  }
@@ -1707,10 +1702,7 @@ const deserializeAws_queryBinaryList = (output, context) => {
1707
1702
  });
1708
1703
  };
1709
1704
  const deserializeAws_queryChangeMessageVisibilityBatchResult = (output, context) => {
1710
- const contents = {
1711
- Successful: undefined,
1712
- Failed: undefined,
1713
- };
1705
+ const contents = {};
1714
1706
  if (output.ChangeMessageVisibilityBatchResultEntry === "") {
1715
1707
  contents.Successful = [];
1716
1708
  }
@@ -1726,9 +1718,7 @@ const deserializeAws_queryChangeMessageVisibilityBatchResult = (output, context)
1726
1718
  return contents;
1727
1719
  };
1728
1720
  const deserializeAws_queryChangeMessageVisibilityBatchResultEntry = (output, context) => {
1729
- const contents = {
1730
- Id: undefined,
1731
- };
1721
+ const contents = {};
1732
1722
  if (output["Id"] !== undefined) {
1733
1723
  contents.Id = __expectString(output["Id"]);
1734
1724
  }
@@ -1742,19 +1732,14 @@ const deserializeAws_queryChangeMessageVisibilityBatchResultEntryList = (output,
1742
1732
  });
1743
1733
  };
1744
1734
  const deserializeAws_queryCreateQueueResult = (output, context) => {
1745
- const contents = {
1746
- QueueUrl: undefined,
1747
- };
1735
+ const contents = {};
1748
1736
  if (output["QueueUrl"] !== undefined) {
1749
1737
  contents.QueueUrl = __expectString(output["QueueUrl"]);
1750
1738
  }
1751
1739
  return contents;
1752
1740
  };
1753
1741
  const deserializeAws_queryDeleteMessageBatchResult = (output, context) => {
1754
- const contents = {
1755
- Successful: undefined,
1756
- Failed: undefined,
1757
- };
1742
+ const contents = {};
1758
1743
  if (output.DeleteMessageBatchResultEntry === "") {
1759
1744
  contents.Successful = [];
1760
1745
  }
@@ -1770,9 +1755,7 @@ const deserializeAws_queryDeleteMessageBatchResult = (output, context) => {
1770
1755
  return contents;
1771
1756
  };
1772
1757
  const deserializeAws_queryDeleteMessageBatchResultEntry = (output, context) => {
1773
- const contents = {
1774
- Id: undefined,
1775
- };
1758
+ const contents = {};
1776
1759
  if (output["Id"] !== undefined) {
1777
1760
  contents.Id = __expectString(output["Id"]);
1778
1761
  }
@@ -1790,9 +1773,7 @@ const deserializeAws_queryEmptyBatchRequest = (output, context) => {
1790
1773
  return contents;
1791
1774
  };
1792
1775
  const deserializeAws_queryGetQueueAttributesResult = (output, context) => {
1793
- const contents = {
1794
- Attributes: undefined,
1795
- };
1776
+ const contents = {};
1796
1777
  if (output.Attribute === "") {
1797
1778
  contents.Attributes = {};
1798
1779
  }
@@ -1802,9 +1783,7 @@ const deserializeAws_queryGetQueueAttributesResult = (output, context) => {
1802
1783
  return contents;
1803
1784
  };
1804
1785
  const deserializeAws_queryGetQueueUrlResult = (output, context) => {
1805
- const contents = {
1806
- QueueUrl: undefined,
1807
- };
1786
+ const contents = {};
1808
1787
  if (output["QueueUrl"] !== undefined) {
1809
1788
  contents.QueueUrl = __expectString(output["QueueUrl"]);
1810
1789
  }
@@ -1827,10 +1806,7 @@ const deserializeAws_queryInvalidMessageContents = (output, context) => {
1827
1806
  return contents;
1828
1807
  };
1829
1808
  const deserializeAws_queryListDeadLetterSourceQueuesResult = (output, context) => {
1830
- const contents = {
1831
- queueUrls: undefined,
1832
- NextToken: undefined,
1833
- };
1809
+ const contents = {};
1834
1810
  if (output.QueueUrl === "") {
1835
1811
  contents.queueUrls = [];
1836
1812
  }
@@ -1843,10 +1819,7 @@ const deserializeAws_queryListDeadLetterSourceQueuesResult = (output, context) =
1843
1819
  return contents;
1844
1820
  };
1845
1821
  const deserializeAws_queryListQueuesResult = (output, context) => {
1846
- const contents = {
1847
- NextToken: undefined,
1848
- QueueUrls: undefined,
1849
- };
1822
+ const contents = {};
1850
1823
  if (output["NextToken"] !== undefined) {
1851
1824
  contents.NextToken = __expectString(output["NextToken"]);
1852
1825
  }
@@ -1859,9 +1832,7 @@ const deserializeAws_queryListQueuesResult = (output, context) => {
1859
1832
  return contents;
1860
1833
  };
1861
1834
  const deserializeAws_queryListQueueTagsResult = (output, context) => {
1862
- const contents = {
1863
- Tags: undefined,
1864
- };
1835
+ const contents = {};
1865
1836
  if (output.Tag === "") {
1866
1837
  contents.Tags = {};
1867
1838
  }
@@ -1871,15 +1842,7 @@ const deserializeAws_queryListQueueTagsResult = (output, context) => {
1871
1842
  return contents;
1872
1843
  };
1873
1844
  const deserializeAws_queryMessage = (output, context) => {
1874
- const contents = {
1875
- MessageId: undefined,
1876
- ReceiptHandle: undefined,
1877
- MD5OfBody: undefined,
1878
- Body: undefined,
1879
- Attributes: undefined,
1880
- MD5OfMessageAttributes: undefined,
1881
- MessageAttributes: undefined,
1882
- };
1845
+ const contents = {};
1883
1846
  if (output["MessageId"] !== undefined) {
1884
1847
  contents.MessageId = __expectString(output["MessageId"]);
1885
1848
  }
@@ -1910,13 +1873,7 @@ const deserializeAws_queryMessage = (output, context) => {
1910
1873
  return contents;
1911
1874
  };
1912
1875
  const deserializeAws_queryMessageAttributeValue = (output, context) => {
1913
- const contents = {
1914
- StringValue: undefined,
1915
- BinaryValue: undefined,
1916
- StringListValues: undefined,
1917
- BinaryListValues: undefined,
1918
- DataType: undefined,
1919
- };
1876
+ const contents = {};
1920
1877
  if (output["StringValue"] !== undefined) {
1921
1878
  contents.StringValue = __expectString(output["StringValue"]);
1922
1879
  }
@@ -2010,9 +1967,7 @@ const deserializeAws_queryReceiptHandleIsInvalid = (output, context) => {
2010
1967
  return contents;
2011
1968
  };
2012
1969
  const deserializeAws_queryReceiveMessageResult = (output, context) => {
2013
- const contents = {
2014
- Messages: undefined,
2015
- };
1970
+ const contents = {};
2016
1971
  if (output.Message === "") {
2017
1972
  contents.Messages = [];
2018
1973
  }
@@ -2022,10 +1977,7 @@ const deserializeAws_queryReceiveMessageResult = (output, context) => {
2022
1977
  return contents;
2023
1978
  };
2024
1979
  const deserializeAws_querySendMessageBatchResult = (output, context) => {
2025
- const contents = {
2026
- Successful: undefined,
2027
- Failed: undefined,
2028
- };
1980
+ const contents = {};
2029
1981
  if (output.SendMessageBatchResultEntry === "") {
2030
1982
  contents.Successful = [];
2031
1983
  }
@@ -2041,14 +1993,7 @@ const deserializeAws_querySendMessageBatchResult = (output, context) => {
2041
1993
  return contents;
2042
1994
  };
2043
1995
  const deserializeAws_querySendMessageBatchResultEntry = (output, context) => {
2044
- const contents = {
2045
- Id: undefined,
2046
- MessageId: undefined,
2047
- MD5OfMessageBody: undefined,
2048
- MD5OfMessageAttributes: undefined,
2049
- MD5OfMessageSystemAttributes: undefined,
2050
- SequenceNumber: undefined,
2051
- };
1996
+ const contents = {};
2052
1997
  if (output["Id"] !== undefined) {
2053
1998
  contents.Id = __expectString(output["Id"]);
2054
1999
  }
@@ -2077,13 +2022,7 @@ const deserializeAws_querySendMessageBatchResultEntryList = (output, context) =>
2077
2022
  });
2078
2023
  };
2079
2024
  const deserializeAws_querySendMessageResult = (output, context) => {
2080
- const contents = {
2081
- MD5OfMessageBody: undefined,
2082
- MD5OfMessageAttributes: undefined,
2083
- MD5OfMessageSystemAttributes: undefined,
2084
- MessageId: undefined,
2085
- SequenceNumber: undefined,
2086
- };
2025
+ const contents = {};
2087
2026
  if (output["MD5OfMessageBody"] !== undefined) {
2088
2027
  contents.MD5OfMessageBody = __expectString(output["MD5OfMessageBody"]);
2089
2028
  }
@@ -21,6 +21,7 @@ import { TagQueueCommandInput, TagQueueCommandOutput } from "./commands/TagQueue
21
21
  import { UntagQueueCommandInput, UntagQueueCommandOutput } from "./commands/UntagQueueCommand";
22
22
  import { SQSClient } from "./SQSClient";
23
23
  /**
24
+ * @public
24
25
  * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
25
26
  * <p>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.</p>
26
27
  * <p>For information on the permissions you need to use this API, see
@@ -93,6 +94,7 @@ import { SQSClient } from "./SQSClient";
93
94
  */
94
95
  export declare class SQS extends SQSClient {
95
96
  /**
97
+ * @public
96
98
  * <p>Adds a permission to a queue for a specific
97
99
  * <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>.
98
100
  * This allows sharing access to the queue.</p>
@@ -138,6 +140,7 @@ export declare class SQS extends SQSClient {
138
140
  addPermission(args: AddPermissionCommandInput, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
139
141
  addPermission(args: AddPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddPermissionCommandOutput) => void): void;
140
142
  /**
143
+ * @public
141
144
  * <p>Changes the visibility timeout of a specified message in a queue to a new value. The
142
145
  * default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The
143
146
  * maximum is 12 hours. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</p>
@@ -177,6 +180,7 @@ export declare class SQS extends SQSClient {
177
180
  changeMessageVisibility(args: ChangeMessageVisibilityCommandInput, cb: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void): void;
178
181
  changeMessageVisibility(args: ChangeMessageVisibilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeMessageVisibilityCommandOutput) => void): void;
179
182
  /**
183
+ * @public
180
184
  * <p>Changes the visibility timeout of multiple messages. This is a batch version of <code>
181
185
  * <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response.
182
186
  * You can send up to 10 <code>
@@ -197,6 +201,7 @@ export declare class SQS extends SQSClient {
197
201
  changeMessageVisibilityBatch(args: ChangeMessageVisibilityBatchCommandInput, cb: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void): void;
198
202
  changeMessageVisibilityBatch(args: ChangeMessageVisibilityBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeMessageVisibilityBatchCommandOutput) => void): void;
199
203
  /**
204
+ * @public
200
205
  * <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
201
206
  * the request. Keep the following in mind:</p>
202
207
  * <ul>
@@ -254,6 +259,7 @@ export declare class SQS extends SQSClient {
254
259
  createQueue(args: CreateQueueCommandInput, cb: (err: any, data?: CreateQueueCommandOutput) => void): void;
255
260
  createQueue(args: CreateQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQueueCommandOutput) => void): void;
256
261
  /**
262
+ * @public
257
263
  * <p>Deletes the specified message from the specified queue. To select the message to
258
264
  * delete, use the <code>ReceiptHandle</code> of the message (<i>not</i> the
259
265
  * <code>MessageId</code> which you receive when you send the message). Amazon SQS can
@@ -279,6 +285,7 @@ export declare class SQS extends SQSClient {
279
285
  deleteMessage(args: DeleteMessageCommandInput, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void;
280
286
  deleteMessage(args: DeleteMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageCommandOutput) => void): void;
281
287
  /**
288
+ * @public
282
289
  * <p>Deletes up to ten messages from the specified queue. This is a batch version of <code>
283
290
  * <a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response.</p>
284
291
  * <important>
@@ -296,6 +303,7 @@ export declare class SQS extends SQSClient {
296
303
  deleteMessageBatch(args: DeleteMessageBatchCommandInput, cb: (err: any, data?: DeleteMessageBatchCommandOutput) => void): void;
297
304
  deleteMessageBatch(args: DeleteMessageBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessageBatchCommandOutput) => void): void;
298
305
  /**
306
+ * @public
299
307
  * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents.</p>
300
308
  * <important>
301
309
  * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available.
@@ -316,6 +324,7 @@ export declare class SQS extends SQSClient {
316
324
  deleteQueue(args: DeleteQueueCommandInput, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void;
317
325
  deleteQueue(args: DeleteQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueueCommandOutput) => void): void;
318
326
  /**
327
+ * @public
319
328
  * <p>Gets attributes for the specified queue.</p>
320
329
  * <note>
321
330
  * <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
@@ -325,6 +334,7 @@ export declare class SQS extends SQSClient {
325
334
  getQueueAttributes(args: GetQueueAttributesCommandInput, cb: (err: any, data?: GetQueueAttributesCommandOutput) => void): void;
326
335
  getQueueAttributes(args: GetQueueAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueAttributesCommandOutput) => void): void;
327
336
  /**
337
+ * @public
328
338
  * <p>Returns the URL of an existing Amazon SQS queue.</p>
329
339
  * <p>To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue.
330
340
  * For more information about shared queue access, see <code>
@@ -336,6 +346,7 @@ export declare class SQS extends SQSClient {
336
346
  getQueueUrl(args: GetQueueUrlCommandInput, cb: (err: any, data?: GetQueueUrlCommandOutput) => void): void;
337
347
  getQueueUrl(args: GetQueueUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueueUrlCommandOutput) => void): void;
338
348
  /**
349
+ * @public
339
350
  * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
340
351
  * <p> The <code>ListDeadLetterSourceQueues</code> methods supports
341
352
  * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
@@ -352,6 +363,7 @@ export declare class SQS extends SQSClient {
352
363
  listDeadLetterSourceQueues(args: ListDeadLetterSourceQueuesCommandInput, cb: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void): void;
353
364
  listDeadLetterSourceQueues(args: ListDeadLetterSourceQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDeadLetterSourceQueuesCommandOutput) => void): void;
354
365
  /**
366
+ * @public
355
367
  * <p>Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional
356
368
  * <code>QueueNamePrefix</code> parameter, only queues with a name that begins with the specified value are returned.</p>
357
369
  * <p> The <code>listQueues</code> methods supports
@@ -371,6 +383,7 @@ export declare class SQS extends SQSClient {
371
383
  listQueues(args: ListQueuesCommandInput, cb: (err: any, data?: ListQueuesCommandOutput) => void): void;
372
384
  listQueues(args: ListQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueuesCommandOutput) => void): void;
373
385
  /**
386
+ * @public
374
387
  * <p>List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
375
388
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
376
389
  * <note>
@@ -383,6 +396,7 @@ export declare class SQS extends SQSClient {
383
396
  listQueueTags(args: ListQueueTagsCommandInput, cb: (err: any, data?: ListQueueTagsCommandOutput) => void): void;
384
397
  listQueueTags(args: ListQueueTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQueueTagsCommandOutput) => void): void;
385
398
  /**
399
+ * @public
386
400
  * <p>Deletes the messages in a queue specified by the <code>QueueURL</code>
387
401
  * parameter.</p>
388
402
  *
@@ -402,6 +416,7 @@ export declare class SQS extends SQSClient {
402
416
  purgeQueue(args: PurgeQueueCommandInput, cb: (err: any, data?: PurgeQueueCommandOutput) => void): void;
403
417
  purgeQueue(args: PurgeQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PurgeQueueCommandOutput) => void): void;
404
418
  /**
419
+ * @public
405
420
  * <p>Retrieves one or more messages (up to 10), from the specified queue. Using the <code>WaitTimeSeconds</code> parameter enables long-poll support.
406
421
  * For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Polling</a> in the <i>Amazon SQS Developer Guide</i>.
407
422
  * </p>
@@ -443,6 +458,7 @@ export declare class SQS extends SQSClient {
443
458
  receiveMessage(args: ReceiveMessageCommandInput, cb: (err: any, data?: ReceiveMessageCommandOutput) => void): void;
444
459
  receiveMessage(args: ReceiveMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReceiveMessageCommandOutput) => void): void;
445
460
  /**
461
+ * @public
446
462
  * <p>Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter.</p>
447
463
  * <note>
448
464
  * <ul>
@@ -464,6 +480,7 @@ export declare class SQS extends SQSClient {
464
480
  removePermission(args: RemovePermissionCommandInput, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
465
481
  removePermission(args: RemovePermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemovePermissionCommandOutput) => void): void;
466
482
  /**
483
+ * @public
467
484
  * <p>Delivers a message to the specified queue.</p>
468
485
  * <important>
469
486
  * <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
@@ -477,6 +494,7 @@ export declare class SQS extends SQSClient {
477
494
  sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void;
478
495
  sendMessage(args: SendMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageCommandOutput) => void): void;
479
496
  /**
497
+ * @public
480
498
  * <p>Delivers up to ten messages to the specified queue. This is a batch version of <code>
481
499
  * <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.</p>
482
500
  * <p>The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
@@ -501,6 +519,7 @@ export declare class SQS extends SQSClient {
501
519
  sendMessageBatch(args: SendMessageBatchCommandInput, cb: (err: any, data?: SendMessageBatchCommandOutput) => void): void;
502
520
  sendMessageBatch(args: SendMessageBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageBatchCommandOutput) => void): void;
503
521
  /**
522
+ * @public
504
523
  * <p>Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system.
505
524
  * Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes.</p>
506
525
  * <note>
@@ -523,6 +542,7 @@ export declare class SQS extends SQSClient {
523
542
  setQueueAttributes(args: SetQueueAttributesCommandInput, cb: (err: any, data?: SetQueueAttributesCommandOutput) => void): void;
524
543
  setQueueAttributes(args: SetQueueAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetQueueAttributesCommandOutput) => void): void;
525
544
  /**
545
+ * @public
526
546
  * <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
527
547
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
528
548
  *
@@ -554,6 +574,7 @@ export declare class SQS extends SQSClient {
554
574
  tagQueue(args: TagQueueCommandInput, cb: (err: any, data?: TagQueueCommandOutput) => void): void;
555
575
  tagQueue(args: TagQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagQueueCommandOutput) => void): void;
556
576
  /**
577
+ * @public
557
578
  * <p>Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
558
579
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
559
580
  * <note>
@@ -28,15 +28,24 @@ import { SetQueueAttributesCommandInput, SetQueueAttributesCommandOutput } from
28
28
  import { TagQueueCommandInput, TagQueueCommandOutput } from "./commands/TagQueueCommand";
29
29
  import { UntagQueueCommandInput, UntagQueueCommandOutput } from "./commands/UntagQueueCommand";
30
30
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
31
+ /**
32
+ * @public
33
+ */
31
34
  export type ServiceInputTypes = AddPermissionCommandInput | ChangeMessageVisibilityBatchCommandInput | ChangeMessageVisibilityCommandInput | CreateQueueCommandInput | DeleteMessageBatchCommandInput | DeleteMessageCommandInput | DeleteQueueCommandInput | GetQueueAttributesCommandInput | GetQueueUrlCommandInput | ListDeadLetterSourceQueuesCommandInput | ListQueueTagsCommandInput | ListQueuesCommandInput | PurgeQueueCommandInput | ReceiveMessageCommandInput | RemovePermissionCommandInput | SendMessageBatchCommandInput | SendMessageCommandInput | SetQueueAttributesCommandInput | TagQueueCommandInput | UntagQueueCommandInput;
35
+ /**
36
+ * @public
37
+ */
32
38
  export type ServiceOutputTypes = AddPermissionCommandOutput | ChangeMessageVisibilityBatchCommandOutput | ChangeMessageVisibilityCommandOutput | CreateQueueCommandOutput | DeleteMessageBatchCommandOutput | DeleteMessageCommandOutput | DeleteQueueCommandOutput | GetQueueAttributesCommandOutput | GetQueueUrlCommandOutput | ListDeadLetterSourceQueuesCommandOutput | ListQueueTagsCommandOutput | ListQueuesCommandOutput | PurgeQueueCommandOutput | ReceiveMessageCommandOutput | RemovePermissionCommandOutput | SendMessageBatchCommandOutput | SendMessageCommandOutput | SetQueueAttributesCommandOutput | TagQueueCommandOutput | UntagQueueCommandOutput;
39
+ /**
40
+ * @public
41
+ */
33
42
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
34
43
  /**
35
44
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
36
45
  */
37
46
  requestHandler?: __HttpHandler;
38
47
  /**
39
- * A constructor for a class implementing the {@link __Checksum} interface
48
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
40
49
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
41
50
  * @internal
42
51
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type SQSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of SQSClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of SQSClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface SQSClientConfig extends SQSClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type SQSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of SQSClient class. This is resolved and normalized from the {@link SQSClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of SQSClient class. This is resolved and normalized from the {@link SQSClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
153
173
  * <p>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.</p>
154
174
  * <p>For information on the permissions you need to use this API, see