@aws-sdk/client-keyspaces 3.682.0 → 3.686.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 (49) hide show
  1. package/README.md +33 -1
  2. package/dist-cjs/index.js +173 -2
  3. package/dist-es/Keyspaces.js +8 -0
  4. package/dist-es/commands/CreateTypeCommand.js +22 -0
  5. package/dist-es/commands/DeleteTypeCommand.js +22 -0
  6. package/dist-es/commands/GetTypeCommand.js +22 -0
  7. package/dist-es/commands/ListTypesCommand.js +22 -0
  8. package/dist-es/commands/index.js +4 -0
  9. package/dist-es/models/models_0.js +6 -0
  10. package/dist-es/pagination/ListTypesPaginator.js +4 -0
  11. package/dist-es/pagination/index.js +1 -0
  12. package/dist-es/protocols/Aws_json1_0.js +89 -0
  13. package/dist-types/Keyspaces.d.ts +28 -0
  14. package/dist-types/KeyspacesClient.d.ts +6 -2
  15. package/dist-types/commands/CreateKeyspaceCommand.d.ts +1 -1
  16. package/dist-types/commands/CreateTableCommand.d.ts +3 -2
  17. package/dist-types/commands/CreateTypeCommand.d.ts +105 -0
  18. package/dist-types/commands/DeleteKeyspaceCommand.d.ts +2 -1
  19. package/dist-types/commands/DeleteTableCommand.d.ts +2 -1
  20. package/dist-types/commands/DeleteTypeCommand.d.ts +98 -0
  21. package/dist-types/commands/GetKeyspaceCommand.d.ts +2 -1
  22. package/dist-types/commands/GetTableAutoScalingSettingsCommand.d.ts +2 -1
  23. package/dist-types/commands/GetTableCommand.d.ts +5 -3
  24. package/dist-types/commands/GetTypeCommand.d.ts +112 -0
  25. package/dist-types/commands/ListKeyspacesCommand.d.ts +3 -2
  26. package/dist-types/commands/ListTablesCommand.d.ts +6 -2
  27. package/dist-types/commands/ListTagsForResourceCommand.d.ts +5 -1
  28. package/dist-types/commands/ListTypesCommand.d.ts +98 -0
  29. package/dist-types/commands/RestoreTableCommand.d.ts +2 -1
  30. package/dist-types/commands/TagResourceCommand.d.ts +7 -1
  31. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  32. package/dist-types/commands/UpdateTableCommand.d.ts +2 -1
  33. package/dist-types/commands/index.d.ts +4 -0
  34. package/dist-types/models/models_0.d.ts +268 -2
  35. package/dist-types/pagination/ListTypesPaginator.d.ts +7 -0
  36. package/dist-types/pagination/index.d.ts +1 -0
  37. package/dist-types/protocols/Aws_json1_0.d.ts +36 -0
  38. package/dist-types/ts3.4/Keyspaces.d.ts +68 -0
  39. package/dist-types/ts3.4/KeyspacesClient.d.ts +24 -0
  40. package/dist-types/ts3.4/commands/CreateTypeCommand.d.ts +47 -0
  41. package/dist-types/ts3.4/commands/DeleteTypeCommand.d.ts +47 -0
  42. package/dist-types/ts3.4/commands/GetTypeCommand.d.ts +43 -0
  43. package/dist-types/ts3.4/commands/ListTypesCommand.d.ts +47 -0
  44. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  45. package/dist-types/ts3.4/models/models_0.d.ts +52 -0
  46. package/dist-types/ts3.4/pagination/ListTypesPaginator.d.ts +11 -0
  47. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  48. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +48 -0
  49. package/package.json +35 -35
@@ -0,0 +1,112 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
4
+ import { GetTypeRequest, GetTypeResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetTypeCommand}.
14
+ */
15
+ export interface GetTypeCommandInput extends GetTypeRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetTypeCommand}.
21
+ */
22
+ export interface GetTypeCommandOutput extends GetTypeResponse, __MetadataBearer {
23
+ }
24
+ declare const GetTypeCommand_base: {
25
+ new (input: GetTypeCommandInput): import("@smithy/smithy-client").CommandImpl<GetTypeCommandInput, GetTypeCommandOutput, KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetTypeCommandInput): import("@smithy/smithy-client").CommandImpl<GetTypeCommandInput, GetTypeCommandOutput, KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * The <code>GetType</code> operation returns information about the type, for example the field definitions, the timestamp when the type
32
+ * was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.
33
+ * </p>
34
+ * <p>To read keyspace metadata using <code>GetType</code>, the
35
+ * IAM principal needs <code>Select</code> action
36
+ * permissions for the system keyspace.</p>
37
+ * @example
38
+ * Use a bare-bones client and the command you need to make an API call.
39
+ * ```javascript
40
+ * import { KeyspacesClient, GetTypeCommand } from "@aws-sdk/client-keyspaces"; // ES Modules import
41
+ * // const { KeyspacesClient, GetTypeCommand } = require("@aws-sdk/client-keyspaces"); // CommonJS import
42
+ * const client = new KeyspacesClient(config);
43
+ * const input = { // GetTypeRequest
44
+ * keyspaceName: "STRING_VALUE", // required
45
+ * typeName: "STRING_VALUE", // required
46
+ * };
47
+ * const command = new GetTypeCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // GetTypeResponse
50
+ * // keyspaceName: "STRING_VALUE", // required
51
+ * // typeName: "STRING_VALUE", // required
52
+ * // fieldDefinitions: [ // FieldList
53
+ * // { // FieldDefinition
54
+ * // name: "STRING_VALUE", // required
55
+ * // type: "STRING_VALUE", // required
56
+ * // },
57
+ * // ],
58
+ * // lastModifiedTimestamp: new Date("TIMESTAMP"),
59
+ * // status: "STRING_VALUE",
60
+ * // directReferringTables: [ // TableNameList
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // directParentTypes: [ // TypeNameList
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // maxNestingDepth: Number("int"),
67
+ * // keyspaceArn: "STRING_VALUE", // required
68
+ * // };
69
+ *
70
+ * ```
71
+ *
72
+ * @param GetTypeCommandInput - {@link GetTypeCommandInput}
73
+ * @returns {@link GetTypeCommandOutput}
74
+ * @see {@link GetTypeCommandInput} for command's `input` shape.
75
+ * @see {@link GetTypeCommandOutput} for command's `response` shape.
76
+ * @see {@link KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
77
+ *
78
+ * @throws {@link AccessDeniedException} (client fault)
79
+ * <p>You don't have sufficient access permissions to perform this action. </p>
80
+ *
81
+ * @throws {@link InternalServerException} (server fault)
82
+ * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
83
+ *
84
+ * @throws {@link ResourceNotFoundException} (client fault)
85
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
86
+ * or its status might not be <code>ACTIVE</code>.</p>
87
+ *
88
+ * @throws {@link ServiceQuotaExceededException} (client fault)
89
+ * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
90
+ * Guide</i>.</p>
91
+ *
92
+ * @throws {@link ValidationException} (client fault)
93
+ * <p>The operation failed due to an invalid or malformed request.</p>
94
+ *
95
+ * @throws {@link KeyspacesServiceException}
96
+ * <p>Base exception class for all service exceptions from Keyspaces service.</p>
97
+ *
98
+ * @public
99
+ */
100
+ export declare class GetTypeCommand extends GetTypeCommand_base {
101
+ /** @internal type navigation helper, not in runtime. */
102
+ protected static __types: {
103
+ api: {
104
+ input: GetTypeRequest;
105
+ output: GetTypeResponse;
106
+ };
107
+ sdk: {
108
+ input: GetTypeCommandInput;
109
+ output: GetTypeCommandOutput;
110
+ };
111
+ };
112
+ }
@@ -27,7 +27,7 @@ declare const ListKeyspacesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of keyspaces.</p>
30
+ * <p>The <code>ListKeyspaces</code> operation returns a list of keyspaces.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -69,7 +69,8 @@ declare const ListKeyspacesCommand_base: {
69
69
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
70
70
  *
71
71
  * @throws {@link ResourceNotFoundException} (client fault)
72
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
72
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
73
+ * or its status might not be <code>ACTIVE</code>.</p>
73
74
  *
74
75
  * @throws {@link ServiceQuotaExceededException} (client fault)
75
76
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -27,7 +27,10 @@ declare const ListTablesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of tables for a specified keyspace.</p>
30
+ * <p>The <code>ListTables</code> operation returns a list of tables for a specified keyspace.</p>
31
+ * <p>To read keyspace metadata using <code>ListTables</code>, the
32
+ * IAM principal needs <code>Select</code> action
33
+ * permissions for the system keyspace.</p>
31
34
  * @example
32
35
  * Use a bare-bones client and the command you need to make an API call.
33
36
  * ```javascript
@@ -67,7 +70,8 @@ declare const ListTablesCommand_base: {
67
70
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
68
71
  *
69
72
  * @throws {@link ResourceNotFoundException} (client fault)
70
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
73
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
74
+ * or its status might not be <code>ACTIVE</code>.</p>
71
75
  *
72
76
  * @throws {@link ServiceQuotaExceededException} (client fault)
73
77
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -28,6 +28,9 @@ declare const ListTagsForResourceCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Returns a list of all tags associated with the specified Amazon Keyspaces resource.</p>
31
+ * <p>To read keyspace metadata using <code>ListTagsForResource</code>, the
32
+ * IAM principal needs <code>Select</code> action
33
+ * permissions for the specified resource and the system keyspace.</p>
31
34
  * @example
32
35
  * Use a bare-bones client and the command you need to make an API call.
33
36
  * ```javascript
@@ -66,7 +69,8 @@ declare const ListTagsForResourceCommand_base: {
66
69
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
67
70
  *
68
71
  * @throws {@link ResourceNotFoundException} (client fault)
69
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
72
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
73
+ * or its status might not be <code>ACTIVE</code>.</p>
70
74
  *
71
75
  * @throws {@link ServiceQuotaExceededException} (client fault)
72
76
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -0,0 +1,98 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KeyspacesClient";
4
+ import { ListTypesRequest, ListTypesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListTypesCommand}.
14
+ */
15
+ export interface ListTypesCommandInput extends ListTypesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListTypesCommand}.
21
+ */
22
+ export interface ListTypesCommandOutput extends ListTypesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListTypesCommand_base: {
25
+ new (input: ListTypesCommandInput): import("@smithy/smithy-client").CommandImpl<ListTypesCommandInput, ListTypesCommandOutput, KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListTypesCommandInput): import("@smithy/smithy-client").CommandImpl<ListTypesCommandInput, ListTypesCommandOutput, KeyspacesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>
31
+ * The <code>ListTypes</code> operation returns a list of types for a specified keyspace.
32
+ * </p>
33
+ * <p>To read keyspace metadata using <code>ListTypes</code>, the
34
+ * IAM principal needs <code>Select</code> action
35
+ * permissions for the system keyspace.</p>
36
+ * @example
37
+ * Use a bare-bones client and the command you need to make an API call.
38
+ * ```javascript
39
+ * import { KeyspacesClient, ListTypesCommand } from "@aws-sdk/client-keyspaces"; // ES Modules import
40
+ * // const { KeyspacesClient, ListTypesCommand } = require("@aws-sdk/client-keyspaces"); // CommonJS import
41
+ * const client = new KeyspacesClient(config);
42
+ * const input = { // ListTypesRequest
43
+ * nextToken: "STRING_VALUE",
44
+ * maxResults: Number("int"),
45
+ * keyspaceName: "STRING_VALUE", // required
46
+ * };
47
+ * const command = new ListTypesCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // ListTypesResponse
50
+ * // nextToken: "STRING_VALUE",
51
+ * // types: [ // TypeNameList // required
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // };
55
+ *
56
+ * ```
57
+ *
58
+ * @param ListTypesCommandInput - {@link ListTypesCommandInput}
59
+ * @returns {@link ListTypesCommandOutput}
60
+ * @see {@link ListTypesCommandInput} for command's `input` shape.
61
+ * @see {@link ListTypesCommandOutput} for command's `response` shape.
62
+ * @see {@link KeyspacesClientResolvedConfig | config} for KeyspacesClient's `config` shape.
63
+ *
64
+ * @throws {@link AccessDeniedException} (client fault)
65
+ * <p>You don't have sufficient access permissions to perform this action. </p>
66
+ *
67
+ * @throws {@link InternalServerException} (server fault)
68
+ * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
69
+ *
70
+ * @throws {@link ResourceNotFoundException} (client fault)
71
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
72
+ * or its status might not be <code>ACTIVE</code>.</p>
73
+ *
74
+ * @throws {@link ServiceQuotaExceededException} (client fault)
75
+ * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
76
+ * Guide</i>.</p>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p>The operation failed due to an invalid or malformed request.</p>
80
+ *
81
+ * @throws {@link KeyspacesServiceException}
82
+ * <p>Base exception class for all service exceptions from Keyspaces service.</p>
83
+ *
84
+ * @public
85
+ */
86
+ export declare class ListTypesCommand extends ListTypesCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: ListTypesRequest;
91
+ output: ListTypesResponse;
92
+ };
93
+ sdk: {
94
+ input: ListTypesCommandInput;
95
+ output: ListTypesCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -177,7 +177,8 @@ declare const RestoreTableCommand_base: {
177
177
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
178
178
  *
179
179
  * @throws {@link ResourceNotFoundException} (client fault)
180
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
180
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
181
+ * or its status might not be <code>ACTIVE</code>.</p>
181
182
  *
182
183
  * @throws {@link ServiceQuotaExceededException} (client fault)
183
184
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -64,11 +64,17 @@ declare const TagResourceCommand_base: {
64
64
  * @throws {@link AccessDeniedException} (client fault)
65
65
  * <p>You don't have sufficient access permissions to perform this action. </p>
66
66
  *
67
+ * @throws {@link ConflictException} (client fault)
68
+ * <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to
69
+ * perform an action and the same or a different action is already
70
+ * in progress, or if you try to create a resource that already exists. </p>
71
+ *
67
72
  * @throws {@link InternalServerException} (server fault)
68
73
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
69
74
  *
70
75
  * @throws {@link ResourceNotFoundException} (client fault)
71
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
76
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
77
+ * or its status might not be <code>ACTIVE</code>.</p>
72
78
  *
73
79
  * @throws {@link ServiceQuotaExceededException} (client fault)
74
80
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -67,7 +67,8 @@ declare const UntagResourceCommand_base: {
67
67
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
68
68
  *
69
69
  * @throws {@link ResourceNotFoundException} (client fault)
70
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
70
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
71
+ * or its status might not be <code>ACTIVE</code>.</p>
71
72
  *
72
73
  * @throws {@link ServiceQuotaExceededException} (client fault)
73
74
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -138,7 +138,8 @@ declare const UpdateTableCommand_base: {
138
138
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
139
139
  *
140
140
  * @throws {@link ResourceNotFoundException} (client fault)
141
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
141
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
142
+ * or its status might not be <code>ACTIVE</code>.</p>
142
143
  *
143
144
  * @throws {@link ServiceQuotaExceededException} (client fault)
144
145
  * <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
@@ -1,13 +1,17 @@
1
1
  export * from "./CreateKeyspaceCommand";
2
2
  export * from "./CreateTableCommand";
3
+ export * from "./CreateTypeCommand";
3
4
  export * from "./DeleteKeyspaceCommand";
4
5
  export * from "./DeleteTableCommand";
6
+ export * from "./DeleteTypeCommand";
5
7
  export * from "./GetKeyspaceCommand";
6
8
  export * from "./GetTableAutoScalingSettingsCommand";
7
9
  export * from "./GetTableCommand";
10
+ export * from "./GetTypeCommand";
8
11
  export * from "./ListKeyspacesCommand";
9
12
  export * from "./ListTablesCommand";
10
13
  export * from "./ListTagsForResourceCommand";
14
+ export * from "./ListTypesCommand";
11
15
  export * from "./RestoreTableCommand";
12
16
  export * from "./TagResourceCommand";
13
17
  export * from "./UntagResourceCommand";
@@ -972,14 +972,15 @@ export interface CreateTableResponse {
972
972
  resourceArn: string | undefined;
973
973
  }
974
974
  /**
975
- * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
975
+ * <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
976
+ * or its status might not be <code>ACTIVE</code>.</p>
976
977
  * @public
977
978
  */
978
979
  export declare class ResourceNotFoundException extends __BaseException {
979
980
  readonly name: "ResourceNotFoundException";
980
981
  readonly $fault: "client";
981
982
  /**
982
- * <p>The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.</p>
983
+ * <p>The unique identifier in the format of Amazon Resource Name (ARN) for the resource could't be found.</p>
983
984
  * @public
984
985
  */
985
986
  resourceArn?: string;
@@ -988,6 +989,85 @@ export declare class ResourceNotFoundException extends __BaseException {
988
989
  */
989
990
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
990
991
  }
992
+ /**
993
+ * <p>
994
+ * A field definition consists out of a name and a type.
995
+ * </p>
996
+ * @public
997
+ */
998
+ export interface FieldDefinition {
999
+ /**
1000
+ * <p>
1001
+ * The identifier.
1002
+ * </p>
1003
+ * @public
1004
+ */
1005
+ name: string | undefined;
1006
+ /**
1007
+ * <p>
1008
+ * Any supported Cassandra data type, including collections and other user-defined types that are
1009
+ * contained in the same keyspace.
1010
+ * </p>
1011
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html#cassandra-data-type">Cassandra data type support</a> in the <i>Amazon Keyspaces Developer
1012
+ * Guide</i>.</p>
1013
+ * @public
1014
+ */
1015
+ type: string | undefined;
1016
+ }
1017
+ /**
1018
+ * @public
1019
+ */
1020
+ export interface CreateTypeRequest {
1021
+ /**
1022
+ * <p>
1023
+ * The name of the keyspace.
1024
+ * </p>
1025
+ * @public
1026
+ */
1027
+ keyspaceName: string | undefined;
1028
+ /**
1029
+ * <p>
1030
+ * The name of the user-defined type.
1031
+ * </p>
1032
+ * <p>UDT names must contain 48 characters or less, must begin with an alphabetic character, and
1033
+ * can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically
1034
+ * into lower case characters. </p>
1035
+ * <p>Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes,
1036
+ * Amazon Keyspaces preserves upper casing and allows special characters.</p>
1037
+ * <p>You can also use double quotes as part of the
1038
+ * name when you create the UDT, but you must escape each double quote character with an additional
1039
+ * double quote character.</p>
1040
+ * @public
1041
+ */
1042
+ typeName: string | undefined;
1043
+ /**
1044
+ * <p>
1045
+ * The field definitions, consisting of names and types, that define this type.
1046
+ * </p>
1047
+ * @public
1048
+ */
1049
+ fieldDefinitions: FieldDefinition[] | undefined;
1050
+ }
1051
+ /**
1052
+ * @public
1053
+ */
1054
+ export interface CreateTypeResponse {
1055
+ /**
1056
+ * <p>
1057
+ * The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN).
1058
+ * </p>
1059
+ * @public
1060
+ */
1061
+ keyspaceArn: string | undefined;
1062
+ /**
1063
+ * <p>
1064
+ * The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for
1065
+ * other operations, for example <code>GetType</code>.
1066
+ * </p>
1067
+ * @public
1068
+ */
1069
+ typeName: string | undefined;
1070
+ }
991
1071
  /**
992
1072
  * @public
993
1073
  */
@@ -1023,6 +1103,44 @@ export interface DeleteTableRequest {
1023
1103
  */
1024
1104
  export interface DeleteTableResponse {
1025
1105
  }
1106
+ /**
1107
+ * @public
1108
+ */
1109
+ export interface DeleteTypeRequest {
1110
+ /**
1111
+ * <p>
1112
+ * The name of the keyspace of the to be deleted type.
1113
+ * </p>
1114
+ * @public
1115
+ */
1116
+ keyspaceName: string | undefined;
1117
+ /**
1118
+ * <p>
1119
+ * The name of the type to be deleted.
1120
+ * </p>
1121
+ * @public
1122
+ */
1123
+ typeName: string | undefined;
1124
+ }
1125
+ /**
1126
+ * @public
1127
+ */
1128
+ export interface DeleteTypeResponse {
1129
+ /**
1130
+ * <p>
1131
+ * The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource Name (ARN).
1132
+ * </p>
1133
+ * @public
1134
+ */
1135
+ keyspaceArn: string | undefined;
1136
+ /**
1137
+ * <p>
1138
+ * The name of the type that was deleted.
1139
+ * </p>
1140
+ * @public
1141
+ */
1142
+ typeName: string | undefined;
1143
+ }
1026
1144
  /**
1027
1145
  * @public
1028
1146
  */
@@ -1296,6 +1414,107 @@ export interface GetTableAutoScalingSettingsResponse {
1296
1414
  */
1297
1415
  replicaSpecifications?: ReplicaAutoScalingSpecification[];
1298
1416
  }
1417
+ /**
1418
+ * @public
1419
+ */
1420
+ export interface GetTypeRequest {
1421
+ /**
1422
+ * <p>
1423
+ * The name of the keyspace that contains this type.
1424
+ * </p>
1425
+ * @public
1426
+ */
1427
+ keyspaceName: string | undefined;
1428
+ /**
1429
+ * <p>The formatted name of the type. For example, if the name of the type was created
1430
+ * without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was
1431
+ * created in double quotes, you must use double quotes to specify the type name. </p>
1432
+ * @public
1433
+ */
1434
+ typeName: string | undefined;
1435
+ }
1436
+ /**
1437
+ * @public
1438
+ * @enum
1439
+ */
1440
+ export declare const TypeStatus: {
1441
+ readonly ACTIVE: "ACTIVE";
1442
+ readonly CREATING: "CREATING";
1443
+ readonly DELETING: "DELETING";
1444
+ readonly RESTORING: "RESTORING";
1445
+ };
1446
+ /**
1447
+ * @public
1448
+ */
1449
+ export type TypeStatus = (typeof TypeStatus)[keyof typeof TypeStatus];
1450
+ /**
1451
+ * @public
1452
+ */
1453
+ export interface GetTypeResponse {
1454
+ /**
1455
+ * <p>
1456
+ * The name of the keyspace that contains this type.
1457
+ * </p>
1458
+ * @public
1459
+ */
1460
+ keyspaceName: string | undefined;
1461
+ /**
1462
+ * <p>
1463
+ * The name of the type.
1464
+ * </p>
1465
+ * @public
1466
+ */
1467
+ typeName: string | undefined;
1468
+ /**
1469
+ * <p>
1470
+ * The names and types that define this type.
1471
+ * </p>
1472
+ * @public
1473
+ */
1474
+ fieldDefinitions?: FieldDefinition[];
1475
+ /**
1476
+ * <p>
1477
+ * The timestamp that shows when this type was last modified.
1478
+ * </p>
1479
+ * @public
1480
+ */
1481
+ lastModifiedTimestamp?: Date;
1482
+ /**
1483
+ * <p>
1484
+ * The status of this type.
1485
+ * </p>
1486
+ * @public
1487
+ */
1488
+ status?: TypeStatus;
1489
+ /**
1490
+ * <p>
1491
+ * The tables that use this type.
1492
+ * </p>
1493
+ * @public
1494
+ */
1495
+ directReferringTables?: string[];
1496
+ /**
1497
+ * <p>
1498
+ * The types that use this type.
1499
+ * </p>
1500
+ * @public
1501
+ */
1502
+ directParentTypes?: string[];
1503
+ /**
1504
+ * <p>
1505
+ * The level of nesting implemented for this type.
1506
+ * </p>
1507
+ * @public
1508
+ */
1509
+ maxNestingDepth?: number;
1510
+ /**
1511
+ * <p>
1512
+ * The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN).
1513
+ * </p>
1514
+ * @public
1515
+ */
1516
+ keyspaceArn: string | undefined;
1517
+ }
1299
1518
  /**
1300
1519
  * @public
1301
1520
  */
@@ -1454,6 +1673,53 @@ export interface ListTagsForResourceResponse {
1454
1673
  */
1455
1674
  tags?: Tag[];
1456
1675
  }
1676
+ /**
1677
+ * @public
1678
+ */
1679
+ export interface ListTypesRequest {
1680
+ /**
1681
+ * <p>
1682
+ * The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.
1683
+ * </p>
1684
+ * @public
1685
+ */
1686
+ nextToken?: string;
1687
+ /**
1688
+ * <p>
1689
+ * The total number of types to return in the output. If the total number of types available is more than the value specified,
1690
+ * a <code>NextToken</code> is provided in the output. To resume pagination, provide the <code>NextToken</code> value as an
1691
+ * argument of a subsequent API invocation.
1692
+ * </p>
1693
+ * @public
1694
+ */
1695
+ maxResults?: number;
1696
+ /**
1697
+ * <p>
1698
+ * The name of the keyspace that contains the listed types.
1699
+ * </p>
1700
+ * @public
1701
+ */
1702
+ keyspaceName: string | undefined;
1703
+ }
1704
+ /**
1705
+ * @public
1706
+ */
1707
+ export interface ListTypesResponse {
1708
+ /**
1709
+ * <p>
1710
+ * The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.
1711
+ * </p>
1712
+ * @public
1713
+ */
1714
+ nextToken?: string;
1715
+ /**
1716
+ * <p>
1717
+ * The list of types contained in the specified keyspace.
1718
+ * </p>
1719
+ * @public
1720
+ */
1721
+ types: string[] | undefined;
1722
+ }
1457
1723
  /**
1458
1724
  * @public
1459
1725
  */
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { ListTypesCommandInput, ListTypesCommandOutput } from "../commands/ListTypesCommand";
3
+ import { KeyspacesPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListTypes: (config: KeyspacesPaginationConfiguration, input: ListTypesCommandInput, ...rest: any[]) => Paginator<ListTypesCommandOutput>;
@@ -2,3 +2,4 @@ export * from "./Interfaces";
2
2
  export * from "./ListKeyspacesPaginator";
3
3
  export * from "./ListTablesPaginator";
4
4
  export * from "./ListTagsForResourcePaginator";
5
+ export * from "./ListTypesPaginator";