@aws-sdk/client-dynamodb 3.296.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 (65) hide show
  1. package/dist-types/DynamoDB.d.ts +54 -0
  2. package/dist-types/DynamoDBClient.d.ts +24 -4
  3. package/dist-types/commands/BatchExecuteStatementCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchGetItemCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchWriteItemCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateBackupCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateGlobalTableCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateTableCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteBackupCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteItemCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteTableCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeBackupCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeContinuousBackupsCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeContributorInsightsCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeEndpointsCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeExportCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeGlobalTableCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeGlobalTableSettingsCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeImportCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeKinesisStreamingDestinationCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeLimitsCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeTableCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeTableReplicaAutoScalingCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeTimeToLiveCommand.d.ts +16 -0
  25. package/dist-types/commands/DisableKinesisStreamingDestinationCommand.d.ts +16 -0
  26. package/dist-types/commands/EnableKinesisStreamingDestinationCommand.d.ts +16 -0
  27. package/dist-types/commands/ExecuteStatementCommand.d.ts +16 -0
  28. package/dist-types/commands/ExecuteTransactionCommand.d.ts +16 -0
  29. package/dist-types/commands/ExportTableToPointInTimeCommand.d.ts +16 -0
  30. package/dist-types/commands/GetItemCommand.d.ts +16 -0
  31. package/dist-types/commands/ImportTableCommand.d.ts +16 -0
  32. package/dist-types/commands/ListBackupsCommand.d.ts +16 -0
  33. package/dist-types/commands/ListContributorInsightsCommand.d.ts +16 -0
  34. package/dist-types/commands/ListExportsCommand.d.ts +16 -0
  35. package/dist-types/commands/ListGlobalTablesCommand.d.ts +16 -0
  36. package/dist-types/commands/ListImportsCommand.d.ts +16 -0
  37. package/dist-types/commands/ListTablesCommand.d.ts +16 -0
  38. package/dist-types/commands/ListTagsOfResourceCommand.d.ts +16 -0
  39. package/dist-types/commands/PutItemCommand.d.ts +16 -0
  40. package/dist-types/commands/QueryCommand.d.ts +16 -0
  41. package/dist-types/commands/RestoreTableFromBackupCommand.d.ts +16 -0
  42. package/dist-types/commands/RestoreTableToPointInTimeCommand.d.ts +16 -0
  43. package/dist-types/commands/ScanCommand.d.ts +16 -0
  44. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  45. package/dist-types/commands/TransactGetItemsCommand.d.ts +16 -0
  46. package/dist-types/commands/TransactWriteItemsCommand.d.ts +16 -0
  47. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/UpdateContinuousBackupsCommand.d.ts +16 -0
  49. package/dist-types/commands/UpdateContributorInsightsCommand.d.ts +16 -0
  50. package/dist-types/commands/UpdateGlobalTableCommand.d.ts +16 -0
  51. package/dist-types/commands/UpdateGlobalTableSettingsCommand.d.ts +16 -0
  52. package/dist-types/commands/UpdateItemCommand.d.ts +16 -0
  53. package/dist-types/commands/UpdateTableCommand.d.ts +16 -0
  54. package/dist-types/commands/UpdateTableReplicaAutoScalingCommand.d.ts +16 -0
  55. package/dist-types/commands/UpdateTimeToLiveCommand.d.ts +16 -0
  56. package/dist-types/models/DynamoDBServiceException.d.ts +2 -0
  57. package/dist-types/models/models_0.d.ts +556 -62
  58. package/dist-types/pagination/Interfaces.d.ts +3 -0
  59. package/dist-types/pagination/ListContributorInsightsPaginator.d.ts +3 -0
  60. package/dist-types/pagination/ListExportsPaginator.d.ts +3 -0
  61. package/dist-types/pagination/ListImportsPaginator.d.ts +3 -0
  62. package/dist-types/pagination/ListTablesPaginator.d.ts +3 -0
  63. package/dist-types/pagination/QueryPaginator.d.ts +3 -0
  64. package/dist-types/pagination/ScanPaginator.d.ts +3 -0
  65. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ImportTableInput, ImportTableOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ImportTableCommand}.
8
10
  */
9
11
  export interface ImportTableCommandInput extends ImportTableInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ImportTableCommand}.
13
17
  */
14
18
  export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Imports table data from an S3 bucket. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ImportTableCommandInput - {@link ImportTableCommandInput}
34
+ * @returns {@link ImportTableCommandOutput}
28
35
  * @see {@link ImportTableCommandInput} for command's `input` shape.
29
36
  * @see {@link ImportTableCommandOutput} for command's `response` shape.
30
37
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ImportTableCommandOutput extends ImportTableOutput, __MetadataB
59
66
  export declare class ImportTableCommand extends $Command<ImportTableCommandInput, ImportTableCommandOutput, DynamoDBClientResolvedConfig> {
60
67
  readonly input: ImportTableCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: ImportTableCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ImportTableCommandInput, ImportTableCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListBackupsInput, ListBackupsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListBackupsCommand}.
8
10
  */
9
11
  export interface ListBackupsCommandInput extends ListBackupsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListBackupsCommand}.
13
17
  */
14
18
  export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List backups associated with an Amazon Web Services account. To list backups for a
18
23
  * given table, specify <code>TableName</code>. <code>ListBackups</code> returns a
19
24
  * paginated list of results with at most 1 MB worth of items in a page. You can also
@@ -31,6 +36,8 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ListBackupsCommandInput - {@link ListBackupsCommandInput}
40
+ * @returns {@link ListBackupsCommandOutput}
34
41
  * @see {@link ListBackupsCommandInput} for command's `input` shape.
35
42
  * @see {@link ListBackupsCommandOutput} for command's `response` shape.
36
43
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -45,11 +52,20 @@ export interface ListBackupsCommandOutput extends ListBackupsOutput, __MetadataB
45
52
  export declare class ListBackupsCommand extends $Command<ListBackupsCommandInput, ListBackupsCommandOutput, DynamoDBClientResolvedConfig> {
46
53
  readonly input: ListBackupsCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: ListBackupsCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBackupsCommandInput, ListBackupsCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListContributorInsightsInput, ListContributorInsightsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListContributorInsightsCommand}.
8
10
  */
9
11
  export interface ListContributorInsightsCommandInput extends ListContributorInsightsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListContributorInsightsCommand}.
13
17
  */
14
18
  export interface ListContributorInsightsCommandOutput extends ListContributorInsightsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of ContributorInsightsSummary for a table and all its global secondary
18
23
  * indexes.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListContributorInsightsCommandInput - {@link ListContributorInsightsCommandInput}
35
+ * @returns {@link ListContributorInsightsCommandOutput}
29
36
  * @see {@link ListContributorInsightsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListContributorInsightsCommandOutput} for command's `response` shape.
31
38
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -42,11 +49,20 @@ export interface ListContributorInsightsCommandOutput extends ListContributorIns
42
49
  export declare class ListContributorInsightsCommand extends $Command<ListContributorInsightsCommandInput, ListContributorInsightsCommandOutput, DynamoDBClientResolvedConfig> {
43
50
  readonly input: ListContributorInsightsCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: ListContributorInsightsCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListContributorInsightsCommandInput, ListContributorInsightsCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListExportsInput, ListExportsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListExportsCommand}.
8
10
  */
9
11
  export interface ListExportsCommandInput extends ListExportsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListExportsCommand}.
13
17
  */
14
18
  export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists completed exports within the past 90 days.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListExportsCommandInput - {@link ListExportsCommandInput}
34
+ * @returns {@link ListExportsCommandOutput}
28
35
  * @see {@link ListExportsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListExportsCommandOutput} for command's `response` shape.
30
37
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
50
57
  export declare class ListExportsCommand extends $Command<ListExportsCommandInput, ListExportsCommandOutput, DynamoDBClientResolvedConfig> {
51
58
  readonly input: ListExportsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListExportsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListExportsCommandInput, ListExportsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListGlobalTablesInput, ListGlobalTablesOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListGlobalTablesCommand}.
8
10
  */
9
11
  export interface ListGlobalTablesCommandInput extends ListGlobalTablesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListGlobalTablesCommand}.
13
17
  */
14
18
  export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all global tables that have a replica in the specified Region.</p>
18
23
  * <important>
19
24
  * <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html">Version
@@ -37,6 +42,8 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
37
42
  * const response = await client.send(command);
38
43
  * ```
39
44
  *
45
+ * @param ListGlobalTablesCommandInput - {@link ListGlobalTablesCommandInput}
46
+ * @returns {@link ListGlobalTablesCommandOutput}
40
47
  * @see {@link ListGlobalTablesCommandInput} for command's `input` shape.
41
48
  * @see {@link ListGlobalTablesCommandOutput} for command's `response` shape.
42
49
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListGlobalTablesCommandOutput extends ListGlobalTablesOutput, _
51
58
  export declare class ListGlobalTablesCommand extends $Command<ListGlobalTablesCommandInput, ListGlobalTablesCommandOutput, DynamoDBClientResolvedConfig> {
52
59
  readonly input: ListGlobalTablesCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListGlobalTablesCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListGlobalTablesCommandInput, ListGlobalTablesCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListImportsInput, ListImportsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListImportsCommand}.
8
10
  */
9
11
  export interface ListImportsCommandInput extends ListImportsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListImportsCommand}.
13
17
  */
14
18
  export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Lists completed imports within the past 90 days. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListImportsCommandInput - {@link ListImportsCommandInput}
34
+ * @returns {@link ListImportsCommandOutput}
28
35
  * @see {@link ListImportsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListImportsCommandOutput} for command's `response` shape.
30
37
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
47
54
  export declare class ListImportsCommand extends $Command<ListImportsCommandInput, ListImportsCommandOutput, DynamoDBClientResolvedConfig> {
48
55
  readonly input: ListImportsCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListImportsCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListImportsCommandInput, ListImportsCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListTablesInput, ListTablesOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTablesCommand}.
8
10
  */
9
11
  export interface ListTablesCommandInput extends ListTablesInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTablesCommand}.
13
17
  */
14
18
  export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns an array of table names associated with the current account and endpoint. The
18
23
  * output from <code>ListTables</code> is paginated, with each page returning a maximum of
19
24
  * 100 table names.</p>
@@ -27,6 +32,8 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListTablesCommandInput - {@link ListTablesCommandInput}
36
+ * @returns {@link ListTablesCommandOutput}
30
37
  * @see {@link ListTablesCommandInput} for command's `input` shape.
31
38
  * @see {@link ListTablesCommandOutput} for command's `response` shape.
32
39
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -60,11 +67,20 @@ export interface ListTablesCommandOutput extends ListTablesOutput, __MetadataBea
60
67
  export declare class ListTablesCommand extends $Command<ListTablesCommandInput, ListTablesCommandOutput, DynamoDBClientResolvedConfig> {
61
68
  readonly input: ListTablesCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: ListTablesCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTablesCommandInput, ListTablesCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ListTagsOfResourceInput, ListTagsOfResourceOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsOfResourceCommand}.
8
10
  */
9
11
  export interface ListTagsOfResourceCommandInput extends ListTagsOfResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsOfResourceCommand}.
13
17
  */
14
18
  export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10
18
23
  * times per second, per account.</p>
19
24
  * <p>For an overview on tagging DynamoDB resources, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging for DynamoDB</a>
@@ -28,6 +33,8 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListTagsOfResourceCommandInput - {@link ListTagsOfResourceCommandInput}
37
+ * @returns {@link ListTagsOfResourceCommandOutput}
31
38
  * @see {@link ListTagsOfResourceCommandInput} for command's `input` shape.
32
39
  * @see {@link ListTagsOfResourceCommandOutput} for command's `response` shape.
33
40
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsOfResourceCommandOutput extends ListTagsOfResourceOutpu
46
53
  export declare class ListTagsOfResourceCommand extends $Command<ListTagsOfResourceCommandInput, ListTagsOfResourceCommandOutput, DynamoDBClientResolvedConfig> {
47
54
  readonly input: ListTagsOfResourceCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListTagsOfResourceCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsOfResourceCommandInput, ListTagsOfResourceCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { PutItemInput, PutItemOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PutItemCommand}.
8
10
  */
9
11
  export interface PutItemCommandInput extends PutItemInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PutItemCommand}.
13
17
  */
14
18
  export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new item, or replaces an old item with a new item. If an item that has the
18
23
  * same primary key as the new item already exists in the specified table, the new item
19
24
  * completely replaces the existing item. You can perform a conditional put operation (add
@@ -46,6 +51,8 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
46
51
  * const response = await client.send(command);
47
52
  * ```
48
53
  *
54
+ * @param PutItemCommandInput - {@link PutItemCommandInput}
55
+ * @returns {@link PutItemCommandOutput}
49
56
  * @see {@link PutItemCommandInput} for command's `input` shape.
50
57
  * @see {@link PutItemCommandOutput} for command's `response` shape.
51
58
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -117,11 +124,20 @@ export interface PutItemCommandOutput extends PutItemOutput, __MetadataBearer {
117
124
  export declare class PutItemCommand extends $Command<PutItemCommandInput, PutItemCommandOutput, DynamoDBClientResolvedConfig> {
118
125
  readonly input: PutItemCommandInput;
119
126
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
127
+ /**
128
+ * @public
129
+ */
120
130
  constructor(input: PutItemCommandInput);
121
131
  /**
122
132
  * @internal
123
133
  */
124
134
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutItemCommandInput, PutItemCommandOutput>;
135
+ /**
136
+ * @internal
137
+ */
125
138
  private serialize;
139
+ /**
140
+ * @internal
141
+ */
126
142
  private deserialize;
127
143
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { QueryInput, QueryOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link QueryCommand}.
8
10
  */
9
11
  export interface QueryCommandInput extends QueryInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link QueryCommand}.
13
17
  */
14
18
  export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>You must provide the name of the partition key attribute and a single value for that
18
23
  * attribute. <code>Query</code> returns all items with that partition key value.
19
24
  * Optionally, you can provide a sort key attribute and use a comparison operator to refine
@@ -75,6 +80,8 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
75
80
  * const response = await client.send(command);
76
81
  * ```
77
82
  *
83
+ * @param QueryCommandInput - {@link QueryCommandInput}
84
+ * @returns {@link QueryCommandOutput}
78
85
  * @see {@link QueryCommandInput} for command's `input` shape.
79
86
  * @see {@link QueryCommandOutput} for command's `response` shape.
80
87
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -136,11 +143,20 @@ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer {
136
143
  export declare class QueryCommand extends $Command<QueryCommandInput, QueryCommandOutput, DynamoDBClientResolvedConfig> {
137
144
  readonly input: QueryCommandInput;
138
145
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
146
+ /**
147
+ * @public
148
+ */
139
149
  constructor(input: QueryCommandInput);
140
150
  /**
141
151
  * @internal
142
152
  */
143
153
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<QueryCommandInput, QueryCommandOutput>;
154
+ /**
155
+ * @internal
156
+ */
144
157
  private serialize;
158
+ /**
159
+ * @internal
160
+ */
145
161
  private deserialize;
146
162
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { RestoreTableFromBackupInput, RestoreTableFromBackupOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RestoreTableFromBackupCommand}.
8
10
  */
9
11
  export interface RestoreTableFromBackupCommandInput extends RestoreTableFromBackupInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RestoreTableFromBackupCommand}.
13
17
  */
14
18
  export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBackupOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new table from an existing backup. Any number of users can execute up to 4
18
23
  * concurrent restores (any type of restore) in a given account. </p>
19
24
  * <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per
@@ -49,6 +54,8 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
49
54
  * const response = await client.send(command);
50
55
  * ```
51
56
  *
57
+ * @param RestoreTableFromBackupCommandInput - {@link RestoreTableFromBackupCommandInput}
58
+ * @returns {@link RestoreTableFromBackupCommandOutput}
52
59
  * @see {@link RestoreTableFromBackupCommandInput} for command's `input` shape.
53
60
  * @see {@link RestoreTableFromBackupCommandOutput} for command's `response` shape.
54
61
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -90,11 +97,20 @@ export interface RestoreTableFromBackupCommandOutput extends RestoreTableFromBac
90
97
  export declare class RestoreTableFromBackupCommand extends $Command<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput, DynamoDBClientResolvedConfig> {
91
98
  readonly input: RestoreTableFromBackupCommandInput;
92
99
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
100
+ /**
101
+ * @public
102
+ */
93
103
  constructor(input: RestoreTableFromBackupCommandInput);
94
104
  /**
95
105
  * @internal
96
106
  */
97
107
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreTableFromBackupCommandInput, RestoreTableFromBackupCommandOutput>;
108
+ /**
109
+ * @internal
110
+ */
98
111
  private serialize;
112
+ /**
113
+ * @internal
114
+ */
99
115
  private deserialize;
100
116
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { RestoreTableToPointInTimeInput, RestoreTableToPointInTimeOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link RestoreTableToPointInTimeCommand}.
8
10
  */
9
11
  export interface RestoreTableToPointInTimeCommandInput extends RestoreTableToPointInTimeInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link RestoreTableToPointInTimeCommand}.
13
17
  */
14
18
  export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPointInTimeOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Restores the specified table to the specified point in time within
18
23
  * <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>.
19
24
  * You can restore your table to any point in time during the last 35 days. Any number of
@@ -74,6 +79,8 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
74
79
  * const response = await client.send(command);
75
80
  * ```
76
81
  *
82
+ * @param RestoreTableToPointInTimeCommandInput - {@link RestoreTableToPointInTimeCommandInput}
83
+ * @returns {@link RestoreTableToPointInTimeCommandOutput}
77
84
  * @see {@link RestoreTableToPointInTimeCommandInput} for command's `input` shape.
78
85
  * @see {@link RestoreTableToPointInTimeCommandOutput} for command's `response` shape.
79
86
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -119,11 +126,20 @@ export interface RestoreTableToPointInTimeCommandOutput extends RestoreTableToPo
119
126
  export declare class RestoreTableToPointInTimeCommand extends $Command<RestoreTableToPointInTimeCommandInput, RestoreTableToPointInTimeCommandOutput, DynamoDBClientResolvedConfig> {
120
127
  readonly input: RestoreTableToPointInTimeCommandInput;
121
128
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
129
+ /**
130
+ * @public
131
+ */
122
132
  constructor(input: RestoreTableToPointInTimeCommandInput);
123
133
  /**
124
134
  * @internal
125
135
  */
126
136
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RestoreTableToPointInTimeCommandInput, RestoreTableToPointInTimeCommandOutput>;
137
+ /**
138
+ * @internal
139
+ */
127
140
  private serialize;
141
+ /**
142
+ * @internal
143
+ */
128
144
  private deserialize;
129
145
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient";
5
5
  import { ScanInput, ScanOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ScanCommand}.
8
10
  */
9
11
  export interface ScanCommandInput extends ScanInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ScanCommand}.
13
17
  */
14
18
  export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>The <code>Scan</code> operation returns one or more items and item attributes by
18
23
  * accessing every item in a table or a secondary index. To have DynamoDB return fewer
19
24
  * items, you can provide a <code>FilterExpression</code> operation.</p>
@@ -50,6 +55,8 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
50
55
  * const response = await client.send(command);
51
56
  * ```
52
57
  *
58
+ * @param ScanCommandInput - {@link ScanCommandInput}
59
+ * @returns {@link ScanCommandOutput}
53
60
  * @see {@link ScanCommandInput} for command's `input` shape.
54
61
  * @see {@link ScanCommandOutput} for command's `response` shape.
55
62
  * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape.
@@ -126,11 +133,20 @@ export interface ScanCommandOutput extends ScanOutput, __MetadataBearer {
126
133
  export declare class ScanCommand extends $Command<ScanCommandInput, ScanCommandOutput, DynamoDBClientResolvedConfig> {
127
134
  readonly input: ScanCommandInput;
128
135
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
136
+ /**
137
+ * @public
138
+ */
129
139
  constructor(input: ScanCommandInput);
130
140
  /**
131
141
  * @internal
132
142
  */
133
143
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DynamoDBClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ScanCommandInput, ScanCommandOutput>;
144
+ /**
145
+ * @internal
146
+ */
134
147
  private serialize;
148
+ /**
149
+ * @internal
150
+ */
135
151
  private deserialize;
136
152
  }