@aws-sdk/client-interconnect 3.1030.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.
- package/LICENSE +201 -0
- package/README.md +311 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +454 -0
- package/dist-cjs/models/InterconnectServiceException.js +12 -0
- package/dist-cjs/models/errors.js +95 -0
- package/dist-cjs/runtimeConfig.browser.js +38 -0
- package/dist-cjs/runtimeConfig.js +54 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +43 -0
- package/dist-cjs/schemas/schemas_0.js +379 -0
- package/dist-es/Interconnect.js +47 -0
- package/dist-es/InterconnectClient.js +50 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commands/AcceptConnectionProposalCommand.js +16 -0
- package/dist-es/commands/CreateConnectionCommand.js +16 -0
- package/dist-es/commands/DeleteConnectionCommand.js +16 -0
- package/dist-es/commands/DescribeConnectionProposalCommand.js +16 -0
- package/dist-es/commands/GetConnectionCommand.js +16 -0
- package/dist-es/commands/GetEnvironmentCommand.js +16 -0
- package/dist-es/commands/ListAttachPointsCommand.js +16 -0
- package/dist-es/commands/ListConnectionsCommand.js +16 -0
- package/dist-es/commands/ListEnvironmentsCommand.js +16 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
- package/dist-es/commands/TagResourceCommand.js +16 -0
- package/dist-es/commands/UntagResourceCommand.js +16 -0
- package/dist-es/commands/UpdateConnectionCommand.js +16 -0
- package/dist-es/commands/index.js +13 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +10 -0
- package/dist-es/models/InterconnectServiceException.js +8 -0
- package/dist-es/models/enums.js +22 -0
- package/dist-es/models/errors.js +85 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAttachPointsPaginator.js +4 -0
- package/dist-es/pagination/ListConnectionsPaginator.js +4 -0
- package/dist-es/pagination/ListEnvironmentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/runtimeConfig.browser.js +33 -0
- package/dist-es/runtimeConfig.js +49 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +39 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +375 -0
- package/dist-es/waiters/index.js +2 -0
- package/dist-es/waiters/waitForConnectionAvailable.js +49 -0
- package/dist-es/waiters/waitForConnectionDeleted.js +31 -0
- package/dist-types/Interconnect.d.ts +137 -0
- package/dist-types/InterconnectClient.d.ts +200 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commands/AcceptConnectionProposalCommand.d.ts +164 -0
- package/dist-types/commands/CreateConnectionCommand.d.ts +172 -0
- package/dist-types/commands/DeleteConnectionCommand.d.ts +153 -0
- package/dist-types/commands/DescribeConnectionProposalCommand.d.ts +121 -0
- package/dist-types/commands/GetConnectionCommand.d.ts +152 -0
- package/dist-types/commands/GetEnvironmentCommand.d.ts +146 -0
- package/dist-types/commands/ListAttachPointsCommand.d.ts +125 -0
- package/dist-types/commands/ListConnectionsCommand.d.ts +242 -0
- package/dist-types/commands/ListEnvironmentsCommand.d.ts +173 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +115 -0
- package/dist-types/commands/TagResourceCommand.d.ts +113 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +113 -0
- package/dist-types/commands/UpdateConnectionCommand.d.ts +190 -0
- package/dist-types/commands/index.d.ts +13 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +44 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +18 -0
- package/dist-types/models/InterconnectServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +54 -0
- package/dist-types/models/errors.d.ts +86 -0
- package/dist-types/models/models_0.d.ts +764 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAttachPointsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConnectionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEnvironmentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +27 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +63 -0
- package/dist-types/ts3.4/Interconnect.d.ts +275 -0
- package/dist-types/ts3.4/InterconnectClient.d.ts +197 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
- package/dist-types/ts3.4/commands/AcceptConnectionProposalCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateConnectionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteConnectionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DescribeConnectionProposalCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetConnectionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetEnvironmentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListAttachPointsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListConnectionsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListEnvironmentsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateConnectionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +13 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +13 -0
- package/dist-types/ts3.4/models/InterconnectServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +30 -0
- package/dist-types/ts3.4/models/errors.d.ts +54 -0
- package/dist-types/ts3.4/models/models_0.d.ts +231 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAttachPointsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListConnectionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListEnvironmentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +100 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +104 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +63 -0
- package/dist-types/ts3.4/waiters/index.d.ts +2 -0
- package/dist-types/ts3.4/waiters/waitForConnectionAvailable.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForConnectionDeleted.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +2 -0
- package/dist-types/waiters/waitForConnectionAvailable.d.ts +14 -0
- package/dist-types/waiters/waitForConnectionDeleted.d.ts +14 -0
- package/package.json +101 -0
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InterconnectClient";
|
|
4
|
+
import type { DeleteConnectionRequest, DeleteConnectionResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteConnectionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteConnectionCommandInput extends DeleteConnectionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteConnectionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteConnectionCommandOutput extends DeleteConnectionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteConnectionCommand_base: {
|
|
25
|
+
new (input: DeleteConnectionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteConnectionCommandInput, DeleteConnectionCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteConnectionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteConnectionCommandInput, DeleteConnectionCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes an existing Connection with the supplied identifier.</p> <p>This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the <a>Connection</a> will cease to exist.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { InterconnectClient, DeleteConnectionCommand } from "@aws-sdk/client-interconnect"; // ES Modules import
|
|
35
|
+
* // const { InterconnectClient, DeleteConnectionCommand } = require("@aws-sdk/client-interconnect"); // CommonJS import
|
|
36
|
+
* // import type { InterconnectClientConfig } from "@aws-sdk/client-interconnect";
|
|
37
|
+
* const config = {}; // type is InterconnectClientConfig
|
|
38
|
+
* const client = new InterconnectClient(config);
|
|
39
|
+
* const input = { // DeleteConnectionRequest
|
|
40
|
+
* identifier: "STRING_VALUE", // required
|
|
41
|
+
* clientToken: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new DeleteConnectionCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // DeleteConnectionResponse
|
|
46
|
+
* // connection: { // Connection
|
|
47
|
+
* // id: "STRING_VALUE", // required
|
|
48
|
+
* // arn: "STRING_VALUE", // required
|
|
49
|
+
* // description: "STRING_VALUE", // required
|
|
50
|
+
* // bandwidth: "STRING_VALUE", // required
|
|
51
|
+
* // attachPoint: { // AttachPoint Union: only one key present
|
|
52
|
+
* // directConnectGateway: "STRING_VALUE",
|
|
53
|
+
* // arn: "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // environmentId: "STRING_VALUE", // required
|
|
56
|
+
* // provider: { // Provider Union: only one key present
|
|
57
|
+
* // cloudServiceProvider: "STRING_VALUE",
|
|
58
|
+
* // lastMileProvider: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // location: "STRING_VALUE", // required
|
|
61
|
+
* // type: "STRING_VALUE", // required
|
|
62
|
+
* // state: "available" || "requested" || "pending" || "down" || "deleting" || "deleted" || "failed" || "updating", // required
|
|
63
|
+
* // sharedId: "STRING_VALUE", // required
|
|
64
|
+
* // billingTier: Number("int"),
|
|
65
|
+
* // ownerAccount: "STRING_VALUE", // required
|
|
66
|
+
* // activationKey: "STRING_VALUE", // required
|
|
67
|
+
* // tags: { // TagMap
|
|
68
|
+
* // "<keys>": "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param DeleteConnectionCommandInput - {@link DeleteConnectionCommandInput}
|
|
76
|
+
* @returns {@link DeleteConnectionCommandOutput}
|
|
77
|
+
* @see {@link DeleteConnectionCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link DeleteConnectionCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link InterconnectClientResolvedConfig | config} for InterconnectClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
82
|
+
* <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InterconnectClientException} (client fault)
|
|
85
|
+
* <p>The request was denied due to incorrect client supplied parameters.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InterconnectServerException} (server fault)
|
|
88
|
+
* <p>The request resulted in an exception internal to the service.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link InterconnectValidationException} (client fault)
|
|
91
|
+
* <p>The input fails to satisfy the constraints specified.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
94
|
+
* <p>The request specifies a resource that does not exist on the server.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
97
|
+
* <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
100
|
+
* <p>The request was denied due to request throttling.</p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link InterconnectServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from Interconnect service.</p>
|
|
104
|
+
*
|
|
105
|
+
*
|
|
106
|
+
* @example Delete Connection
|
|
107
|
+
* ```javascript
|
|
108
|
+
* //
|
|
109
|
+
* const input = {
|
|
110
|
+
* identifier: "mcc-abc12345"
|
|
111
|
+
* };
|
|
112
|
+
* const command = new DeleteConnectionCommand(input);
|
|
113
|
+
* const response = await client.send(command);
|
|
114
|
+
* /* response is
|
|
115
|
+
* {
|
|
116
|
+
* connection: {
|
|
117
|
+
* activationKey: "<Activation Key Data>",
|
|
118
|
+
* arn: "arn:aws:interconnect:us-east-1:000000000000:connection/mcc-abc12345",
|
|
119
|
+
* attachPoint: {
|
|
120
|
+
* directConnectGateway: "90392BE3-219C-47FD-BBA5-03DF76D2542A"
|
|
121
|
+
* },
|
|
122
|
+
* bandwidth: "2Gbps",
|
|
123
|
+
* description: "changed Description",
|
|
124
|
+
* environmentId: "mce-aws-acme-1",
|
|
125
|
+
* id: "mcc-abc12345",
|
|
126
|
+
* location: "acme-east",
|
|
127
|
+
* ownerAccount: "000000000000",
|
|
128
|
+
* provider: {
|
|
129
|
+
* cloudServiceProvider: "acme"
|
|
130
|
+
* },
|
|
131
|
+
* sharedId: "B0615F4D-E588-47AD-9D04-1449EAA61C91",
|
|
132
|
+
* state: "deleting",
|
|
133
|
+
* type: "Multicloud"
|
|
134
|
+
* }
|
|
135
|
+
* }
|
|
136
|
+
* *\/
|
|
137
|
+
* ```
|
|
138
|
+
*
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
export declare class DeleteConnectionCommand extends DeleteConnectionCommand_base {
|
|
142
|
+
/** @internal type navigation helper, not in runtime. */
|
|
143
|
+
protected static __types: {
|
|
144
|
+
api: {
|
|
145
|
+
input: DeleteConnectionRequest;
|
|
146
|
+
output: DeleteConnectionResponse;
|
|
147
|
+
};
|
|
148
|
+
sdk: {
|
|
149
|
+
input: DeleteConnectionCommandInput;
|
|
150
|
+
output: DeleteConnectionCommandOutput;
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InterconnectClient";
|
|
4
|
+
import type { DescribeConnectionProposalRequest, DescribeConnectionProposalResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeConnectionProposalCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeConnectionProposalCommandInput extends DescribeConnectionProposalRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeConnectionProposalCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeConnectionProposalCommandOutput extends DescribeConnectionProposalResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeConnectionProposalCommand_base: {
|
|
25
|
+
new (input: DescribeConnectionProposalCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeConnectionProposalCommandInput, DescribeConnectionProposalCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeConnectionProposalCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeConnectionProposalCommandInput, DescribeConnectionProposalCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Describes the details of a connection proposal generated at a partner's portal.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { InterconnectClient, DescribeConnectionProposalCommand } from "@aws-sdk/client-interconnect"; // ES Modules import
|
|
35
|
+
* // const { InterconnectClient, DescribeConnectionProposalCommand } = require("@aws-sdk/client-interconnect"); // CommonJS import
|
|
36
|
+
* // import type { InterconnectClientConfig } from "@aws-sdk/client-interconnect";
|
|
37
|
+
* const config = {}; // type is InterconnectClientConfig
|
|
38
|
+
* const client = new InterconnectClient(config);
|
|
39
|
+
* const input = { // DescribeConnectionProposalRequest
|
|
40
|
+
* activationKey: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DescribeConnectionProposalCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DescribeConnectionProposalResponse
|
|
45
|
+
* // bandwidth: "STRING_VALUE", // required
|
|
46
|
+
* // environmentId: "STRING_VALUE", // required
|
|
47
|
+
* // provider: { // Provider Union: only one key present
|
|
48
|
+
* // cloudServiceProvider: "STRING_VALUE",
|
|
49
|
+
* // lastMileProvider: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // location: "STRING_VALUE", // required
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param DescribeConnectionProposalCommandInput - {@link DescribeConnectionProposalCommandInput}
|
|
57
|
+
* @returns {@link DescribeConnectionProposalCommandOutput}
|
|
58
|
+
* @see {@link DescribeConnectionProposalCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link DescribeConnectionProposalCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link InterconnectClientResolvedConfig | config} for InterconnectClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
63
|
+
* <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InterconnectClientException} (client fault)
|
|
66
|
+
* <p>The request was denied due to incorrect client supplied parameters.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InterconnectServerException} (server fault)
|
|
69
|
+
* <p>The request resulted in an exception internal to the service.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link InterconnectValidationException} (client fault)
|
|
72
|
+
* <p>The input fails to satisfy the constraints specified.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
+
* <p>The request specifies a resource that does not exist on the server.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
+
* <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
81
|
+
* <p>The request was denied due to request throttling.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InterconnectServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Interconnect service.</p>
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
* @example Describe Connection Proposal
|
|
88
|
+
* ```javascript
|
|
89
|
+
* //
|
|
90
|
+
* const input = {
|
|
91
|
+
* activationKey: "<Activation Key Data>"
|
|
92
|
+
* };
|
|
93
|
+
* const command = new DescribeConnectionProposalCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response is
|
|
96
|
+
* {
|
|
97
|
+
* bandwidth: "1Gbps",
|
|
98
|
+
* environmentId: "mce-aws-acme-1",
|
|
99
|
+
* location: "acme-east",
|
|
100
|
+
* provider: {
|
|
101
|
+
* cloudServiceProvider: "acme"
|
|
102
|
+
* }
|
|
103
|
+
* }
|
|
104
|
+
* *\/
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class DescribeConnectionProposalCommand extends DescribeConnectionProposalCommand_base {
|
|
110
|
+
/** @internal type navigation helper, not in runtime. */
|
|
111
|
+
protected static __types: {
|
|
112
|
+
api: {
|
|
113
|
+
input: DescribeConnectionProposalRequest;
|
|
114
|
+
output: DescribeConnectionProposalResponse;
|
|
115
|
+
};
|
|
116
|
+
sdk: {
|
|
117
|
+
input: DescribeConnectionProposalCommandInput;
|
|
118
|
+
output: DescribeConnectionProposalCommandOutput;
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InterconnectClient";
|
|
4
|
+
import type { GetConnectionRequest, GetConnectionResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConnectionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConnectionCommandInput extends GetConnectionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConnectionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConnectionCommandOutput extends GetConnectionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetConnectionCommand_base: {
|
|
25
|
+
new (input: GetConnectionCommandInput): import("@smithy/smithy-client").CommandImpl<GetConnectionCommandInput, GetConnectionCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetConnectionCommandInput): import("@smithy/smithy-client").CommandImpl<GetConnectionCommandInput, GetConnectionCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Describes the current state of a Connection resource as specified by the identifier. </p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { InterconnectClient, GetConnectionCommand } from "@aws-sdk/client-interconnect"; // ES Modules import
|
|
35
|
+
* // const { InterconnectClient, GetConnectionCommand } = require("@aws-sdk/client-interconnect"); // CommonJS import
|
|
36
|
+
* // import type { InterconnectClientConfig } from "@aws-sdk/client-interconnect";
|
|
37
|
+
* const config = {}; // type is InterconnectClientConfig
|
|
38
|
+
* const client = new InterconnectClient(config);
|
|
39
|
+
* const input = { // GetConnectionRequest
|
|
40
|
+
* identifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetConnectionCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetConnectionResponse
|
|
45
|
+
* // connection: { // Connection
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // arn: "STRING_VALUE", // required
|
|
48
|
+
* // description: "STRING_VALUE", // required
|
|
49
|
+
* // bandwidth: "STRING_VALUE", // required
|
|
50
|
+
* // attachPoint: { // AttachPoint Union: only one key present
|
|
51
|
+
* // directConnectGateway: "STRING_VALUE",
|
|
52
|
+
* // arn: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // environmentId: "STRING_VALUE", // required
|
|
55
|
+
* // provider: { // Provider Union: only one key present
|
|
56
|
+
* // cloudServiceProvider: "STRING_VALUE",
|
|
57
|
+
* // lastMileProvider: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // location: "STRING_VALUE", // required
|
|
60
|
+
* // type: "STRING_VALUE", // required
|
|
61
|
+
* // state: "available" || "requested" || "pending" || "down" || "deleting" || "deleted" || "failed" || "updating", // required
|
|
62
|
+
* // sharedId: "STRING_VALUE", // required
|
|
63
|
+
* // billingTier: Number("int"),
|
|
64
|
+
* // ownerAccount: "STRING_VALUE", // required
|
|
65
|
+
* // activationKey: "STRING_VALUE", // required
|
|
66
|
+
* // tags: { // TagMap
|
|
67
|
+
* // "<keys>": "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // },
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param GetConnectionCommandInput - {@link GetConnectionCommandInput}
|
|
75
|
+
* @returns {@link GetConnectionCommandOutput}
|
|
76
|
+
* @see {@link GetConnectionCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link GetConnectionCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link InterconnectClientResolvedConfig | config} for InterconnectClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
+
* <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InterconnectClientException} (client fault)
|
|
84
|
+
* <p>The request was denied due to incorrect client supplied parameters.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link InterconnectServerException} (server fault)
|
|
87
|
+
* <p>The request resulted in an exception internal to the service.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link InterconnectValidationException} (client fault)
|
|
90
|
+
* <p>The input fails to satisfy the constraints specified.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
93
|
+
* <p>The request specifies a resource that does not exist on the server.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
96
|
+
* <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
99
|
+
* <p>The request was denied due to request throttling.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link InterconnectServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from Interconnect service.</p>
|
|
103
|
+
*
|
|
104
|
+
*
|
|
105
|
+
* @example Get connection
|
|
106
|
+
* ```javascript
|
|
107
|
+
* //
|
|
108
|
+
* const input = {
|
|
109
|
+
* identifier: "mcc-abc12345"
|
|
110
|
+
* };
|
|
111
|
+
* const command = new GetConnectionCommand(input);
|
|
112
|
+
* const response = await client.send(command);
|
|
113
|
+
* /* response is
|
|
114
|
+
* {
|
|
115
|
+
* connection: {
|
|
116
|
+
* activationKey: "<Activation Key Data>",
|
|
117
|
+
* arn: "arn:aws:interconnect:us-east-1:000000000000:connection/mcc-abc12345",
|
|
118
|
+
* attachPoint: {
|
|
119
|
+
* directConnectGateway: "90392BE3-219C-47FD-BBA5-03DF76D2542A"
|
|
120
|
+
* },
|
|
121
|
+
* bandwidth: "1Gbps",
|
|
122
|
+
* description: "My MultiCloud Connection",
|
|
123
|
+
* environmentId: "mce-aws-acme-1",
|
|
124
|
+
* id: "mcc-abc12345",
|
|
125
|
+
* location: "acme-east",
|
|
126
|
+
* ownerAccount: "000000000000",
|
|
127
|
+
* provider: {
|
|
128
|
+
* cloudServiceProvider: "acme"
|
|
129
|
+
* },
|
|
130
|
+
* sharedId: "B0615F4D-E588-47AD-9D04-1449EAA61C91",
|
|
131
|
+
* state: "available",
|
|
132
|
+
* type: "Multicloud"
|
|
133
|
+
* }
|
|
134
|
+
* }
|
|
135
|
+
* *\/
|
|
136
|
+
* ```
|
|
137
|
+
*
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export declare class GetConnectionCommand extends GetConnectionCommand_base {
|
|
141
|
+
/** @internal type navigation helper, not in runtime. */
|
|
142
|
+
protected static __types: {
|
|
143
|
+
api: {
|
|
144
|
+
input: GetConnectionRequest;
|
|
145
|
+
output: GetConnectionResponse;
|
|
146
|
+
};
|
|
147
|
+
sdk: {
|
|
148
|
+
input: GetConnectionCommandInput;
|
|
149
|
+
output: GetConnectionCommandOutput;
|
|
150
|
+
};
|
|
151
|
+
};
|
|
152
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InterconnectClient";
|
|
4
|
+
import type { GetEnvironmentRequest, GetEnvironmentResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetEnvironmentCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetEnvironmentCommandInput extends GetEnvironmentRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetEnvironmentCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetEnvironmentCommandOutput extends GetEnvironmentResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetEnvironmentCommand_base: {
|
|
25
|
+
new (input: GetEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<GetEnvironmentCommandInput, GetEnvironmentCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetEnvironmentCommandInput): import("@smithy/smithy-client").CommandImpl<GetEnvironmentCommandInput, GetEnvironmentCommandOutput, InterconnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Describes a specific <a>Environment</a> </p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { InterconnectClient, GetEnvironmentCommand } from "@aws-sdk/client-interconnect"; // ES Modules import
|
|
35
|
+
* // const { InterconnectClient, GetEnvironmentCommand } = require("@aws-sdk/client-interconnect"); // CommonJS import
|
|
36
|
+
* // import type { InterconnectClientConfig } from "@aws-sdk/client-interconnect";
|
|
37
|
+
* const config = {}; // type is InterconnectClientConfig
|
|
38
|
+
* const client = new InterconnectClient(config);
|
|
39
|
+
* const input = { // GetEnvironmentRequest
|
|
40
|
+
* id: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetEnvironmentCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetEnvironmentResponse
|
|
45
|
+
* // environment: { // Environment
|
|
46
|
+
* // provider: { // Provider Union: only one key present
|
|
47
|
+
* // cloudServiceProvider: "STRING_VALUE",
|
|
48
|
+
* // lastMileProvider: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // location: "STRING_VALUE", // required
|
|
51
|
+
* // environmentId: "STRING_VALUE", // required
|
|
52
|
+
* // state: "available" || "limited" || "unavailable", // required
|
|
53
|
+
* // bandwidths: { // Bandwidths
|
|
54
|
+
* // available: [ // BandwidthList
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // supported: [
|
|
58
|
+
* // "STRING_VALUE",
|
|
59
|
+
* // ],
|
|
60
|
+
* // },
|
|
61
|
+
* // type: "STRING_VALUE", // required
|
|
62
|
+
* // activationPageUrl: "STRING_VALUE",
|
|
63
|
+
* // remoteIdentifierType: "account" || "email",
|
|
64
|
+
* // },
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param GetEnvironmentCommandInput - {@link GetEnvironmentCommandInput}
|
|
70
|
+
* @returns {@link GetEnvironmentCommandOutput}
|
|
71
|
+
* @see {@link GetEnvironmentCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link GetEnvironmentCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link InterconnectClientResolvedConfig | config} for InterconnectClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
76
|
+
* <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InterconnectClientException} (client fault)
|
|
79
|
+
* <p>The request was denied due to incorrect client supplied parameters.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InterconnectServerException} (server fault)
|
|
82
|
+
* <p>The request resulted in an exception internal to the service.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InterconnectValidationException} (client fault)
|
|
85
|
+
* <p>The input fails to satisfy the constraints specified.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
88
|
+
* <p>The request specifies a resource that does not exist on the server.</p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
91
|
+
* <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
94
|
+
* <p>The request was denied due to request throttling.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InterconnectServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from Interconnect service.</p>
|
|
98
|
+
*
|
|
99
|
+
*
|
|
100
|
+
* @example Get a specific environment
|
|
101
|
+
* ```javascript
|
|
102
|
+
* //
|
|
103
|
+
* const input = {
|
|
104
|
+
* id: "mce-aws-acme-1"
|
|
105
|
+
* };
|
|
106
|
+
* const command = new GetEnvironmentCommand(input);
|
|
107
|
+
* const response = await client.send(command);
|
|
108
|
+
* /* response is
|
|
109
|
+
* {
|
|
110
|
+
* environment: {
|
|
111
|
+
* bandwidths: {
|
|
112
|
+
* available: [
|
|
113
|
+
* "1Gbps"
|
|
114
|
+
* ],
|
|
115
|
+
* supported: [
|
|
116
|
+
* "1Gbps",
|
|
117
|
+
* "2Gbps"
|
|
118
|
+
* ]
|
|
119
|
+
* },
|
|
120
|
+
* environmentId: "mce-aws-acme-1",
|
|
121
|
+
* location: "acme-east",
|
|
122
|
+
* provider: {
|
|
123
|
+
* cloudServiceProvider: "acme"
|
|
124
|
+
* },
|
|
125
|
+
* state: "available",
|
|
126
|
+
* type: "Multicloud"
|
|
127
|
+
* }
|
|
128
|
+
* }
|
|
129
|
+
* *\/
|
|
130
|
+
* ```
|
|
131
|
+
*
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export declare class GetEnvironmentCommand extends GetEnvironmentCommand_base {
|
|
135
|
+
/** @internal type navigation helper, not in runtime. */
|
|
136
|
+
protected static __types: {
|
|
137
|
+
api: {
|
|
138
|
+
input: GetEnvironmentRequest;
|
|
139
|
+
output: GetEnvironmentResponse;
|
|
140
|
+
};
|
|
141
|
+
sdk: {
|
|
142
|
+
input: GetEnvironmentCommandInput;
|
|
143
|
+
output: GetEnvironmentCommandOutput;
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
}
|