@aws-sdk/client-finspace 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,52 +9,61 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
9
9
  import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput } from "./commands/UpdateEnvironmentCommand";
10
10
  import { FinspaceClient } from "./FinspaceClient";
11
11
  /**
12
+ * @public
12
13
  * <p>The FinSpace management service provides the APIs for managing FinSpace environments.</p>
13
14
  */
14
15
  export declare class Finspace extends FinspaceClient {
15
16
  /**
17
+ * @public
16
18
  * <p>Create a new FinSpace environment.</p>
17
19
  */
18
20
  createEnvironment(args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentCommandOutput>;
19
21
  createEnvironment(args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
20
22
  createEnvironment(args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
21
23
  /**
24
+ * @public
22
25
  * <p>Delete an FinSpace environment.</p>
23
26
  */
24
27
  deleteEnvironment(args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentCommandOutput>;
25
28
  deleteEnvironment(args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
26
29
  deleteEnvironment(args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
27
30
  /**
31
+ * @public
28
32
  * <p>Returns the FinSpace environment object.</p>
29
33
  */
30
34
  getEnvironment(args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentCommandOutput>;
31
35
  getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
32
36
  getEnvironment(args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
33
37
  /**
38
+ * @public
34
39
  * <p>A list of all of your FinSpace environments.</p>
35
40
  */
36
41
  listEnvironments(args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentsCommandOutput>;
37
42
  listEnvironments(args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
38
43
  listEnvironments(args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
39
44
  /**
45
+ * @public
40
46
  * <p>A list of all tags for a resource.</p>
41
47
  */
42
48
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
43
49
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
44
50
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
45
51
  /**
52
+ * @public
46
53
  * <p>Adds metadata tags to a FinSpace resource.</p>
47
54
  */
48
55
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
49
56
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
50
57
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
51
58
  /**
59
+ * @public
52
60
  * <p>Removes metadata tags from a FinSpace resource.</p>
53
61
  */
54
62
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
55
63
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
56
64
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
57
65
  /**
66
+ * @public
58
67
  * <p>Update your FinSpace environment.</p>
59
68
  */
60
69
  updateEnvironment(args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentCommandOutput>;
@@ -16,15 +16,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
16
16
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
17
17
  import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput } from "./commands/UpdateEnvironmentCommand";
18
18
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
19
+ /**
20
+ * @public
21
+ */
19
22
  export type ServiceInputTypes = CreateEnvironmentCommandInput | DeleteEnvironmentCommandInput | GetEnvironmentCommandInput | ListEnvironmentsCommandInput | ListTagsForResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEnvironmentCommandInput;
23
+ /**
24
+ * @public
25
+ */
20
26
  export type ServiceOutputTypes = CreateEnvironmentCommandOutput | DeleteEnvironmentCommandOutput | GetEnvironmentCommandOutput | ListEnvironmentsCommandOutput | ListTagsForResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEnvironmentCommandOutput;
27
+ /**
28
+ * @public
29
+ */
21
30
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
22
31
  /**
23
32
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
24
33
  */
25
34
  requestHandler?: __HttpHandler;
26
35
  /**
27
- * A constructor for a class implementing the {@link __Checksum} interface
36
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
28
37
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
29
38
  * @internal
30
39
  */
@@ -114,23 +123,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
114
123
  */
115
124
  logger?: __Logger;
116
125
  /**
117
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
126
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
118
127
  */
119
128
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
120
129
  }
130
+ /**
131
+ * @public
132
+ */
121
133
  type FinspaceClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
122
134
  /**
123
- * The configuration interface of FinspaceClient class constructor that set the region, credentials and other options.
135
+ * @public
136
+ *
137
+ * The configuration interface of FinspaceClient class constructor that set the region, credentials and other options.
124
138
  */
125
139
  export interface FinspaceClientConfig extends FinspaceClientConfigType {
126
140
  }
141
+ /**
142
+ * @public
143
+ */
127
144
  type FinspaceClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
128
145
  /**
129
- * The resolved configuration interface of FinspaceClient class. This is resolved and normalized from the {@link FinspaceClientConfig | constructor configuration interface}.
146
+ * @public
147
+ *
148
+ * The resolved configuration interface of FinspaceClient class. This is resolved and normalized from the {@link FinspaceClientConfig | constructor configuration interface}.
130
149
  */
131
150
  export interface FinspaceClientResolvedConfig extends FinspaceClientResolvedConfigType {
132
151
  }
133
152
  /**
153
+ * @public
134
154
  * <p>The FinSpace management service provides the APIs for managing FinSpace environments.</p>
135
155
  */
136
156
  export declare class FinspaceClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, FinspaceClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { CreateEnvironmentRequest, CreateEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateEnvironmentCommand}.
8
10
  */
9
11
  export interface CreateEnvironmentCommandInput extends CreateEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateEnvironmentCommand}.
13
17
  */
14
18
  export interface CreateEnvironmentCommandOutput extends CreateEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Create a new FinSpace environment.</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 CreateEnvironmentCommandOutput extends CreateEnvironmentRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateEnvironmentCommandInput - {@link CreateEnvironmentCommandInput}
34
+ * @returns {@link CreateEnvironmentCommandOutput}
28
35
  * @see {@link CreateEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateEnvironmentCommandOutput extends CreateEnvironmentRespons
54
61
  export declare class CreateEnvironmentCommand extends $Command<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
55
62
  readonly input: CreateEnvironmentCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateEnvironmentCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { DeleteEnvironmentRequest, DeleteEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteEnvironmentCommand}.
8
10
  */
9
11
  export interface DeleteEnvironmentCommandInput extends DeleteEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteEnvironmentCommand}.
13
17
  */
14
18
  export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete an FinSpace environment.</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 DeleteEnvironmentCommandOutput extends DeleteEnvironmentRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteEnvironmentCommandInput - {@link DeleteEnvironmentCommandInput}
34
+ * @returns {@link DeleteEnvironmentCommandOutput}
28
35
  * @see {@link DeleteEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -50,11 +57,20 @@ export interface DeleteEnvironmentCommandOutput extends DeleteEnvironmentRespons
50
57
  export declare class DeleteEnvironmentCommand extends $Command<DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
51
58
  readonly input: DeleteEnvironmentCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: DeleteEnvironmentCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput>;
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 { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { GetEnvironmentRequest, GetEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetEnvironmentCommand}.
8
10
  */
9
11
  export interface GetEnvironmentCommandInput extends GetEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetEnvironmentCommand}.
13
17
  */
14
18
  export interface GetEnvironmentCommandOutput extends GetEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the FinSpace environment object.</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 GetEnvironmentCommandOutput extends GetEnvironmentResponse, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetEnvironmentCommandInput - {@link GetEnvironmentCommandInput}
34
+ * @returns {@link GetEnvironmentCommandOutput}
28
35
  * @see {@link GetEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link GetEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -47,11 +54,20 @@ export interface GetEnvironmentCommandOutput extends GetEnvironmentResponse, __M
47
54
  export declare class GetEnvironmentCommand extends $Command<GetEnvironmentCommandInput, GetEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
48
55
  readonly input: GetEnvironmentCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetEnvironmentCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetEnvironmentCommandInput, GetEnvironmentCommandOutput>;
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 { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { ListEnvironmentsRequest, ListEnvironmentsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListEnvironmentsCommand}.
8
10
  */
9
11
  export interface ListEnvironmentsCommandInput extends ListEnvironmentsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListEnvironmentsCommand}.
13
17
  */
14
18
  export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A list of all of your FinSpace environments.</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 ListEnvironmentsCommandOutput extends ListEnvironmentsResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListEnvironmentsCommandInput - {@link ListEnvironmentsCommandInput}
34
+ * @returns {@link ListEnvironmentsCommandOutput}
28
35
  * @see {@link ListEnvironmentsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListEnvironmentsCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -41,11 +48,20 @@ export interface ListEnvironmentsCommandOutput extends ListEnvironmentsResponse,
41
48
  export declare class ListEnvironmentsCommand extends $Command<ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput, FinspaceClientResolvedConfig> {
42
49
  readonly input: ListEnvironmentsCommandInput;
43
50
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
51
+ /**
52
+ * @public
53
+ */
44
54
  constructor(input: ListEnvironmentsCommandInput);
45
55
  /**
46
56
  * @internal
47
57
  */
48
58
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput>;
59
+ /**
60
+ * @internal
61
+ */
49
62
  private serialize;
63
+ /**
64
+ * @internal
65
+ */
50
66
  private deserialize;
51
67
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A list of all tags for a resource.</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 ListTagsForResourceCommandOutput extends ListTagsForResourceRes
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
44
51
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, FinspaceClientResolvedConfig> {
45
52
  readonly input: ListTagsForResourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListTagsForResourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link TagResourceCommand}.
8
10
  */
9
11
  export interface TagResourceCommandInput extends TagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link TagResourceCommand}.
13
17
  */
14
18
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds metadata tags to a FinSpace resource.</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 TagResourceCommandOutput extends TagResourceResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
34
+ * @returns {@link TagResourceCommandOutput}
28
35
  * @see {@link TagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -44,11 +51,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
44
51
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, FinspaceClientResolvedConfig> {
45
52
  readonly input: TagResourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: TagResourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UntagResourceCommand}.
8
10
  */
9
11
  export interface UntagResourceCommandInput extends UntagResourceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UntagResourceCommand}.
13
17
  */
14
18
  export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes metadata tags from a FinSpace resource.</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 UntagResourceCommandOutput extends UntagResourceResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
34
+ * @returns {@link UntagResourceCommandOutput}
28
35
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -44,11 +51,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
44
51
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, FinspaceClientResolvedConfig> {
45
52
  readonly input: UntagResourceCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: UntagResourceCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { FinspaceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FinspaceClient";
5
5
  import { UpdateEnvironmentRequest, UpdateEnvironmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateEnvironmentCommand}.
8
10
  */
9
11
  export interface UpdateEnvironmentCommandInput extends UpdateEnvironmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateEnvironmentCommand}.
13
17
  */
14
18
  export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Update your FinSpace environment.</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 UpdateEnvironmentCommandOutput extends UpdateEnvironmentRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateEnvironmentCommandInput - {@link UpdateEnvironmentCommandInput}
34
+ * @returns {@link UpdateEnvironmentCommandOutput}
28
35
  * @see {@link UpdateEnvironmentCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateEnvironmentCommandOutput} for command's `response` shape.
30
37
  * @see {@link FinspaceClientResolvedConfig | config} for FinspaceClient's `config` shape.
@@ -50,11 +57,20 @@ export interface UpdateEnvironmentCommandOutput extends UpdateEnvironmentRespons
50
57
  export declare class UpdateEnvironmentCommand extends $Command<UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput, FinspaceClientResolvedConfig> {
51
58
  readonly input: UpdateEnvironmentCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: UpdateEnvironmentCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FinspaceClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from Finspace service.
4
6
  */
5
7
  export declare class FinspaceServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { FinspaceServiceException as __BaseException } from "./FinspaceServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have sufficient access to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -11,11 +12,15 @@ export declare class AccessDeniedException extends __BaseException {
11
12
  */
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
15
+ /**
16
+ * @public
17
+ */
14
18
  export declare enum FederationMode {
15
19
  FEDERATED = "FEDERATED",
16
20
  LOCAL = "LOCAL"
17
21
  }
18
22
  /**
23
+ * @public
19
24
  * <p>Configuration information when authentication mode is FEDERATED.</p>
20
25
  */
21
26
  export interface FederationParameters {
@@ -49,6 +54,7 @@ export interface FederationParameters {
49
54
  attributeMap?: Record<string, string>;
50
55
  }
51
56
  /**
57
+ * @public
52
58
  * <p>Configuration information for the superuser.</p>
53
59
  */
54
60
  export interface SuperuserParameters {
@@ -65,6 +71,9 @@ export interface SuperuserParameters {
65
71
  */
66
72
  lastName: string | undefined;
67
73
  }
74
+ /**
75
+ * @public
76
+ */
68
77
  export interface CreateEnvironmentRequest {
69
78
  /**
70
79
  * <p>The name of the FinSpace environment to be created.</p>
@@ -109,16 +118,19 @@ export interface CreateEnvironmentRequest {
109
118
  * <ul>
110
119
  * <li>
111
120
  * <p>
112
- * <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p>
121
+ * <code>arn:aws:finspace:$\{Region\}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p>
113
122
  * </li>
114
123
  * <li>
115
124
  * <p>
116
- * <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p>
125
+ * <code>arn:aws:finspace:$\{Region\}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p>
117
126
  * </li>
118
127
  * </ul>
119
128
  */
120
129
  dataBundles?: string[];
121
130
  }
131
+ /**
132
+ * @public
133
+ */
122
134
  export interface CreateEnvironmentResponse {
123
135
  /**
124
136
  * <p>The unique identifier for FinSpace environment that you created.</p>
@@ -134,6 +146,7 @@ export interface CreateEnvironmentResponse {
134
146
  environmentUrl?: string;
135
147
  }
136
148
  /**
149
+ * @public
137
150
  * <p>The request processing has failed because of an unknown error, exception or
138
151
  * failure.</p>
139
152
  */
@@ -146,6 +159,7 @@ export declare class InternalServerException extends __BaseException {
146
159
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
147
160
  }
148
161
  /**
162
+ * @public
149
163
  * <p>A service limit or quota is exceeded.</p>
150
164
  */
151
165
  export declare class LimitExceededException extends __BaseException {
@@ -157,6 +171,7 @@ export declare class LimitExceededException extends __BaseException {
157
171
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
158
172
  }
159
173
  /**
174
+ * @public
160
175
  * <p> You have exceeded your service quota. To perform the requested action,
161
176
  * remove some of the relevant resources, or use Service Quotas to request a service quota increase.</p>
162
177
  */
@@ -169,6 +184,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
169
184
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
170
185
  }
171
186
  /**
187
+ * @public
172
188
  * <p>The request was denied due to request throttling.</p>
173
189
  */
174
190
  export declare class ThrottlingException extends __BaseException {
@@ -180,6 +196,7 @@ export declare class ThrottlingException extends __BaseException {
180
196
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
181
197
  }
182
198
  /**
199
+ * @public
183
200
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
184
201
  */
185
202
  export declare class ValidationException extends __BaseException {
@@ -190,15 +207,22 @@ export declare class ValidationException extends __BaseException {
190
207
  */
191
208
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
192
209
  }
210
+ /**
211
+ * @public
212
+ */
193
213
  export interface DeleteEnvironmentRequest {
194
214
  /**
195
215
  * <p>The identifier for the FinSpace environment.</p>
196
216
  */
197
217
  environmentId: string | undefined;
198
218
  }
219
+ /**
220
+ * @public
221
+ */
199
222
  export interface DeleteEnvironmentResponse {
200
223
  }
201
224
  /**
225
+ * @public
202
226
  * <p>One or more resources can't be found.</p>
203
227
  */
204
228
  export declare class ResourceNotFoundException extends __BaseException {
@@ -209,12 +233,18 @@ export declare class ResourceNotFoundException extends __BaseException {
209
233
  */
210
234
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
211
235
  }
236
+ /**
237
+ * @public
238
+ */
212
239
  export interface GetEnvironmentRequest {
213
240
  /**
214
241
  * <p>The identifier of the FinSpace environment.</p>
215
242
  */
216
243
  environmentId: string | undefined;
217
244
  }
245
+ /**
246
+ * @public
247
+ */
218
248
  export declare enum EnvironmentStatus {
219
249
  CREATED = "CREATED",
220
250
  CREATE_REQUESTED = "CREATE_REQUESTED",
@@ -228,6 +258,7 @@ export declare enum EnvironmentStatus {
228
258
  SUSPENDED = "SUSPENDED"
229
259
  }
230
260
  /**
261
+ * @public
231
262
  * <p>Represents an FinSpace environment.</p>
232
263
  */
233
264
  export interface Environment {
@@ -281,12 +312,18 @@ export interface Environment {
281
312
  */
282
313
  federationParameters?: FederationParameters;
283
314
  }
315
+ /**
316
+ * @public
317
+ */
284
318
  export interface GetEnvironmentResponse {
285
319
  /**
286
320
  * <p>The name of the FinSpace environment.</p>
287
321
  */
288
322
  environment?: Environment;
289
323
  }
324
+ /**
325
+ * @public
326
+ */
290
327
  export interface ListEnvironmentsRequest {
291
328
  /**
292
329
  * <p>A token generated by FinSpace that specifies where to continue pagination if a previous
@@ -299,6 +336,9 @@ export interface ListEnvironmentsRequest {
299
336
  */
300
337
  maxResults?: number;
301
338
  }
339
+ /**
340
+ * @public
341
+ */
302
342
  export interface ListEnvironmentsResponse {
303
343
  /**
304
344
  * <p>A list of all of your FinSpace environments.</p>
@@ -311,6 +351,7 @@ export interface ListEnvironmentsResponse {
311
351
  nextToken?: string;
312
352
  }
313
353
  /**
354
+ * @public
314
355
  * <p>The request is invalid. Something is wrong with the input to the request.</p>
315
356
  */
316
357
  export declare class InvalidRequestException extends __BaseException {
@@ -321,18 +362,27 @@ export declare class InvalidRequestException extends __BaseException {
321
362
  */
322
363
  constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
323
364
  }
365
+ /**
366
+ * @public
367
+ */
324
368
  export interface ListTagsForResourceRequest {
325
369
  /**
326
370
  * <p>The Amazon Resource Name of the resource.</p>
327
371
  */
328
372
  resourceArn: string | undefined;
329
373
  }
374
+ /**
375
+ * @public
376
+ */
330
377
  export interface ListTagsForResourceResponse {
331
378
  /**
332
379
  * <p>A list of all tags for a resource.</p>
333
380
  */
334
381
  tags?: Record<string, string>;
335
382
  }
383
+ /**
384
+ * @public
385
+ */
336
386
  export interface TagResourceRequest {
337
387
  /**
338
388
  * <p>The Amazon Resource Name (ARN) for the resource.</p>
@@ -343,8 +393,14 @@ export interface TagResourceRequest {
343
393
  */
344
394
  tags: Record<string, string> | undefined;
345
395
  }
396
+ /**
397
+ * @public
398
+ */
346
399
  export interface TagResourceResponse {
347
400
  }
401
+ /**
402
+ * @public
403
+ */
348
404
  export interface UntagResourceRequest {
349
405
  /**
350
406
  * <p>A FinSpace resource from which you want to remove a tag or tags. The value for this
@@ -356,8 +412,14 @@ export interface UntagResourceRequest {
356
412
  */
357
413
  tagKeys: string[] | undefined;
358
414
  }
415
+ /**
416
+ * @public
417
+ */
359
418
  export interface UntagResourceResponse {
360
419
  }
420
+ /**
421
+ * @public
422
+ */
361
423
  export interface UpdateEnvironmentRequest {
362
424
  /**
363
425
  * <p>The identifier of the FinSpace environment.</p>
@@ -390,6 +452,9 @@ export interface UpdateEnvironmentRequest {
390
452
  */
391
453
  federationParameters?: FederationParameters;
392
454
  }
455
+ /**
456
+ * @public
457
+ */
393
458
  export interface UpdateEnvironmentResponse {
394
459
  /**
395
460
  * <p>Returns the FinSpace environment object.</p>
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.295.0",
4
+ "version": "3.297.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",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },