-
Notifications
You must be signed in to change notification settings - Fork 586
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-connect): Amazon Connect provides enhanced search capabil…
…ities for flows & flow modules on the Connect admin website and programmatically using APIs. You can search for flows and flow modules by name, description, type, status, and tags, to filter and identify a specific flow in your Connect instances.
- Loading branch information
awstools
committed
May 14, 2024
1 parent
31ce1e9
commit 43f9444
Showing
21 changed files
with
1,586 additions
and
281 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
157 changes: 157 additions & 0 deletions
157
clients/client-connect/src/commands/SearchContactFlowModulesCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,157 @@ | ||
// smithy-typescript generated code | ||
import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
import { Command as $Command } from "@smithy/smithy-client"; | ||
import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
||
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; | ||
import { commonParams } from "../endpoint/EndpointParameters"; | ||
import { SearchContactFlowModulesRequest, SearchContactFlowModulesResponse } from "../models/models_2"; | ||
import { de_SearchContactFlowModulesCommand, se_SearchContactFlowModulesCommand } from "../protocols/Aws_restJson1"; | ||
|
||
/** | ||
* @public | ||
*/ | ||
export { __MetadataBearer, $Command }; | ||
/** | ||
* @public | ||
* | ||
* The input for {@link SearchContactFlowModulesCommand}. | ||
*/ | ||
export interface SearchContactFlowModulesCommandInput extends SearchContactFlowModulesRequest {} | ||
/** | ||
* @public | ||
* | ||
* The output of {@link SearchContactFlowModulesCommand}. | ||
*/ | ||
export interface SearchContactFlowModulesCommandOutput extends SearchContactFlowModulesResponse, __MetadataBearer {} | ||
|
||
/** | ||
* <p>Searches the flow modules 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, SearchContactFlowModulesCommand } from "@aws-sdk/client-connect"; // ES Modules import | ||
* // const { ConnectClient, SearchContactFlowModulesCommand } = require("@aws-sdk/client-connect"); // CommonJS import | ||
* const client = new ConnectClient(config); | ||
* const input = { // SearchContactFlowModulesRequest | ||
* InstanceId: "STRING_VALUE", // required | ||
* NextToken: "STRING_VALUE", | ||
* MaxResults: Number("int"), | ||
* SearchFilter: { // ContactFlowModuleSearchFilter | ||
* TagFilter: { // ControlPlaneTagFilter | ||
* OrConditions: [ // TagOrConditionList | ||
* [ // TagAndConditionList | ||
* { // TagCondition | ||
* TagKey: "STRING_VALUE", | ||
* TagValue: "STRING_VALUE", | ||
* }, | ||
* ], | ||
* ], | ||
* AndConditions: [ | ||
* { | ||
* TagKey: "STRING_VALUE", | ||
* TagValue: "STRING_VALUE", | ||
* }, | ||
* ], | ||
* TagCondition: "<TagCondition>", | ||
* }, | ||
* }, | ||
* SearchCriteria: { // ContactFlowModuleSearchCriteria | ||
* OrConditions: [ // ContactFlowModuleSearchConditionList | ||
* { | ||
* OrConditions: [ | ||
* "<ContactFlowModuleSearchCriteria>", | ||
* ], | ||
* AndConditions: [ | ||
* "<ContactFlowModuleSearchCriteria>", | ||
* ], | ||
* StringCondition: { // StringCondition | ||
* FieldName: "STRING_VALUE", | ||
* Value: "STRING_VALUE", | ||
* ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", | ||
* }, | ||
* }, | ||
* ], | ||
* AndConditions: [ | ||
* "<ContactFlowModuleSearchCriteria>", | ||
* ], | ||
* StringCondition: { | ||
* FieldName: "STRING_VALUE", | ||
* Value: "STRING_VALUE", | ||
* ComparisonType: "STARTS_WITH" || "CONTAINS" || "EXACT", | ||
* }, | ||
* }, | ||
* }; | ||
* const command = new SearchContactFlowModulesCommand(input); | ||
* const response = await client.send(command); | ||
* // { // SearchContactFlowModulesResponse | ||
* // ContactFlowModules: [ // ContactFlowModuleSearchSummaryList | ||
* // { // ContactFlowModule | ||
* // Arn: "STRING_VALUE", | ||
* // Id: "STRING_VALUE", | ||
* // Name: "STRING_VALUE", | ||
* // Content: "STRING_VALUE", | ||
* // Description: "STRING_VALUE", | ||
* // State: "ACTIVE" || "ARCHIVED", | ||
* // Status: "PUBLISHED" || "SAVED", | ||
* // Tags: { // TagMap | ||
* // "<keys>": "STRING_VALUE", | ||
* // }, | ||
* // }, | ||
* // ], | ||
* // NextToken: "STRING_VALUE", | ||
* // ApproximateTotalCount: Number("long"), | ||
* // }; | ||
* | ||
* ``` | ||
* | ||
* @param SearchContactFlowModulesCommandInput - {@link SearchContactFlowModulesCommandInput} | ||
* @returns {@link SearchContactFlowModulesCommandOutput} | ||
* @see {@link SearchContactFlowModulesCommandInput} for command's `input` shape. | ||
* @see {@link SearchContactFlowModulesCommandOutput} 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 class SearchContactFlowModulesCommand extends $Command | ||
.classBuilder< | ||
SearchContactFlowModulesCommandInput, | ||
SearchContactFlowModulesCommandOutput, | ||
ConnectClientResolvedConfig, | ||
ServiceInputTypes, | ||
ServiceOutputTypes | ||
>() | ||
.ep({ | ||
...commonParams, | ||
}) | ||
.m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { | ||
return [ | ||
getSerdePlugin(config, this.serialize, this.deserialize), | ||
getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
]; | ||
}) | ||
.s("AmazonConnectService", "SearchContactFlowModules", {}) | ||
.n("ConnectClient", "SearchContactFlowModulesCommand") | ||
.f(void 0, void 0) | ||
.ser(se_SearchContactFlowModulesCommand) | ||
.de(de_SearchContactFlowModulesCommand) | ||
.build() {} |
Oops, something went wrong.