|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { |
| 10 | + UpdateParticipantAuthenticationRequest, |
| 11 | + UpdateParticipantAuthenticationRequestFilterSensitiveLog, |
| 12 | + UpdateParticipantAuthenticationResponse, |
| 13 | +} from "../models/models_2"; |
| 14 | +import { |
| 15 | + de_UpdateParticipantAuthenticationCommand, |
| 16 | + se_UpdateParticipantAuthenticationCommand, |
| 17 | +} from "../protocols/Aws_restJson1"; |
| 18 | + |
| 19 | +/** |
| 20 | + * @public |
| 21 | + */ |
| 22 | +export type { __MetadataBearer }; |
| 23 | +export { $Command }; |
| 24 | +/** |
| 25 | + * @public |
| 26 | + * |
| 27 | + * The input for {@link UpdateParticipantAuthenticationCommand}. |
| 28 | + */ |
| 29 | +export interface UpdateParticipantAuthenticationCommandInput extends UpdateParticipantAuthenticationRequest {} |
| 30 | +/** |
| 31 | + * @public |
| 32 | + * |
| 33 | + * The output of {@link UpdateParticipantAuthenticationCommand}. |
| 34 | + */ |
| 35 | +export interface UpdateParticipantAuthenticationCommandOutput |
| 36 | + extends UpdateParticipantAuthenticationResponse, |
| 37 | + __MetadataBearer {} |
| 38 | + |
| 39 | +/** |
| 40 | + * <p>Instructs Amazon Connect to resume the authentication process. The subsequent actions |
| 41 | + * depend on the request body contents:</p> |
| 42 | + * <ul> |
| 43 | + * <li> |
| 44 | + * <p> |
| 45 | + * <b>If a code is provided</b>: Connect retrieves the identity |
| 46 | + * information from Amazon Cognito and imports it into Connect Customer Profiles.</p> |
| 47 | + * </li> |
| 48 | + * <li> |
| 49 | + * <p> |
| 50 | + * <b>If an error is provided</b>: The error branch of the |
| 51 | + * Authenticate Customer block is executed.</p> |
| 52 | + * </li> |
| 53 | + * </ul> |
| 54 | + * <note> |
| 55 | + * <p>The API returns a success response to acknowledge the request. However, the interaction and |
| 56 | + * exchange of identity information occur asynchronously after the response is returned.</p> |
| 57 | + * </note> |
| 58 | + * @example |
| 59 | + * Use a bare-bones client and the command you need to make an API call. |
| 60 | + * ```javascript |
| 61 | + * import { ConnectClient, UpdateParticipantAuthenticationCommand } from "@aws-sdk/client-connect"; // ES Modules import |
| 62 | + * // const { ConnectClient, UpdateParticipantAuthenticationCommand } = require("@aws-sdk/client-connect"); // CommonJS import |
| 63 | + * const client = new ConnectClient(config); |
| 64 | + * const input = { // UpdateParticipantAuthenticationRequest |
| 65 | + * State: "STRING_VALUE", // required |
| 66 | + * InstanceId: "STRING_VALUE", // required |
| 67 | + * Code: "STRING_VALUE", |
| 68 | + * Error: "STRING_VALUE", |
| 69 | + * ErrorDescription: "STRING_VALUE", |
| 70 | + * }; |
| 71 | + * const command = new UpdateParticipantAuthenticationCommand(input); |
| 72 | + * const response = await client.send(command); |
| 73 | + * // {}; |
| 74 | + * |
| 75 | + * ``` |
| 76 | + * |
| 77 | + * @param UpdateParticipantAuthenticationCommandInput - {@link UpdateParticipantAuthenticationCommandInput} |
| 78 | + * @returns {@link UpdateParticipantAuthenticationCommandOutput} |
| 79 | + * @see {@link UpdateParticipantAuthenticationCommandInput} for command's `input` shape. |
| 80 | + * @see {@link UpdateParticipantAuthenticationCommandOutput} for command's `response` shape. |
| 81 | + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. |
| 82 | + * |
| 83 | + * @throws {@link AccessDeniedException} (client fault) |
| 84 | + * <p>You do not have sufficient permissions to perform this action.</p> |
| 85 | + * |
| 86 | + * @throws {@link ConflictException} (client fault) |
| 87 | + * <p>Operation cannot be performed at this time as there is a conflict with another operation or |
| 88 | + * contact state.</p> |
| 89 | + * |
| 90 | + * @throws {@link InternalServiceException} (server fault) |
| 91 | + * <p>Request processing failed because of an error or failure with the service.</p> |
| 92 | + * |
| 93 | + * @throws {@link InvalidParameterException} (client fault) |
| 94 | + * <p>One or more of the specified parameters are not valid.</p> |
| 95 | + * |
| 96 | + * @throws {@link InvalidRequestException} (client fault) |
| 97 | + * <p>The request is not valid.</p> |
| 98 | + * |
| 99 | + * @throws {@link ThrottlingException} (client fault) |
| 100 | + * <p>The throttling limit has been exceeded.</p> |
| 101 | + * |
| 102 | + * @throws {@link ConnectServiceException} |
| 103 | + * <p>Base exception class for all service exceptions from Connect service.</p> |
| 104 | + * |
| 105 | + * @public |
| 106 | + */ |
| 107 | +export class UpdateParticipantAuthenticationCommand extends $Command |
| 108 | + .classBuilder< |
| 109 | + UpdateParticipantAuthenticationCommandInput, |
| 110 | + UpdateParticipantAuthenticationCommandOutput, |
| 111 | + ConnectClientResolvedConfig, |
| 112 | + ServiceInputTypes, |
| 113 | + ServiceOutputTypes |
| 114 | + >() |
| 115 | + .ep(commonParams) |
| 116 | + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { |
| 117 | + return [ |
| 118 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 119 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 120 | + ]; |
| 121 | + }) |
| 122 | + .s("AmazonConnectService", "UpdateParticipantAuthentication", {}) |
| 123 | + .n("ConnectClient", "UpdateParticipantAuthenticationCommand") |
| 124 | + .f(UpdateParticipantAuthenticationRequestFilterSensitiveLog, void 0) |
| 125 | + .ser(se_UpdateParticipantAuthenticationCommand) |
| 126 | + .de(de_UpdateParticipantAuthenticationCommand) |
| 127 | + .build() { |
| 128 | + /** @internal type navigation helper, not in runtime. */ |
| 129 | + protected declare static __types: { |
| 130 | + api: { |
| 131 | + input: UpdateParticipantAuthenticationRequest; |
| 132 | + output: {}; |
| 133 | + }; |
| 134 | + sdk: { |
| 135 | + input: UpdateParticipantAuthenticationCommandInput; |
| 136 | + output: UpdateParticipantAuthenticationCommandOutput; |
| 137 | + }; |
| 138 | + }; |
| 139 | +} |
0 commit comments