@aws-sdk/client-connect 3.613.0 → 3.616.0

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

@@ -0,0 +1,142 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
+import { SearchAgentStatusesRequest, SearchAgentStatusesResponse } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SearchAgentStatusesCommand}.
+ */
+export interface SearchAgentStatusesCommandInput extends SearchAgentStatusesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchAgentStatusesCommand}.
+ */
+export interface SearchAgentStatusesCommandOutput extends SearchAgentStatusesResponse, __MetadataBearer {
+}
+declare const SearchAgentStatusesCommand_base: {
+    new (input: SearchAgentStatusesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchAgentStatusesCommandInput, SearchAgentStatusesCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SearchAgentStatusesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchAgentStatusesCommandInput, SearchAgentStatusesCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Searches AgentStatuses in an Amazon Connect instance, with optional filtering.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectClient, SearchAgentStatusesCommand } from "@aws-sdk/client-connect"; // ES Modules import
+ * // const { ConnectClient, SearchAgentStatusesCommand } = require("@aws-sdk/client-connect"); // CommonJS import
+ * const client = new ConnectClient(config);
+ * const input = { // SearchAgentStatusesRequest
+ *   InstanceId: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   SearchFilter: { // AgentStatusSearchFilter
+ *     AttributeFilter: { // ControlPlaneAttributeFilter
+ *       OrConditions: [ // CommonAttributeOrConditionList
+ *         { // CommonAttributeAndCondition
+ *           TagConditions: [ // TagAndConditionList
+ *             { // TagCondition
+ *               TagKey: "STRING_VALUE",
+ *               TagValue: "STRING_VALUE",
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *       AndCondition: {
+ *         TagConditions: [
+ *           {
+ *             TagKey: "STRING_VALUE",
+ *             TagValue: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *       TagCondition: "<TagCondition>",
+ *     },
+ *   },
+ *   SearchCriteria: { // AgentStatusSearchCriteria
+ *     OrConditions: [ // AgentStatusSearchConditionList
+ *       {
+ *         OrConditions: [
+ *           "<AgentStatusSearchCriteria>",
+ *         ],
+ *         AndConditions: [
+ *           "<AgentStatusSearchCriteria>",
+ *         ],
+ *         StringCondition: { // StringCondition
+ *           FieldName: "STRING_VALUE",
+ *           Value: "STRING_VALUE",
+ *           ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
+ *         },
+ *       },
+ *     ],
+ *     AndConditions: [
+ *       "<AgentStatusSearchCriteria>",
+ *     ],
+ *     StringCondition: {
+ *       FieldName: "STRING_VALUE",
+ *       Value: "STRING_VALUE",
+ *       ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
+ *     },
+ *   },
+ * };
+ * const command = new SearchAgentStatusesCommand(input);
+ * const response = await client.send(command);
+ * // { // SearchAgentStatusesResponse
+ * //   AgentStatuses: [ // AgentStatusList
+ * //     { // AgentStatus
+ * //       AgentStatusARN: "STRING_VALUE",
+ * //       AgentStatusId: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       Description: "STRING_VALUE",
+ * //       Type: "ROUTABLE" || "CUSTOM" || "OFFLINE",
+ * //       DisplayOrder: Number("int"),
+ * //       State: "ENABLED" || "DISABLED",
+ * //       Tags: { // TagMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       LastModifiedTime: new Date("TIMESTAMP"),
+ * //       LastModifiedRegion: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   ApproximateTotalCount: Number("long"),
+ * // };
+ *
+ * ```
+ *
+ * @param SearchAgentStatusesCommandInput - {@link SearchAgentStatusesCommandInput}
+ * @returns {@link SearchAgentStatusesCommandOutput}
+ * @see {@link SearchAgentStatusesCommandInput} for command's `input` shape.
+ * @see {@link SearchAgentStatusesCommandOutput} for command's `response` shape.
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>Request processing failed because of an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more of the specified parameters are not valid.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @throws {@link ConnectServiceException}
+ * <p>Base exception class for all service exceptions from Connect service.</p>
+ *
+ * @public
+ */
+export declare class SearchAgentStatusesCommand extends SearchAgentStatusesCommand_base {
+}

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

@@ -0,0 +1,181 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
+import { SearchUserHierarchyGroupsRequest, SearchUserHierarchyGroupsResponse } from "../models/models_2";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SearchUserHierarchyGroupsCommand}.
+ */
+export interface SearchUserHierarchyGroupsCommandInput extends SearchUserHierarchyGroupsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchUserHierarchyGroupsCommand}.
+ */
+export interface SearchUserHierarchyGroupsCommandOutput extends SearchUserHierarchyGroupsResponse, __MetadataBearer {
+}
+declare const SearchUserHierarchyGroupsCommand_base: {
+    new (input: SearchUserHierarchyGroupsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchUserHierarchyGroupsCommandInput, SearchUserHierarchyGroupsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SearchUserHierarchyGroupsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchUserHierarchyGroupsCommandInput, SearchUserHierarchyGroupsCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Searches UserHierarchyGroups in an Amazon Connect instance, with optional
+ *    filtering.</p>
+ *          <important>
+ *             <p>The UserHierarchyGroup with <code>"LevelId": "0"</code> is the foundation for building
+ *     levels on top of an instance. It is not user-definable, nor is it visible in the UI.</p>
+ *          </important>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectClient, SearchUserHierarchyGroupsCommand } from "@aws-sdk/client-connect"; // ES Modules import
+ * // const { ConnectClient, SearchUserHierarchyGroupsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
+ * const client = new ConnectClient(config);
+ * const input = { // SearchUserHierarchyGroupsRequest
+ *   InstanceId: "STRING_VALUE", // required
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   SearchFilter: { // UserHierarchyGroupSearchFilter
+ *     AttributeFilter: { // ControlPlaneAttributeFilter
+ *       OrConditions: [ // CommonAttributeOrConditionList
+ *         { // CommonAttributeAndCondition
+ *           TagConditions: [ // TagAndConditionList
+ *             { // TagCondition
+ *               TagKey: "STRING_VALUE",
+ *               TagValue: "STRING_VALUE",
+ *             },
+ *           ],
+ *         },
+ *       ],
+ *       AndCondition: {
+ *         TagConditions: [
+ *           {
+ *             TagKey: "STRING_VALUE",
+ *             TagValue: "STRING_VALUE",
+ *           },
+ *         ],
+ *       },
+ *       TagCondition: "<TagCondition>",
+ *     },
+ *   },
+ *   SearchCriteria: { // UserHierarchyGroupSearchCriteria
+ *     OrConditions: [ // UserHierarchyGroupSearchConditionList
+ *       {
+ *         OrConditions: [
+ *           "<UserHierarchyGroupSearchCriteria>",
+ *         ],
+ *         AndConditions: [
+ *           "<UserHierarchyGroupSearchCriteria>",
+ *         ],
+ *         StringCondition: { // StringCondition
+ *           FieldName: "STRING_VALUE",
+ *           Value: "STRING_VALUE",
+ *           ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
+ *         },
+ *       },
+ *     ],
+ *     AndConditions: [
+ *       "<UserHierarchyGroupSearchCriteria>",
+ *     ],
+ *     StringCondition: {
+ *       FieldName: "STRING_VALUE",
+ *       Value: "STRING_VALUE",
+ *       ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
+ *     },
+ *   },
+ * };
+ * const command = new SearchUserHierarchyGroupsCommand(input);
+ * const response = await client.send(command);
+ * // { // SearchUserHierarchyGroupsResponse
+ * //   UserHierarchyGroups: [ // UserHierarchyGroupList
+ * //     { // HierarchyGroup
+ * //       Id: "STRING_VALUE",
+ * //       Arn: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       LevelId: "STRING_VALUE",
+ * //       HierarchyPath: { // HierarchyPath
+ * //         LevelOne: { // HierarchyGroupSummary
+ * //           Id: "STRING_VALUE",
+ * //           Arn: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           LastModifiedTime: new Date("TIMESTAMP"),
+ * //           LastModifiedRegion: "STRING_VALUE",
+ * //         },
+ * //         LevelTwo: {
+ * //           Id: "STRING_VALUE",
+ * //           Arn: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           LastModifiedTime: new Date("TIMESTAMP"),
+ * //           LastModifiedRegion: "STRING_VALUE",
+ * //         },
+ * //         LevelThree: {
+ * //           Id: "STRING_VALUE",
+ * //           Arn: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           LastModifiedTime: new Date("TIMESTAMP"),
+ * //           LastModifiedRegion: "STRING_VALUE",
+ * //         },
+ * //         LevelFour: {
+ * //           Id: "STRING_VALUE",
+ * //           Arn: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           LastModifiedTime: new Date("TIMESTAMP"),
+ * //           LastModifiedRegion: "STRING_VALUE",
+ * //         },
+ * //         LevelFive: {
+ * //           Id: "STRING_VALUE",
+ * //           Arn: "STRING_VALUE",
+ * //           Name: "STRING_VALUE",
+ * //           LastModifiedTime: new Date("TIMESTAMP"),
+ * //           LastModifiedRegion: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       Tags: { // TagMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       LastModifiedTime: new Date("TIMESTAMP"),
+ * //       LastModifiedRegion: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   ApproximateTotalCount: Number("long"),
+ * // };
+ *
+ * ```
+ *
+ * @param SearchUserHierarchyGroupsCommandInput - {@link SearchUserHierarchyGroupsCommandInput}
+ * @returns {@link SearchUserHierarchyGroupsCommandOutput}
+ * @see {@link SearchUserHierarchyGroupsCommandInput} for command's `input` shape.
+ * @see {@link SearchUserHierarchyGroupsCommandOutput} for command's `response` shape.
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>Request processing failed because of an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more of the specified parameters are not valid.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @throws {@link ConnectServiceException}
+ * <p>Base exception class for all service exceptions from Connect service.</p>
+ *
+ * @public
+ */
+export declare class SearchUserHierarchyGroupsCommand extends SearchUserHierarchyGroupsCommand_base {
+}

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

@@ -95,16 +95,44 @@ declare const SearchUsersCommand_base: {
  *           Value: "STRING_VALUE",
  *           ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
  *         },
+ *         ListCondition: { // ListCondition
+ *           TargetListType: "PROFICIENCIES",
+ *           Conditions: [ // Conditions
+ *             { // Condition
+ *               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",
+ *               },
+ *             },
+ *           ],
+ *         },
  *         HierarchyGroupCondition: "<HierarchyGroupCondition>",
  *       },
  *     ],
  *     AndConditions: [
  *       "<UserSearchCriteria>",
  *     ],
- *     StringCondition: {
- *       FieldName: "STRING_VALUE",
- *       Value: "STRING_VALUE",
- *       ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT",
+ *     StringCondition: "<StringCondition>",
+ *     ListCondition: {
+ *       TargetListType: "PROFICIENCIES",
+ *       Conditions: [
+ *         {
+ *           StringCondition: "<StringCondition>",
+ *           NumberCondition: {
+ *             FieldName: "STRING_VALUE",
+ *             MinValue: Number("int"),
+ *             MaxValue: Number("int"),
+ *             ComparisonType: "GREATER_OR_EQUAL" || "GREATER" || "LESSER_OR_EQUAL" || "LESSER" || "EQUAL" || "NOT_EQUAL" || "RANGE",
+ *           },
+ *         },
+ *       ],
  *     },
  *     HierarchyGroupCondition: "<HierarchyGroupCondition>",
  *   },

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

@@ -171,6 +171,7 @@ export * from "./ReleasePhoneNumberCommand";
 export * from "./ReplicateInstanceCommand";
 export * from "./ResumeContactCommand";
 export * from "./ResumeContactRecordingCommand";
+export * from "./SearchAgentStatusesCommand";
 export * from "./SearchAvailablePhoneNumbersCommand";
 export * from "./SearchContactFlowModulesCommand";
 export * from "./SearchContactFlowsCommand";
@@ -183,6 +184,7 @@ export * from "./SearchQuickConnectsCommand";
 export * from "./SearchResourceTagsCommand";
 export * from "./SearchRoutingProfilesCommand";
 export * from "./SearchSecurityProfilesCommand";
+export * from "./SearchUserHierarchyGroupsCommand";
 export * from "./SearchUsersCommand";
 export * from "./SearchVocabulariesCommand";
 export * from "./SendChatIntegrationEventCommand";

package/dist-types/index.d.ts

@@ -2,14 +2,13 @@
  * <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect
- *        actions</a>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Service.html">Amazon Connect actions</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
  *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Service.html">Amazon Connect
- *        data types</a>
+ *       data types</a>
  *                </p>
  *             </li>
  *          </ul>