Skip to content

Commit 70254e2

Browse files
author
awstools
committed
feat(client-neptune-graph): Update ImportTaskCancelled waiter to evaluate task state correctly and minor documentation changes.
1 parent 2f67543 commit 70254e2

12 files changed

+38
-29
lines changed

‎clients/client-neptune-graph/src/commands/CreateGraphCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export interface CreateGraphCommandOutput extends CreateGraphOutput, __MetadataB
5454
* // id: "STRING_VALUE", // required
5555
* // name: "STRING_VALUE", // required
5656
* // arn: "STRING_VALUE", // required
57-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
57+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
5858
* // statusReason: "STRING_VALUE",
5959
* // createTime: new Date("TIMESTAMP"),
6060
* // provisionedMemory: Number("int"),

‎clients/client-neptune-graph/src/commands/CreatePrivateGraphEndpointCommand.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ export interface CreatePrivateGraphEndpointCommandOutput extends CreatePrivateGr
2828

2929
/**
3030
* <p>Create a private graph endpoint to allow private access from to the graph from within
31-
* a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.</p>
31+
* a VPC. You can attach security groups to the private graph endpoint.</p>
32+
* <note>
33+
* <p>VPC endpoint charges apply.</p>
34+
* </note>
3235
* @example
3336
* Use a bare-bones client and the command you need to make an API call.
3437
* ```javascript

‎clients/client-neptune-graph/src/commands/DeleteGraphCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface DeleteGraphCommandOutput extends DeleteGraphOutput, __MetadataB
4444
* // id: "STRING_VALUE", // required
4545
* // name: "STRING_VALUE", // required
4646
* // arn: "STRING_VALUE", // required
47-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
47+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
4848
* // statusReason: "STRING_VALUE",
4949
* // createTime: new Date("TIMESTAMP"),
5050
* // provisionedMemory: Number("int"),

‎clients/client-neptune-graph/src/commands/ExecuteQueryCommand.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ export interface ExecuteQueryCommandOutput extends Omit<ExecuteQueryOutput, "pay
2929
}
3030

3131
/**
32-
* <p>Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a
33-
* parameterized query call, you can use an HTTP request. </p>
32+
* <p>Execute an openCypher query.</p>
3433
* <p>
3534
* When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached
3635
* that allows one of the following IAM actions in that cluster, depending on the query:
@@ -46,13 +45,6 @@ export interface ExecuteQueryCommandOutput extends Omit<ExecuteQueryOutput, "pay
4645
* <p>neptune-graph:DeleteDataViaQuery</p>
4746
* </li>
4847
* </ul>
49-
* <note>
50-
* <p>
51-
* Non-parametrized queries are not considered for plan caching. You can force plan caching with
52-
* <code>planCache=enabled</code>. The plan cache will be reused only for the same exact query. Slight variations
53-
* in the query will not be able to reuse the query plan cache.
54-
* </p>
55-
* </note>
5648
* @example
5749
* Use a bare-bones client and the command you need to make an API call.
5850
* ```javascript

‎clients/client-neptune-graph/src/commands/GetGraphCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface GetGraphCommandOutput extends GetGraphOutput, __MetadataBearer
4343
* // id: "STRING_VALUE", // required
4444
* // name: "STRING_VALUE", // required
4545
* // arn: "STRING_VALUE", // required
46-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
46+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
4747
* // statusReason: "STRING_VALUE",
4848
* // createTime: new Date("TIMESTAMP"),
4949
* // provisionedMemory: Number("int"),

‎clients/client-neptune-graph/src/commands/ListGraphsCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ListGraphsCommandOutput extends ListGraphsOutput, __MetadataBea
4646
* // id: "STRING_VALUE", // required
4747
* // name: "STRING_VALUE", // required
4848
* // arn: "STRING_VALUE", // required
49-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
49+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
5050
* // provisionedMemory: Number("int"),
5151
* // publicConnectivity: true || false,
5252
* // endpoint: "STRING_VALUE",

‎clients/client-neptune-graph/src/commands/ResetGraphCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface ResetGraphCommandOutput extends ResetGraphOutput, __MetadataBea
4444
* // id: "STRING_VALUE", // required
4545
* // name: "STRING_VALUE", // required
4646
* // arn: "STRING_VALUE", // required
47-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
47+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
4848
* // statusReason: "STRING_VALUE",
4949
* // createTime: new Date("TIMESTAMP"),
5050
* // provisionedMemory: Number("int"),

‎clients/client-neptune-graph/src/commands/RestoreGraphFromSnapshotCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export interface RestoreGraphFromSnapshotCommandOutput extends RestoreGraphFromS
5151
* // id: "STRING_VALUE", // required
5252
* // name: "STRING_VALUE", // required
5353
* // arn: "STRING_VALUE", // required
54-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
54+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
5555
* // statusReason: "STRING_VALUE",
5656
* // createTime: new Date("TIMESTAMP"),
5757
* // provisionedMemory: Number("int"),

‎clients/client-neptune-graph/src/commands/UpdateGraphCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface UpdateGraphCommandOutput extends UpdateGraphOutput, __MetadataB
4646
* // id: "STRING_VALUE", // required
4747
* // name: "STRING_VALUE", // required
4848
* // arn: "STRING_VALUE", // required
49-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED",
49+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "RESETTING" || "UPDATING" || "SNAPSHOTTING" || "FAILED" || "IMPORTING",
5050
* // statusReason: "STRING_VALUE",
5151
* // createTime: new Date("TIMESTAMP"),
5252
* // provisionedMemory: Number("int"),

‎clients/client-neptune-graph/src/models/models_0.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -677,6 +677,7 @@ export const GraphStatus = {
677677
CREATING: "CREATING",
678678
DELETING: "DELETING",
679679
FAILED: "FAILED",
680+
IMPORTING: "IMPORTING",
680681
RESETTING: "RESETTING",
681682
SNAPSHOTTING: "SNAPSHOTTING",
682683
UPDATING: "UPDATING",
@@ -731,7 +732,8 @@ export interface CreateGraphOutput {
731732
createTime?: Date;
732733

733734
/**
734-
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
735+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>
736+
* <p>Min = 128</p>
735737
* @public
736738
*/
737739
provisionedMemory?: number;
@@ -744,6 +746,9 @@ export interface CreateGraphOutput {
744746

745747
/**
746748
* <p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>
749+
* <note>
750+
* <p>If enabling public connectivity for the first time, there will be a delay while it is enabled.</p>
751+
* </note>
747752
* @public
748753
*/
749754
publicConnectivity?: boolean;
@@ -757,6 +762,7 @@ export interface CreateGraphOutput {
757762

758763
/**
759764
* <p>The number of replicas in other AZs.</p>
765+
* <p>Default: If not specified, the default value is 1.</p>
760766
* @public
761767
*/
762768
replicaCount?: number;
@@ -1300,7 +1306,8 @@ export interface RestoreGraphFromSnapshotInput {
13001306
graphName: string | undefined;
13011307

13021308
/**
1303-
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
1309+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>
1310+
* <p>Min = 128</p>
13041311
* @public
13051312
*/
13061313
provisionedMemory?: number;
@@ -1446,7 +1453,8 @@ export interface UpdateGraphInput {
14461453
publicConnectivity?: boolean;
14471454

14481455
/**
1449-
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>
1456+
* <p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>
1457+
* <p>Min = 128</p>
14501458
* @public
14511459
*/
14521460
provisionedMemory?: number;

‎clients/client-neptune-graph/src/waiters/waitForImportTaskCancelled.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const checkState = async (client: NeptuneGraphClient, input: GetImportTaskComman
1111
reason = result;
1212
try {
1313
const returnComparator = () => {
14-
return result.status != "CANCELLING";
14+
return result.status != "CANCELLING" && result.status != "CANCELLED";
1515
};
1616
if (returnComparator() == true) {
1717
return { state: WaiterState.FAILURE, reason };

‎codegen/sdk-codegen/aws-models/neptune-graph.json

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1884,7 +1884,7 @@
18841884
"provisionedMemory": {
18851885
"target": "com.amazonaws.neptunegraph#ProvisionedMemory",
18861886
"traits": {
1887-
"smithy.api#documentation": "<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>"
1887+
"smithy.api#documentation": "<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>\n <p>Min = 128</p>"
18881888
}
18891889
},
18901890
"endpoint": {
@@ -1896,7 +1896,7 @@
18961896
"publicConnectivity": {
18971897
"target": "smithy.api#Boolean",
18981898
"traits": {
1899-
"smithy.api#documentation": "<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>"
1899+
"smithy.api#documentation": "<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.</p>\n <note>\n <p>If enabling public connectivity for the first time, there will be a delay while it is enabled.</p>\n </note>"
19001900
}
19011901
},
19021902
"vectorSearchConfiguration": {
@@ -1908,7 +1908,7 @@
19081908
"replicaCount": {
19091909
"target": "com.amazonaws.neptunegraph#ReplicaCount",
19101910
"traits": {
1911-
"smithy.api#documentation": "<p>The number of replicas in other AZs.</p>"
1911+
"smithy.api#documentation": "<p>The number of replicas in other AZs.</p>\n <p>Default: If not specified, the default value is 1.</p>"
19121912
}
19131913
},
19141914
"kmsKeyIdentifier": {
@@ -2283,7 +2283,7 @@
22832283
],
22842284
"traits": {
22852285
"aws.api#controlPlane": {},
2286-
"smithy.api#documentation": "<p>Create a private graph endpoint to allow private access from to the graph from within\n a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.</p>",
2286+
"smithy.api#documentation": "<p>Create a private graph endpoint to allow private access from to the graph from within\n a VPC. You can attach security groups to the private graph endpoint.</p>\n <note>\n <p>VPC endpoint charges apply.</p>\n </note>",
22872287
"smithy.api#http": {
22882288
"code": 201,
22892289
"method": "POST",
@@ -2812,7 +2812,7 @@
28122812
],
28132813
"traits": {
28142814
"aws.api#dataPlane": {},
2815-
"smithy.api#documentation": "<p>Execute an openCypher query. Currently, the SDK does not support parameterized queries. If you want to make a \n parameterized query call, you can use an HTTP request. </p>\n <p>\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n </p>\n <ul>\n <li>\n <p>neptune-graph:ReadDataViaQuery</p>\n </li>\n <li>\n <p>neptune-graph:WriteDataViaQuery</p>\n </li>\n <li>\n <p>neptune-graph:DeleteDataViaQuery</p>\n </li>\n </ul>\n <note>\n <p>\n Non-parametrized queries are not considered for plan caching. You can force plan caching with \n <code>planCache=enabled</code>. The plan cache will be reused only for the same exact query. Slight variations \n in the query will not be able to reuse the query plan cache.\n </p>\n </note>",
2815+
"smithy.api#documentation": "<p>Execute an openCypher query.</p>\n <p>\n When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached \n that allows one of the following IAM actions in that cluster, depending on the query:\n </p>\n <ul>\n <li>\n <p>neptune-graph:ReadDataViaQuery</p>\n </li>\n <li>\n <p>neptune-graph:WriteDataViaQuery</p>\n </li>\n <li>\n <p>neptune-graph:DeleteDataViaQuery</p>\n </li>\n </ul>",
28162816
"smithy.api#endpoint": {
28172817
"hostPrefix": "{graphIdentifier}."
28182818
},
@@ -3516,7 +3516,7 @@
35163516
"state": "failure",
35173517
"matcher": {
35183518
"output": {
3519-
"path": "status != 'CANCELLING'",
3519+
"path": "status != 'CANCELLING' && status != 'CANCELLED'",
35203520
"expected": "true",
35213521
"comparator": "booleanEquals"
35223522
}
@@ -4134,6 +4134,12 @@
41344134
"traits": {
41354135
"smithy.api#enumValue": "FAILED"
41364136
}
4137+
},
4138+
"IMPORTING": {
4139+
"target": "smithy.api#Unit",
4140+
"traits": {
4141+
"smithy.api#enumValue": "IMPORTING"
4142+
}
41374143
}
41384144
}
41394145
},
@@ -5578,7 +5584,7 @@
55785584
"provisionedMemory": {
55795585
"target": "com.amazonaws.neptunegraph#ProvisionedMemory",
55805586
"traits": {
5581-
"smithy.api#documentation": "<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>"
5587+
"smithy.api#documentation": "<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>\n <p>Min = 128</p>"
55825588
}
55835589
},
55845590
"deletionProtection": {
@@ -6202,7 +6208,7 @@
62026208
"provisionedMemory": {
62036209
"target": "com.amazonaws.neptunegraph#ProvisionedMemory",
62046210
"traits": {
6205-
"smithy.api#documentation": "<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 128</p>"
6211+
"smithy.api#documentation": "<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p>\n <p>Min = 128</p>"
62066212
}
62076213
},
62086214
"deletionProtection": {

0 commit comments

Comments
 (0)