@aws-sdk/client-connecthealth 3.1003.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +313 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +46 -0
  4. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  5. package/dist-cjs/endpoint/ruleset.js +7 -0
  6. package/dist-cjs/index.js +483 -0
  7. package/dist-cjs/models/ConnectHealthServiceException.js +12 -0
  8. package/dist-cjs/models/errors.js +99 -0
  9. package/dist-cjs/runtimeConfig.browser.js +43 -0
  10. package/dist-cjs/runtimeConfig.js +60 -0
  11. package/dist-cjs/runtimeConfig.native.js +19 -0
  12. package/dist-cjs/runtimeConfig.shared.js +43 -0
  13. package/dist-cjs/schemas/schemas_0.js +691 -0
  14. package/dist-es/ConnectHealth.js +45 -0
  15. package/dist-es/ConnectHealthClient.js +54 -0
  16. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  17. package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
  18. package/dist-es/commands/ActivateSubscriptionCommand.js +16 -0
  19. package/dist-es/commands/CreateDomainCommand.js +16 -0
  20. package/dist-es/commands/CreateSubscriptionCommand.js +16 -0
  21. package/dist-es/commands/DeactivateSubscriptionCommand.js +16 -0
  22. package/dist-es/commands/DeleteDomainCommand.js +16 -0
  23. package/dist-es/commands/GetDomainCommand.js +16 -0
  24. package/dist-es/commands/GetMedicalScribeListeningSessionCommand.js +16 -0
  25. package/dist-es/commands/GetPatientInsightsJobCommand.js +16 -0
  26. package/dist-es/commands/GetSubscriptionCommand.js +16 -0
  27. package/dist-es/commands/ListDomainsCommand.js +16 -0
  28. package/dist-es/commands/ListSubscriptionsCommand.js +16 -0
  29. package/dist-es/commands/ListTagsForResourceCommand.js +16 -0
  30. package/dist-es/commands/StartMedicalScribeListeningSessionCommand.js +25 -0
  31. package/dist-es/commands/StartPatientInsightsJobCommand.js +16 -0
  32. package/dist-es/commands/TagResourceCommand.js +16 -0
  33. package/dist-es/commands/UntagResourceCommand.js +16 -0
  34. package/dist-es/commands/index.js +16 -0
  35. package/dist-es/endpoint/EndpointParameters.js +11 -0
  36. package/dist-es/endpoint/endpointResolver.js +14 -0
  37. package/dist-es/endpoint/ruleset.js +4 -0
  38. package/dist-es/extensionConfiguration.js +1 -0
  39. package/dist-es/index.js +9 -0
  40. package/dist-es/models/ConnectHealthServiceException.js +8 -0
  41. package/dist-es/models/enums.js +76 -0
  42. package/dist-es/models/errors.js +89 -0
  43. package/dist-es/models/models_0.js +1 -0
  44. package/dist-es/pagination/Interfaces.js +1 -0
  45. package/dist-es/pagination/ListDomainsPaginator.js +4 -0
  46. package/dist-es/pagination/ListSubscriptionsPaginator.js +4 -0
  47. package/dist-es/pagination/index.js +3 -0
  48. package/dist-es/runtimeConfig.browser.js +38 -0
  49. package/dist-es/runtimeConfig.js +55 -0
  50. package/dist-es/runtimeConfig.native.js +15 -0
  51. package/dist-es/runtimeConfig.shared.js +39 -0
  52. package/dist-es/runtimeExtensions.js +9 -0
  53. package/dist-es/schemas/schemas_0.js +687 -0
  54. package/dist-types/ConnectHealth.d.ts +137 -0
  55. package/dist-types/ConnectHealthClient.d.ts +215 -0
  56. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  57. package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
  58. package/dist-types/commands/ActivateSubscriptionCommand.d.ts +96 -0
  59. package/dist-types/commands/CreateDomainCommand.d.ts +101 -0
  60. package/dist-types/commands/CreateSubscriptionCommand.d.ts +96 -0
  61. package/dist-types/commands/DeactivateSubscriptionCommand.d.ts +96 -0
  62. package/dist-types/commands/DeleteDomainCommand.d.ts +79 -0
  63. package/dist-types/commands/GetDomainCommand.d.ts +95 -0
  64. package/dist-types/commands/GetMedicalScribeListeningSessionCommand.d.ts +140 -0
  65. package/dist-types/commands/GetPatientInsightsJobCommand.d.ts +128 -0
  66. package/dist-types/commands/GetSubscriptionCommand.d.ts +96 -0
  67. package/dist-types/commands/ListDomainsCommand.d.ts +85 -0
  68. package/dist-types/commands/ListSubscriptionsCommand.d.ts +100 -0
  69. package/dist-types/commands/ListTagsForResourceCommand.d.ts +76 -0
  70. package/dist-types/commands/StartMedicalScribeListeningSessionCommand.d.ts +159 -0
  71. package/dist-types/commands/StartPatientInsightsJobCommand.d.ts +125 -0
  72. package/dist-types/commands/TagResourceCommand.d.ts +75 -0
  73. package/dist-types/commands/UntagResourceCommand.d.ts +75 -0
  74. package/dist-types/commands/index.d.ts +16 -0
  75. package/dist-types/endpoint/EndpointParameters.d.ts +44 -0
  76. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  77. package/dist-types/endpoint/ruleset.d.ts +2 -0
  78. package/dist-types/extensionConfiguration.d.ts +9 -0
  79. package/dist-types/index.d.ts +17 -0
  80. package/dist-types/models/ConnectHealthServiceException.d.ts +14 -0
  81. package/dist-types/models/enums.d.ts +204 -0
  82. package/dist-types/models/errors.d.ts +90 -0
  83. package/dist-types/models/models_0.d.ts +1519 -0
  84. package/dist-types/pagination/Interfaces.d.ts +8 -0
  85. package/dist-types/pagination/ListDomainsPaginator.d.ts +7 -0
  86. package/dist-types/pagination/ListSubscriptionsPaginator.d.ts +7 -0
  87. package/dist-types/pagination/index.d.ts +3 -0
  88. package/dist-types/runtimeConfig.browser.d.ts +57 -0
  89. package/dist-types/runtimeConfig.d.ts +57 -0
  90. package/dist-types/runtimeConfig.native.d.ts +56 -0
  91. package/dist-types/runtimeConfig.shared.d.ts +27 -0
  92. package/dist-types/runtimeExtensions.d.ts +17 -0
  93. package/dist-types/schemas/schemas_0.d.ts +100 -0
  94. package/dist-types/ts3.4/ConnectHealth.d.ts +304 -0
  95. package/dist-types/ts3.4/ConnectHealthClient.d.ts +232 -0
  96. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  97. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +47 -0
  98. package/dist-types/ts3.4/commands/ActivateSubscriptionCommand.d.ts +51 -0
  99. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +47 -0
  100. package/dist-types/ts3.4/commands/CreateSubscriptionCommand.d.ts +51 -0
  101. package/dist-types/ts3.4/commands/DeactivateSubscriptionCommand.d.ts +51 -0
  102. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +47 -0
  103. package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +47 -0
  104. package/dist-types/ts3.4/commands/GetMedicalScribeListeningSessionCommand.d.ts +51 -0
  105. package/dist-types/ts3.4/commands/GetPatientInsightsJobCommand.d.ts +51 -0
  106. package/dist-types/ts3.4/commands/GetSubscriptionCommand.d.ts +50 -0
  107. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +47 -0
  108. package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +50 -0
  109. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  110. package/dist-types/ts3.4/commands/StartMedicalScribeListeningSessionCommand.d.ts +51 -0
  111. package/dist-types/ts3.4/commands/StartPatientInsightsJobCommand.d.ts +51 -0
  112. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
  113. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
  114. package/dist-types/ts3.4/commands/index.d.ts +16 -0
  115. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
  116. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  117. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  118. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  119. package/dist-types/ts3.4/index.d.ts +12 -0
  120. package/dist-types/ts3.4/models/ConnectHealthServiceException.d.ts +9 -0
  121. package/dist-types/ts3.4/models/enums.d.ts +102 -0
  122. package/dist-types/ts3.4/models/errors.d.ts +53 -0
  123. package/dist-types/ts3.4/models/models_0.d.ts +470 -0
  124. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  125. package/dist-types/ts3.4/pagination/ListDomainsPaginator.d.ts +11 -0
  126. package/dist-types/ts3.4/pagination/ListSubscriptionsPaginator.d.ts +11 -0
  127. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  128. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +101 -0
  129. package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
  130. package/dist-types/ts3.4/runtimeConfig.native.d.ts +105 -0
  131. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +30 -0
  132. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  133. package/dist-types/ts3.4/schemas/schemas_0.d.ts +100 -0
  134. package/package.json +105 -0
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
4
+ import type { CreateSubscriptionInput, CreateSubscriptionOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreateSubscriptionCommand}.
14
+ */
15
+ export interface CreateSubscriptionCommandInput extends CreateSubscriptionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateSubscriptionCommand}.
21
+ */
22
+ export interface CreateSubscriptionCommandOutput extends CreateSubscriptionOutput, __MetadataBearer {
23
+ }
24
+ declare const CreateSubscriptionCommand_base: {
25
+ new (input: CreateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: CreateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a new Subscription within a Domain for billing and user management.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectHealthClient, CreateSubscriptionCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
35
+ * // const { ConnectHealthClient, CreateSubscriptionCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
36
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
37
+ * const config = {}; // type is ConnectHealthClientConfig
38
+ * const client = new ConnectHealthClient(config);
39
+ * const input = { // CreateSubscriptionInput
40
+ * domainId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new CreateSubscriptionCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // CreateSubscriptionOutput
45
+ * // domainId: "STRING_VALUE", // required
46
+ * // subscriptionId: "STRING_VALUE", // required
47
+ * // arn: "STRING_VALUE", // required
48
+ * // status: "ACTIVE" || "INACTIVE" || "DELETED", // required
49
+ * // createdAt: new Date("TIMESTAMP"), // required
50
+ * // lastUpdatedAt: new Date("TIMESTAMP"), // required
51
+ * // activatedAt: new Date("TIMESTAMP"),
52
+ * // deactivatedAt: new Date("TIMESTAMP"),
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param CreateSubscriptionCommandInput - {@link CreateSubscriptionCommandInput}
58
+ * @returns {@link CreateSubscriptionCommandOutput}
59
+ * @see {@link CreateSubscriptionCommandInput} for command's `input` shape.
60
+ * @see {@link CreateSubscriptionCommandOutput} for command's `response` shape.
61
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
62
+ *
63
+ * @throws {@link AccessDeniedException} (client fault)
64
+ * <p>This error is thrown when the client does not supply proper credentials to the API.</p>
65
+ *
66
+ * @throws {@link InternalServerException} (server fault)
67
+ * <p>This error is thrown when a transient error causes our API to fail.</p>
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>This error is thrown when the requested resource is not found.</p>
71
+ *
72
+ * @throws {@link ServiceQuotaExceededException} (client fault)
73
+ * <p>The request exceeds a service quota.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>This error is thrown when the client supplies invalid input to the API.</p>
77
+ *
78
+ * @throws {@link ConnectHealthServiceException}
79
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
80
+ *
81
+ *
82
+ * @public
83
+ */
84
+ export declare class CreateSubscriptionCommand extends CreateSubscriptionCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: CreateSubscriptionInput;
89
+ output: CreateSubscriptionOutput;
90
+ };
91
+ sdk: {
92
+ input: CreateSubscriptionCommandInput;
93
+ output: CreateSubscriptionCommandOutput;
94
+ };
95
+ };
96
+ }
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
4
+ import type { DeactivateSubscriptionInput, DeactivateSubscriptionOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeactivateSubscriptionCommand}.
14
+ */
15
+ export interface DeactivateSubscriptionCommandInput extends DeactivateSubscriptionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeactivateSubscriptionCommand}.
21
+ */
22
+ export interface DeactivateSubscriptionCommandOutput extends DeactivateSubscriptionOutput, __MetadataBearer {
23
+ }
24
+ declare const DeactivateSubscriptionCommand_base: {
25
+ new (input: DeactivateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<DeactivateSubscriptionCommandInput, DeactivateSubscriptionCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DeactivateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<DeactivateSubscriptionCommandInput, DeactivateSubscriptionCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deactivates a Subscription to stop billing for a user.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectHealthClient, DeactivateSubscriptionCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
35
+ * // const { ConnectHealthClient, DeactivateSubscriptionCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
36
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
37
+ * const config = {}; // type is ConnectHealthClientConfig
38
+ * const client = new ConnectHealthClient(config);
39
+ * const input = { // DeactivateSubscriptionInput
40
+ * domainId: "STRING_VALUE", // required
41
+ * subscriptionId: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new DeactivateSubscriptionCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // DeactivateSubscriptionOutput
46
+ * // subscription: { // SubscriptionDescription
47
+ * // domainId: "STRING_VALUE", // required
48
+ * // subscriptionId: "STRING_VALUE", // required
49
+ * // arn: "STRING_VALUE", // required
50
+ * // status: "ACTIVE" || "INACTIVE" || "DELETED", // required
51
+ * // createdAt: new Date("TIMESTAMP"), // required
52
+ * // lastUpdatedAt: new Date("TIMESTAMP"), // required
53
+ * // activatedAt: new Date("TIMESTAMP"),
54
+ * // deactivatedAt: new Date("TIMESTAMP"),
55
+ * // },
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param DeactivateSubscriptionCommandInput - {@link DeactivateSubscriptionCommandInput}
61
+ * @returns {@link DeactivateSubscriptionCommandOutput}
62
+ * @see {@link DeactivateSubscriptionCommandInput} for command's `input` shape.
63
+ * @see {@link DeactivateSubscriptionCommandOutput} for command's `response` shape.
64
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>This error is thrown when the client does not supply proper credentials to the API.</p>
68
+ *
69
+ * @throws {@link InternalServerException} (server fault)
70
+ * <p>This error is thrown when a transient error causes our API to fail.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>This error is thrown when the requested resource is not found.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>This error is thrown when the client supplies invalid input to the API.</p>
77
+ *
78
+ * @throws {@link ConnectHealthServiceException}
79
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
80
+ *
81
+ *
82
+ * @public
83
+ */
84
+ export declare class DeactivateSubscriptionCommand extends DeactivateSubscriptionCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: DeactivateSubscriptionInput;
89
+ output: DeactivateSubscriptionOutput;
90
+ };
91
+ sdk: {
92
+ input: DeactivateSubscriptionCommandInput;
93
+ output: DeactivateSubscriptionCommandOutput;
94
+ };
95
+ };
96
+ }
@@ -0,0 +1,79 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
4
+ import type { DeleteDomainInput, DeleteDomainOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteDomainCommand}.
14
+ */
15
+ export interface DeleteDomainCommandInput extends DeleteDomainInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteDomainCommand}.
21
+ */
22
+ export interface DeleteDomainCommandOutput extends DeleteDomainOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteDomainCommand_base: {
25
+ new (input: DeleteDomainCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDomainCommandInput, DeleteDomainCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: DeleteDomainCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDomainCommandInput, DeleteDomainCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes a Domain and all associated resources.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectHealthClient, DeleteDomainCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
35
+ * // const { ConnectHealthClient, DeleteDomainCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
36
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
37
+ * const config = {}; // type is ConnectHealthClientConfig
38
+ * const client = new ConnectHealthClient(config);
39
+ * const input = { // DeleteDomainInput
40
+ * domainId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new DeleteDomainCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // DeleteDomainOutput
45
+ * // domainId: "STRING_VALUE", // required
46
+ * // arn: "STRING_VALUE", // required
47
+ * // status: "ACTIVE" || "DELETING" || "DELETED", // required
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param DeleteDomainCommandInput - {@link DeleteDomainCommandInput}
53
+ * @returns {@link DeleteDomainCommandOutput}
54
+ * @see {@link DeleteDomainCommandInput} for command's `input` shape.
55
+ * @see {@link DeleteDomainCommandOutput} for command's `response` shape.
56
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
57
+ *
58
+ * @throws {@link ResourceNotFoundException} (client fault)
59
+ * <p>This error is thrown when the requested resource is not found.</p>
60
+ *
61
+ * @throws {@link ConnectHealthServiceException}
62
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
63
+ *
64
+ *
65
+ * @public
66
+ */
67
+ export declare class DeleteDomainCommand extends DeleteDomainCommand_base {
68
+ /** @internal type navigation helper, not in runtime. */
69
+ protected static __types: {
70
+ api: {
71
+ input: DeleteDomainInput;
72
+ output: DeleteDomainOutput;
73
+ };
74
+ sdk: {
75
+ input: DeleteDomainCommandInput;
76
+ output: DeleteDomainCommandOutput;
77
+ };
78
+ };
79
+ }
@@ -0,0 +1,95 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
4
+ import type { GetDomainInput, GetDomainOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetDomainCommand}.
14
+ */
15
+ export interface GetDomainCommandInput extends GetDomainInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetDomainCommand}.
21
+ */
22
+ export interface GetDomainCommandOutput extends GetDomainOutput, __MetadataBearer {
23
+ }
24
+ declare const GetDomainCommand_base: {
25
+ new (input: GetDomainCommandInput): import("@smithy/smithy-client").CommandImpl<GetDomainCommandInput, GetDomainCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetDomainCommandInput): import("@smithy/smithy-client").CommandImpl<GetDomainCommandInput, GetDomainCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves information about a Domain.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectHealthClient, GetDomainCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
35
+ * // const { ConnectHealthClient, GetDomainCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
36
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
37
+ * const config = {}; // type is ConnectHealthClientConfig
38
+ * const client = new ConnectHealthClient(config);
39
+ * const input = { // GetDomainInput
40
+ * domainId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetDomainCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetDomainOutput
45
+ * // domainId: "STRING_VALUE", // required
46
+ * // arn: "STRING_VALUE", // required
47
+ * // name: "STRING_VALUE", // required
48
+ * // kmsKeyArn: "STRING_VALUE",
49
+ * // encryptionContext: { // EncryptionContext
50
+ * // encryptionType: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KEY", // required
51
+ * // kmsKeyArn: "STRING_VALUE",
52
+ * // },
53
+ * // status: "ACTIVE" || "DELETING" || "DELETED", // required
54
+ * // webAppUrl: "STRING_VALUE",
55
+ * // webAppConfiguration: { // WebAppConfiguration
56
+ * // ehrRole: "STRING_VALUE", // required
57
+ * // idcApplicationId: "STRING_VALUE", // required
58
+ * // idcRegion: "STRING_VALUE", // required
59
+ * // },
60
+ * // createdAt: new Date("TIMESTAMP"), // required
61
+ * // tags: { // TagMap
62
+ * // "<keys>": "STRING_VALUE",
63
+ * // },
64
+ * // };
65
+ *
66
+ * ```
67
+ *
68
+ * @param GetDomainCommandInput - {@link GetDomainCommandInput}
69
+ * @returns {@link GetDomainCommandOutput}
70
+ * @see {@link GetDomainCommandInput} for command's `input` shape.
71
+ * @see {@link GetDomainCommandOutput} for command's `response` shape.
72
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
73
+ *
74
+ * @throws {@link ResourceNotFoundException} (client fault)
75
+ * <p>This error is thrown when the requested resource is not found.</p>
76
+ *
77
+ * @throws {@link ConnectHealthServiceException}
78
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
79
+ *
80
+ *
81
+ * @public
82
+ */
83
+ export declare class GetDomainCommand extends GetDomainCommand_base {
84
+ /** @internal type navigation helper, not in runtime. */
85
+ protected static __types: {
86
+ api: {
87
+ input: GetDomainInput;
88
+ output: GetDomainOutput;
89
+ };
90
+ sdk: {
91
+ input: GetDomainCommandInput;
92
+ output: GetDomainCommandOutput;
93
+ };
94
+ };
95
+ }
@@ -0,0 +1,140 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
4
+ import type { GetMedicalScribeListeningSessionInput, GetMedicalScribeListeningSessionOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetMedicalScribeListeningSessionCommand}.
14
+ */
15
+ export interface GetMedicalScribeListeningSessionCommandInput extends GetMedicalScribeListeningSessionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetMedicalScribeListeningSessionCommand}.
21
+ */
22
+ export interface GetMedicalScribeListeningSessionCommandOutput extends GetMedicalScribeListeningSessionOutput, __MetadataBearer {
23
+ }
24
+ declare const GetMedicalScribeListeningSessionCommand_base: {
25
+ new (input: GetMedicalScribeListeningSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetMedicalScribeListeningSessionCommandInput, GetMedicalScribeListeningSessionCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetMedicalScribeListeningSessionCommandInput): import("@smithy/smithy-client").CommandImpl<GetMedicalScribeListeningSessionCommandInput, GetMedicalScribeListeningSessionCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves details about an existing Medical Scribe listening session</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectHealthClient, GetMedicalScribeListeningSessionCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
35
+ * // const { ConnectHealthClient, GetMedicalScribeListeningSessionCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
36
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
37
+ * const config = {}; // type is ConnectHealthClientConfig
38
+ * const client = new ConnectHealthClient(config);
39
+ * const input = { // GetMedicalScribeListeningSessionInput
40
+ * sessionId: "STRING_VALUE", // required
41
+ * domainId: "STRING_VALUE", // required
42
+ * subscriptionId: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new GetMedicalScribeListeningSessionCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // GetMedicalScribeListeningSessionOutput
47
+ * // medicalScribeListeningSessionDetails: { // MedicalScribeListeningSessionDetails
48
+ * // sessionId: "STRING_VALUE",
49
+ * // domainId: "STRING_VALUE",
50
+ * // subscriptionId: "STRING_VALUE",
51
+ * // languageCode: "en-US",
52
+ * // mediaSampleRateHertz: Number("int"),
53
+ * // mediaEncoding: "pcm" || "flac",
54
+ * // channelDefinitions: [ // MedicalScribeChannelDefinitions
55
+ * // { // MedicalScribeChannelDefinition
56
+ * // channelId: Number("int"), // required
57
+ * // participantRole: "PATIENT" || "CLINICIAN", // required
58
+ * // },
59
+ * // ],
60
+ * // postStreamActionSettings: { // MedicalScribePostStreamActionSettingsResponse
61
+ * // outputS3Uri: "STRING_VALUE", // required
62
+ * // clinicalNoteGenerationSettings: { // ClinicalNoteGenerationSettingsResponse
63
+ * // noteTemplateSettings: { // NoteTemplateSettingsResponse Union: only one key present
64
+ * // managedTemplate: { // ManagedTemplateResponse
65
+ * // templateType: "HISTORY_AND_PHYSICAL" || "GIRPP" || "DAP" || "SIRP" || "BIRP" || "BEHAVIORAL_SOAP" || "PHYSICAL_SOAP",
66
+ * // },
67
+ * // customTemplate: { // CustomTemplateResponse
68
+ * // templateType: "HISTORY_AND_PHYSICAL" || "GIRPP" || "DAP" || "SIRP" || "BIRP" || "BEHAVIORAL_SOAP",
69
+ * // },
70
+ * // },
71
+ * // },
72
+ * // },
73
+ * // postStreamActionResult: { // MedicalScribePostStreamActionsResult
74
+ * // clinicalNoteGenerationResult: { // ClinicalNoteGenerationResult
75
+ * // noteResult: { // ArtifactDetails
76
+ * // outputLocation: "STRING_VALUE",
77
+ * // status: "IN_PROGRESS" || "FAILED" || "COMPLETED",
78
+ * // failureReason: "STRING_VALUE",
79
+ * // },
80
+ * // transcriptResult: {
81
+ * // outputLocation: "STRING_VALUE",
82
+ * // status: "IN_PROGRESS" || "FAILED" || "COMPLETED",
83
+ * // failureReason: "STRING_VALUE",
84
+ * // },
85
+ * // afterVisitSummaryResult: {
86
+ * // outputLocation: "STRING_VALUE",
87
+ * // status: "IN_PROGRESS" || "FAILED" || "COMPLETED",
88
+ * // failureReason: "STRING_VALUE",
89
+ * // },
90
+ * // },
91
+ * // },
92
+ * // encounterContextProvided: true || false,
93
+ * // streamStatus: "IN_PROGRESS" || "PAUSED" || "FAILED" || "COMPLETED",
94
+ * // streamCreationTime: new Date("TIMESTAMP"),
95
+ * // streamEndTime: new Date("TIMESTAMP"),
96
+ * // },
97
+ * // };
98
+ *
99
+ * ```
100
+ *
101
+ * @param GetMedicalScribeListeningSessionCommandInput - {@link GetMedicalScribeListeningSessionCommandInput}
102
+ * @returns {@link GetMedicalScribeListeningSessionCommandOutput}
103
+ * @see {@link GetMedicalScribeListeningSessionCommandInput} for command's `input` shape.
104
+ * @see {@link GetMedicalScribeListeningSessionCommandOutput} for command's `response` shape.
105
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
106
+ *
107
+ * @throws {@link AccessDeniedException} (client fault)
108
+ * <p>This error is thrown when the client does not supply proper credentials to the API.</p>
109
+ *
110
+ * @throws {@link InternalServerException} (server fault)
111
+ * <p>This error is thrown when a transient error causes our API to fail.</p>
112
+ *
113
+ * @throws {@link ResourceNotFoundException} (client fault)
114
+ * <p>This error is thrown when the requested resource is not found.</p>
115
+ *
116
+ * @throws {@link ServiceQuotaExceededException} (client fault)
117
+ * <p>The request exceeds a service quota.</p>
118
+ *
119
+ * @throws {@link ThrottlingException} (client fault)
120
+ * <p>This error is thrown when the client exceeds the allowed request rate.</p>
121
+ *
122
+ * @throws {@link ConnectHealthServiceException}
123
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
124
+ *
125
+ *
126
+ * @public
127
+ */
128
+ export declare class GetMedicalScribeListeningSessionCommand extends GetMedicalScribeListeningSessionCommand_base {
129
+ /** @internal type navigation helper, not in runtime. */
130
+ protected static __types: {
131
+ api: {
132
+ input: GetMedicalScribeListeningSessionInput;
133
+ output: GetMedicalScribeListeningSessionOutput;
134
+ };
135
+ sdk: {
136
+ input: GetMedicalScribeListeningSessionCommandInput;
137
+ output: GetMedicalScribeListeningSessionCommandOutput;
138
+ };
139
+ };
140
+ }
@@ -0,0 +1,128 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
4
+ import type { GetPatientInsightsJobRequest, GetPatientInsightsJobResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetPatientInsightsJobCommand}.
14
+ */
15
+ export interface GetPatientInsightsJobCommandInput extends GetPatientInsightsJobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetPatientInsightsJobCommand}.
21
+ */
22
+ export interface GetPatientInsightsJobCommandOutput extends GetPatientInsightsJobResponse, __MetadataBearer {
23
+ }
24
+ declare const GetPatientInsightsJobCommand_base: {
25
+ new (input: GetPatientInsightsJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetPatientInsightsJobCommandInput, GetPatientInsightsJobCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetPatientInsightsJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetPatientInsightsJobCommandInput, GetPatientInsightsJobCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Get details of a started patient insights job.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConnectHealthClient, GetPatientInsightsJobCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
35
+ * // const { ConnectHealthClient, GetPatientInsightsJobCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
36
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
37
+ * const config = {}; // type is ConnectHealthClientConfig
38
+ * const client = new ConnectHealthClient(config);
39
+ * const input = { // GetPatientInsightsJobRequest
40
+ * domainId: "STRING_VALUE", // required
41
+ * jobId: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new GetPatientInsightsJobCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // GetPatientInsightsJobResponse
46
+ * // jobId: "STRING_VALUE", // required
47
+ * // jobArn: "STRING_VALUE", // required
48
+ * // jobStatus: "SUBMITTED" || "IN_PROGRESS" || "FAILED" || "SUCCEEDED", // required
49
+ * // creationTime: new Date("TIMESTAMP"),
50
+ * // updatedTime: new Date("TIMESTAMP"),
51
+ * // insightsOutput: { // InsightsOutput
52
+ * // uri: "STRING_VALUE", // required
53
+ * // },
54
+ * // statusDetails: "STRING_VALUE",
55
+ * // patientContext: { // PatientInsightsPatientContext
56
+ * // patientId: "STRING_VALUE", // required
57
+ * // dateOfBirth: "STRING_VALUE",
58
+ * // pronouns: "HE_HIM" || "SHE_HER" || "THEY_THEM",
59
+ * // },
60
+ * // insightsContext: { // InsightsContext
61
+ * // insightsType: "PRE_VISIT", // required
62
+ * // },
63
+ * // encounterContext: { // PatientInsightsEncounterContext
64
+ * // encounterReason: "STRING_VALUE", // required
65
+ * // },
66
+ * // userContext: { // UserContext
67
+ * // role: "CLINICIAN", // required
68
+ * // userId: "STRING_VALUE", // required
69
+ * // specialty: "PRIMARY_CARE",
70
+ * // },
71
+ * // inputDataConfig: { // InputDataConfig
72
+ * // fhirServer: { // FHIRServer
73
+ * // fhirEndpoint: "STRING_VALUE", // required
74
+ * // oauthToken: "STRING_VALUE",
75
+ * // },
76
+ * // s3Sources: [ // S3Sources
77
+ * // { // S3Source
78
+ * // uri: "STRING_VALUE", // required
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // outputDataConfig: { // OutputDataConfig
83
+ * // s3OutputPath: "STRING_VALUE", // required
84
+ * // },
85
+ * // };
86
+ *
87
+ * ```
88
+ *
89
+ * @param GetPatientInsightsJobCommandInput - {@link GetPatientInsightsJobCommandInput}
90
+ * @returns {@link GetPatientInsightsJobCommandOutput}
91
+ * @see {@link GetPatientInsightsJobCommandInput} for command's `input` shape.
92
+ * @see {@link GetPatientInsightsJobCommandOutput} for command's `response` shape.
93
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
94
+ *
95
+ * @throws {@link AccessDeniedException} (client fault)
96
+ * <p>This error is thrown when the client does not supply proper credentials to the API.</p>
97
+ *
98
+ * @throws {@link InternalServerException} (server fault)
99
+ * <p>This error is thrown when a transient error causes our API to fail.</p>
100
+ *
101
+ * @throws {@link ResourceNotFoundException} (client fault)
102
+ * <p>This error is thrown when the requested resource is not found.</p>
103
+ *
104
+ * @throws {@link ThrottlingException} (client fault)
105
+ * <p>This error is thrown when the client exceeds the allowed request rate.</p>
106
+ *
107
+ * @throws {@link ValidationException} (client fault)
108
+ * <p>This error is thrown when the client supplies invalid input to the API.</p>
109
+ *
110
+ * @throws {@link ConnectHealthServiceException}
111
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
112
+ *
113
+ *
114
+ * @public
115
+ */
116
+ export declare class GetPatientInsightsJobCommand extends GetPatientInsightsJobCommand_base {
117
+ /** @internal type navigation helper, not in runtime. */
118
+ protected static __types: {
119
+ api: {
120
+ input: GetPatientInsightsJobRequest;
121
+ output: GetPatientInsightsJobResponse;
122
+ };
123
+ sdk: {
124
+ input: GetPatientInsightsJobCommandInput;
125
+ output: GetPatientInsightsJobCommandOutput;
126
+ };
127
+ };
128
+ }