import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import type { SearchContactEvaluationsResponse } from "../models/models_2"; import type { SearchContactEvaluationsRequest } from "../models/models_3"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link SearchContactEvaluationsCommand}. */ export interface SearchContactEvaluationsCommandInput extends SearchContactEvaluationsRequest { } /** * @public * * The output of {@link SearchContactEvaluationsCommand}. */ export interface SearchContactEvaluationsCommandOutput extends SearchContactEvaluationsResponse, __MetadataBearer { } declare const SearchContactEvaluationsCommand_base: { new (input: SearchContactEvaluationsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: SearchContactEvaluationsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Searches contact evaluations in an Amazon Connect instance, with optional filtering.

*

* Use cases *

*

Following are common uses cases for this API:

* *

* Important things to know *

* *

* Endpoints: See Amazon Connect endpoints and quotas.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ConnectClient, SearchContactEvaluationsCommand } from "@aws-sdk/client-connect"; // ES Modules import * // const { ConnectClient, SearchContactEvaluationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import * // import type { ConnectClientConfig } from "@aws-sdk/client-connect"; * const config = {}; // type is ConnectClientConfig * const client = new ConnectClient(config); * const input = { // SearchContactEvaluationsRequest * InstanceId: "STRING_VALUE", // required * NextToken: "STRING_VALUE", * MaxResults: Number("int"), * SearchCriteria: { // EvaluationSearchCriteria * OrConditions: [ // EvaluationSearchConditionList * { * OrConditions: [ * "", * ], * AndConditions: [ * "", * ], * StringCondition: { // StringCondition * FieldName: "STRING_VALUE", * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, * NumberCondition: { // NumberCondition * FieldName: "STRING_VALUE", * MinValue: Number("int"), * MaxValue: Number("int"), * ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE", * }, * BooleanCondition: { // BooleanCondition * FieldName: "STRING_VALUE", * ComparisonType: "IS_TRUE" || "IS_FALSE", * }, * DateTimeCondition: { // DateTimeCondition * FieldName: "STRING_VALUE", * MinValue: "STRING_VALUE", * MaxValue: "STRING_VALUE", * ComparisonType: "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL_TO" || "LESS_THAN_OR_EQUAL_TO" || "EQUAL_TO" || "RANGE", * }, * DecimalCondition: { // DecimalCondition * FieldName: "STRING_VALUE", * MinValue: Number("double"), * MaxValue: Number("double"), * ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE", * }, * }, * ], * AndConditions: [ * "", * ], * StringCondition: { * FieldName: "STRING_VALUE", * Value: "STRING_VALUE", * ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", * }, * NumberCondition: { * FieldName: "STRING_VALUE", * MinValue: Number("int"), * MaxValue: Number("int"), * ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE", * }, * BooleanCondition: { * FieldName: "STRING_VALUE", * ComparisonType: "IS_TRUE" || "IS_FALSE", * }, * DateTimeCondition: { * FieldName: "STRING_VALUE", * MinValue: "STRING_VALUE", * MaxValue: "STRING_VALUE", * ComparisonType: "GREATER_THAN" || "LESS_THAN" || "GREATER_THAN_OR_EQUAL_TO" || "LESS_THAN_OR_EQUAL_TO" || "EQUAL_TO" || "RANGE", * }, * DecimalCondition: { * FieldName: "STRING_VALUE", * MinValue: Number("double"), * MaxValue: Number("double"), * ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE", * }, * }, * SearchFilter: { // EvaluationSearchFilter * AttributeFilter: { // ControlPlaneAttributeFilter * OrConditions: [ // CommonAttributeOrConditionList * { // CommonAttributeAndCondition * TagConditions: [ // TagAndConditionList * { // TagCondition * TagKey: "STRING_VALUE", * TagValue: "STRING_VALUE", * }, * ], * }, * ], * AndCondition: { * TagConditions: [ * { * TagKey: "STRING_VALUE", * TagValue: "STRING_VALUE", * }, * ], * }, * TagCondition: "", * }, * }, * }; * const command = new SearchContactEvaluationsCommand(input); * const response = await client.send(command); * // { // SearchContactEvaluationsResponse * // EvaluationSearchSummaryList: [ // EvaluationSearchSummaryList * // { // EvaluationSearchSummary * // EvaluationId: "STRING_VALUE", // required * // EvaluationArn: "STRING_VALUE", // required * // EvaluationFormId: "STRING_VALUE", * // EvaluationFormVersion: Number("int"), // required * // EvaluationFormTitle: "STRING_VALUE", * // Metadata: { // EvaluationSearchMetadata * // ContactId: "STRING_VALUE", // required * // EvaluatorArn: "STRING_VALUE", // required * // ContactAgentId: "STRING_VALUE", * // CalibrationSessionId: "STRING_VALUE", * // ScorePercentage: Number("double"), * // ScoreAutomaticFail: true || false, * // ScoreNotApplicable: true || false, * // AutoEvaluationEnabled: true || false, * // AutoEvaluationStatus: "IN_PROGRESS" || "FAILED" || "SUCCEEDED", * // AcknowledgedTime: new Date("TIMESTAMP"), * // AcknowledgedBy: "STRING_VALUE", * // AcknowledgerComment: "STRING_VALUE", * // SamplingJobId: "STRING_VALUE", * // ReviewId: "STRING_VALUE", * // ContactParticipantRole: "AGENT" || "SYSTEM" || "CUSTOM_BOT" || "CUSTOMER", * // ContactParticipantId: "STRING_VALUE", * // }, * // Status: "DRAFT" || "SUBMITTED" || "REVIEW_REQUESTED" || "UNDER_REVIEW", // required * // EvaluationType: "STANDARD" || "CALIBRATION", * // CreatedTime: new Date("TIMESTAMP"), // required * // LastModifiedTime: new Date("TIMESTAMP"), // required * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // ApproximateTotalCount: Number("long"), * // }; * * ``` * * @param SearchContactEvaluationsCommandInput - {@link SearchContactEvaluationsCommandInput} * @returns {@link SearchContactEvaluationsCommandOutput} * @see {@link SearchContactEvaluationsCommandInput} for command's `input` shape. * @see {@link SearchContactEvaluationsCommandOutput} for command's `response` shape. * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. * * @throws {@link InternalServiceException} (server fault) *

Request processing failed because of an error or failure with the service.

* * @throws {@link InvalidParameterException} (client fault) *

One or more of the specified parameters are not valid.

* * @throws {@link InvalidRequestException} (client fault) *

The request is not valid.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource was not found.

* * @throws {@link ThrottlingException} (client fault) *

The throttling limit has been exceeded.

* * @throws {@link ConnectServiceException} *

Base exception class for all service exceptions from Connect service.

* * * @public */ export declare class SearchContactEvaluationsCommand extends SearchContactEvaluationsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: SearchContactEvaluationsRequest; output: SearchContactEvaluationsResponse; }; sdk: { input: SearchContactEvaluationsCommandInput; output: SearchContactEvaluationsCommandOutput; }; }; }