@aws-sdk/client-connecthealth 3.1003.0

package/dist-types/commands/TagResourceCommand.d.ts

@@ -0,0 +1,75 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
+import type { TagResourceInput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandInput extends TagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link TagResourceCommand}.
+ */
+export interface TagResourceCommandOutput extends __MetadataBearer {
+}
+declare const TagResourceCommand_base: {
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: TagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<TagResourceCommandInput, TagResourceCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Associates the specified tags with the specified resource</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectHealthClient, TagResourceCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
+ * // const { ConnectHealthClient, TagResourceCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
+ * const config = {}; // type is ConnectHealthClientConfig
+ * const client = new ConnectHealthClient(config);
+ * const input = { // TagResourceInput
+ *   resourceArn: "STRING_VALUE", // required
+ *   tags: { // TagMap // required
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ * };
+ * const command = new TagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
+ *
+ * @throws {@link ConnectHealthServiceException}
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
+ *
+ *
+ * @public
+ */
+export declare class TagResourceCommand extends TagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: TagResourceInput;
+            output: {};
+        };
+        sdk: {
+            input: TagResourceCommandInput;
+            output: TagResourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -0,0 +1,75 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectHealthClient";
+import type { UntagResourceInput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandInput extends UntagResourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UntagResourceCommand}.
+ */
+export interface UntagResourceCommandOutput extends __MetadataBearer {
+}
+declare const UntagResourceCommand_base: {
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UntagResourceCommandInput): import("@smithy/smithy-client").CommandImpl<UntagResourceCommandInput, UntagResourceCommandOutput, ConnectHealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Removes the specified tags from the specified resource</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectHealthClient, UntagResourceCommand } from "@aws-sdk/client-connecthealth"; // ES Modules import
+ * // const { ConnectHealthClient, UntagResourceCommand } = require("@aws-sdk/client-connecthealth"); // CommonJS import
+ * // import type { ConnectHealthClientConfig } from "@aws-sdk/client-connecthealth";
+ * const config = {}; // type is ConnectHealthClientConfig
+ * const client = new ConnectHealthClient(config);
+ * const input = { // UntagResourceInput
+ *   resourceArn: "STRING_VALUE", // required
+ *   tagKeys: [ // TagKeyList // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UntagResourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
+ * @see {@link ConnectHealthClientResolvedConfig | config} for ConnectHealthClient's `config` shape.
+ *
+ * @throws {@link ConnectHealthServiceException}
+ * <p>Base exception class for all service exceptions from ConnectHealth service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UntagResourceCommand extends UntagResourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UntagResourceInput;
+            output: {};
+        };
+        sdk: {
+            input: UntagResourceCommandInput;
+            output: UntagResourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./ActivateSubscriptionCommand";
+export * from "./CreateDomainCommand";
+export * from "./CreateSubscriptionCommand";
+export * from "./DeactivateSubscriptionCommand";
+export * from "./DeleteDomainCommand";
+export * from "./GetDomainCommand";
+export * from "./GetMedicalScribeListeningSessionCommand";
+export * from "./GetPatientInsightsJobCommand";
+export * from "./GetSubscriptionCommand";
+export * from "./ListDomainsCommand";
+export * from "./ListSubscriptionsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./StartMedicalScribeListeningSessionCommand";
+export * from "./StartPatientInsightsJobCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,44 @@
+import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | undefined | Provider<string | undefined>;
+}
+/**
+ * @public
+ */
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+/**
+ * @internal
+ */
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+/**
+ * @internal
+ */
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+};
+/**
+ * @internal
+ */
+export interface EndpointParameters extends __EndpointParameters {
+    UseFIPS?: boolean | undefined;
+    Endpoint?: string | undefined;
+    Region?: string | undefined;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import type { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface ConnectHealthExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * <p>Health Agent for healthcare providers and patient engagement</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./ConnectHealthClient";
+export * from "./ConnectHealth";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { ConnectHealthExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./pagination";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { ConnectHealthServiceException } from "./models/ConnectHealthServiceException";

package/dist-types/models/ConnectHealthServiceException.d.ts

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from ConnectHealth service.
+ */
+export declare class ConnectHealthServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/enums.d.ts

@@ -0,0 +1,204 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const SubscriptionStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly DELETED: "DELETED";
+    readonly INACTIVE: "INACTIVE";
+};
+/**
+ * @public
+ */
+export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const PostStreamArtifactGenerationStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+};
+/**
+ * @public
+ */
+export type PostStreamArtifactGenerationStatus = (typeof PostStreamArtifactGenerationStatus)[keyof typeof PostStreamArtifactGenerationStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const CustomTemplateBase: {
+    readonly BEHAVIORAL_SOAP: "BEHAVIORAL_SOAP";
+    readonly BIRP: "BIRP";
+    readonly DAP: "DAP";
+    readonly GIRPP: "GIRPP";
+    readonly HISTORY_AND_PHYSICAL: "HISTORY_AND_PHYSICAL";
+    readonly SIRP: "SIRP";
+};
+/**
+ * @public
+ */
+export type CustomTemplateBase = (typeof CustomTemplateBase)[keyof typeof CustomTemplateBase];
+/**
+ * @public
+ * @enum
+ */
+export declare const ManagedNoteTemplate: {
+    readonly BEHAVIORAL_SOAP: "BEHAVIORAL_SOAP";
+    readonly BIRP: "BIRP";
+    readonly DAP: "DAP";
+    readonly GIRPP: "GIRPP";
+    readonly HISTORY_AND_PHYSICAL: "HISTORY_AND_PHYSICAL";
+    readonly PHYSICAL_SOAP: "PHYSICAL_SOAP";
+    readonly SIRP: "SIRP";
+};
+/**
+ * @public
+ */
+export type ManagedNoteTemplate = (typeof ManagedNoteTemplate)[keyof typeof ManagedNoteTemplate];
+/**
+ * @public
+ * @enum
+ */
+export declare const EncryptionType: {
+    readonly AWS_OWNED_KEY: "AWS_OWNED_KEY";
+    readonly CUSTOMER_MANAGED_KEY: "CUSTOMER_MANAGED_KEY";
+};
+/**
+ * @public
+ */
+export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
+/**
+ * @public
+ * @enum
+ */
+export declare const DomainStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly DELETED: "DELETED";
+    readonly DELETING: "DELETING";
+};
+/**
+ * @public
+ */
+export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const MedicalScribeParticipantRole: {
+    readonly CLINICIAN: "CLINICIAN";
+    readonly PATIENT: "PATIENT";
+};
+/**
+ * @public
+ */
+export type MedicalScribeParticipantRole = (typeof MedicalScribeParticipantRole)[keyof typeof MedicalScribeParticipantRole];
+/**
+ * @public
+ * @enum
+ */
+export declare const MedicalScribeLanguageCode: {
+    readonly EN_US: "en-US";
+};
+/**
+ * @public
+ */
+export type MedicalScribeLanguageCode = (typeof MedicalScribeLanguageCode)[keyof typeof MedicalScribeLanguageCode];
+/**
+ * @public
+ * @enum
+ */
+export declare const MedicalScribeMediaEncoding: {
+    readonly FLAC: "flac";
+    readonly PCM: "pcm";
+};
+/**
+ * @public
+ */
+export type MedicalScribeMediaEncoding = (typeof MedicalScribeMediaEncoding)[keyof typeof MedicalScribeMediaEncoding];
+/**
+ * @public
+ * @enum
+ */
+export declare const MedicalScribeStreamStatus: {
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly PAUSED: "PAUSED";
+};
+/**
+ * @public
+ */
+export type MedicalScribeStreamStatus = (typeof MedicalScribeStreamStatus)[keyof typeof MedicalScribeStreamStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const InsightsType: {
+    readonly PRE_VISIT: "PRE_VISIT";
+};
+/**
+ * @public
+ */
+export type InsightsType = (typeof InsightsType)[keyof typeof InsightsType];
+/**
+ * @public
+ * @enum
+ */
+export declare const JobStatus: {
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly SUBMITTED: "SUBMITTED";
+    readonly SUCCEEDED: "SUCCEEDED";
+};
+/**
+ * @public
+ */
+export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const Pronouns: {
+    readonly HE_HIM: "HE_HIM";
+    readonly SHE_HER: "SHE_HER";
+    readonly THEY_THEM: "THEY_THEM";
+};
+/**
+ * @public
+ */
+export type Pronouns = (typeof Pronouns)[keyof typeof Pronouns];
+/**
+ * @public
+ * @enum
+ */
+export declare const ProviderRole: {
+    readonly CLINICIAN: "CLINICIAN";
+};
+/**
+ * @public
+ */
+export type ProviderRole = (typeof ProviderRole)[keyof typeof ProviderRole];
+/**
+ * @public
+ * @enum
+ */
+export declare const Specialty: {
+    readonly PRIMARY_CARE: "PRIMARY_CARE";
+};
+/**
+ * @public
+ */
+export type Specialty = (typeof Specialty)[keyof typeof Specialty];
+/**
+ * @public
+ * @enum
+ */
+export declare const MedicalScribeSessionControlEventType: {
+    readonly END_OF_SESSION: "END_OF_SESSION";
+};
+/**
+ * @public
+ */
+export type MedicalScribeSessionControlEventType = (typeof MedicalScribeSessionControlEventType)[keyof typeof MedicalScribeSessionControlEventType];

package/dist-types/models/errors.d.ts

@@ -0,0 +1,90 @@
+import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { ConnectHealthServiceException as __BaseException } from "./ConnectHealthServiceException";
+/**
+ * <p>This error is thrown when the client does not supply proper credentials to the API.</p>
+ * @public
+ */
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+/**
+ * <p>This error is thrown when a transient error causes our API to fail.</p>
+ * @public
+ */
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    $retryable: {};
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>This error is thrown when the requested resource is not found.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * <p>This error is thrown when the client supplies invalid input to the API.</p>
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * <p>This error is thrown when a resource update is no longer valid due to assumptions about initial state changing.</p>
+ * @public
+ */
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+/**
+ * <p>The request exceeds a service quota.</p>
+ * @public
+ */
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+/**
+ * <p>This error is thrown when the client exceeds the allowed request rate.</p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {
+        throttling: boolean;
+    };
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}