@aws-sdk/client-finspace 3.325.0 → 3.326.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.
@@ -55,6 +55,12 @@ export interface CreateEnvironmentCommandOutput extends CreateEnvironmentRespons
55
55
  * };
56
56
  * const command = new CreateEnvironmentCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // CreateEnvironmentResponse
59
+ * // environmentId: "STRING_VALUE",
60
+ * // environmentArn: "STRING_VALUE",
61
+ * // environmentUrl: "STRING_VALUE",
62
+ * // };
63
+ *
58
64
  * ```
59
65
  *
60
66
  * @param CreateEnvironmentCommandInput - {@link CreateEnvironmentCommandInput}
@@ -83,6 +89,8 @@ export interface CreateEnvironmentCommandOutput extends CreateEnvironmentRespons
83
89
  * @throws {@link ValidationException} (client fault)
84
90
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
85
91
  *
92
+ * @throws {@link FinspaceServiceException}
93
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
86
94
  *
87
95
  */
88
96
  export declare class CreateEnvironmentCommand extends $Command<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentRespons
31
31
  * };
32
32
  * const command = new DeleteEnvironmentCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteEnvironmentCommandInput - {@link DeleteEnvironmentCommandInput}
@@ -55,6 +57,8 @@ export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentRespons
55
57
  * @throws {@link ValidationException} (client fault)
56
58
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
57
59
  *
60
+ * @throws {@link FinspaceServiceException}
61
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
58
62
  *
59
63
  */
60
64
  export declare class DeleteEnvironmentCommand extends $Command<DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
@@ -31,6 +31,32 @@ export interface GetEnvironmentCommandOutput extends GetEnvironmentResponse, __M
31
31
  * };
32
32
  * const command = new GetEnvironmentCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetEnvironmentResponse
35
+ * // environment: { // Environment
36
+ * // name: "STRING_VALUE",
37
+ * // environmentId: "STRING_VALUE",
38
+ * // awsAccountId: "STRING_VALUE",
39
+ * // status: "STRING_VALUE",
40
+ * // environmentUrl: "STRING_VALUE",
41
+ * // description: "STRING_VALUE",
42
+ * // environmentArn: "STRING_VALUE",
43
+ * // sageMakerStudioDomainUrl: "STRING_VALUE",
44
+ * // kmsKeyId: "STRING_VALUE",
45
+ * // dedicatedServiceAccountId: "STRING_VALUE",
46
+ * // federationMode: "STRING_VALUE",
47
+ * // federationParameters: { // FederationParameters
48
+ * // samlMetadataDocument: "STRING_VALUE",
49
+ * // samlMetadataURL: "STRING_VALUE",
50
+ * // applicationCallBackURL: "STRING_VALUE",
51
+ * // federationURN: "STRING_VALUE",
52
+ * // federationProviderName: "STRING_VALUE",
53
+ * // attributeMap: { // AttributeMap
54
+ * // "<keys>": "STRING_VALUE",
55
+ * // },
56
+ * // },
57
+ * // },
58
+ * // };
59
+ *
34
60
  * ```
35
61
  *
36
62
  * @param GetEnvironmentCommandInput - {@link GetEnvironmentCommandInput}
@@ -52,6 +78,8 @@ export interface GetEnvironmentCommandOutput extends GetEnvironmentResponse, __M
52
78
  * @throws {@link ValidationException} (client fault)
53
79
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
54
80
  *
81
+ * @throws {@link FinspaceServiceException}
82
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
55
83
  *
56
84
  */
57
85
  export declare class GetEnvironmentCommand extends $Command<GetEnvironmentCommandInput, GetEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
@@ -32,6 +32,35 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResponse,
32
32
  * };
33
33
  * const command = new ListEnvironmentsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListEnvironmentsResponse
36
+ * // environments: [ // EnvironmentList
37
+ * // { // Environment
38
+ * // name: "STRING_VALUE",
39
+ * // environmentId: "STRING_VALUE",
40
+ * // awsAccountId: "STRING_VALUE",
41
+ * // status: "STRING_VALUE",
42
+ * // environmentUrl: "STRING_VALUE",
43
+ * // description: "STRING_VALUE",
44
+ * // environmentArn: "STRING_VALUE",
45
+ * // sageMakerStudioDomainUrl: "STRING_VALUE",
46
+ * // kmsKeyId: "STRING_VALUE",
47
+ * // dedicatedServiceAccountId: "STRING_VALUE",
48
+ * // federationMode: "STRING_VALUE",
49
+ * // federationParameters: { // FederationParameters
50
+ * // samlMetadataDocument: "STRING_VALUE",
51
+ * // samlMetadataURL: "STRING_VALUE",
52
+ * // applicationCallBackURL: "STRING_VALUE",
53
+ * // federationURN: "STRING_VALUE",
54
+ * // federationProviderName: "STRING_VALUE",
55
+ * // attributeMap: { // AttributeMap
56
+ * // "<keys>": "STRING_VALUE",
57
+ * // },
58
+ * // },
59
+ * // },
60
+ * // ],
61
+ * // nextToken: "STRING_VALUE",
62
+ * // };
63
+ *
35
64
  * ```
36
65
  *
37
66
  * @param ListEnvironmentsCommandInput - {@link ListEnvironmentsCommandInput}
@@ -47,6 +76,8 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResponse,
47
76
  * @throws {@link ValidationException} (client fault)
48
77
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
49
78
  *
79
+ * @throws {@link FinspaceServiceException}
80
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
50
81
  *
51
82
  */
52
83
  export declare class ListEnvironmentsCommand extends $Command<ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput, FinspaceClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // TagMap
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -49,6 +55,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
49
55
  * @throws {@link ResourceNotFoundException} (client fault)
50
56
  * <p>One or more resources can't be found.</p>
51
57
  *
58
+ * @throws {@link FinspaceServiceException}
59
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
52
60
  *
53
61
  */
54
62
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, FinspaceClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -52,6 +54,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>One or more resources can't be found.</p>
54
56
  *
57
+ * @throws {@link FinspaceServiceException}
58
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
55
59
  *
56
60
  */
57
61
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, FinspaceClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -52,6 +54,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>One or more resources can't be found.</p>
54
56
  *
57
+ * @throws {@link FinspaceServiceException}
58
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
55
59
  *
56
60
  */
57
61
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, FinspaceClientResolvedConfig> {
@@ -44,6 +44,32 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentRespons
44
44
  * };
45
45
  * const command = new UpdateEnvironmentCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // UpdateEnvironmentResponse
48
+ * // environment: { // Environment
49
+ * // name: "STRING_VALUE",
50
+ * // environmentId: "STRING_VALUE",
51
+ * // awsAccountId: "STRING_VALUE",
52
+ * // status: "STRING_VALUE",
53
+ * // environmentUrl: "STRING_VALUE",
54
+ * // description: "STRING_VALUE",
55
+ * // environmentArn: "STRING_VALUE",
56
+ * // sageMakerStudioDomainUrl: "STRING_VALUE",
57
+ * // kmsKeyId: "STRING_VALUE",
58
+ * // dedicatedServiceAccountId: "STRING_VALUE",
59
+ * // federationMode: "STRING_VALUE",
60
+ * // federationParameters: { // FederationParameters
61
+ * // samlMetadataDocument: "STRING_VALUE",
62
+ * // samlMetadataURL: "STRING_VALUE",
63
+ * // applicationCallBackURL: "STRING_VALUE",
64
+ * // federationURN: "STRING_VALUE",
65
+ * // federationProviderName: "STRING_VALUE",
66
+ * // attributeMap: { // AttributeMap
67
+ * // "<keys>": "STRING_VALUE",
68
+ * // },
69
+ * // },
70
+ * // },
71
+ * // };
72
+ *
47
73
  * ```
48
74
  *
49
75
  * @param UpdateEnvironmentCommandInput - {@link UpdateEnvironmentCommandInput}
@@ -68,6 +94,8 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentRespons
68
94
  * @throws {@link ValidationException} (client fault)
69
95
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
70
96
  *
97
+ * @throws {@link FinspaceServiceException}
98
+ * <p>Base exception class for all service exceptions from Finspace service.</p>
71
99
  *
72
100
  */
73
101
  export declare class UpdateEnvironmentCommand extends $Command<UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-finspace",
3
3
  "description": "AWS SDK for JavaScript Finspace Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",