|
| 1 | +// smithy-typescript generated code |
| 2 | +import { EndpointParameterInstructions, getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http"; |
| 5 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 6 | +import { |
| 7 | + FinalizeHandlerArguments, |
| 8 | + Handler, |
| 9 | + HandlerExecutionContext, |
| 10 | + HttpHandlerOptions as __HttpHandlerOptions, |
| 11 | + MetadataBearer as __MetadataBearer, |
| 12 | + MiddlewareStack, |
| 13 | + SerdeContext as __SerdeContext, |
| 14 | + SMITHY_CONTEXT_KEY, |
| 15 | +} from "@smithy/types"; |
| 16 | + |
| 17 | +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; |
| 18 | +import { TagContactRequest, TagContactResponse } from "../models/models_2"; |
| 19 | +import { de_TagContactCommand, se_TagContactCommand } from "../protocols/Aws_restJson1"; |
| 20 | + |
| 21 | +/** |
| 22 | + * @public |
| 23 | + */ |
| 24 | +export { __MetadataBearer, $Command }; |
| 25 | +/** |
| 26 | + * @public |
| 27 | + * |
| 28 | + * The input for {@link TagContactCommand}. |
| 29 | + */ |
| 30 | +export interface TagContactCommandInput extends TagContactRequest {} |
| 31 | +/** |
| 32 | + * @public |
| 33 | + * |
| 34 | + * The output of {@link TagContactCommand}. |
| 35 | + */ |
| 36 | +export interface TagContactCommandOutput extends TagContactResponse, __MetadataBearer {} |
| 37 | + |
| 38 | +/** |
| 39 | + * @public |
| 40 | + * <p>Adds the specified tags to the contact resource. For more information about this API is used, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html">Set up granular billing for a detailed |
| 41 | + * view of your Amazon Connect usage</a>. |
| 42 | + * </p> |
| 43 | + * @example |
| 44 | + * Use a bare-bones client and the command you need to make an API call. |
| 45 | + * ```javascript |
| 46 | + * import { ConnectClient, TagContactCommand } from "@aws-sdk/client-connect"; // ES Modules import |
| 47 | + * // const { ConnectClient, TagContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import |
| 48 | + * const client = new ConnectClient(config); |
| 49 | + * const input = { // TagContactRequest |
| 50 | + * ContactId: "STRING_VALUE", // required |
| 51 | + * InstanceId: "STRING_VALUE", // required |
| 52 | + * Tags: { // ContactTagMap // required |
| 53 | + * "<keys>": "STRING_VALUE", |
| 54 | + * }, |
| 55 | + * }; |
| 56 | + * const command = new TagContactCommand(input); |
| 57 | + * const response = await client.send(command); |
| 58 | + * // {}; |
| 59 | + * |
| 60 | + * ``` |
| 61 | + * |
| 62 | + * @param TagContactCommandInput - {@link TagContactCommandInput} |
| 63 | + * @returns {@link TagContactCommandOutput} |
| 64 | + * @see {@link TagContactCommandInput} for command's `input` shape. |
| 65 | + * @see {@link TagContactCommandOutput} for command's `response` shape. |
| 66 | + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. |
| 67 | + * |
| 68 | + * @throws {@link InternalServiceException} (server fault) |
| 69 | + * <p>Request processing failed because of an error or failure with the service.</p> |
| 70 | + * |
| 71 | + * @throws {@link InvalidParameterException} (client fault) |
| 72 | + * <p>One or more of the specified parameters are not valid.</p> |
| 73 | + * |
| 74 | + * @throws {@link InvalidRequestException} (client fault) |
| 75 | + * <p>The request is not valid.</p> |
| 76 | + * |
| 77 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 78 | + * <p>The specified resource was not found.</p> |
| 79 | + * |
| 80 | + * @throws {@link ThrottlingException} (client fault) |
| 81 | + * <p>The throttling limit has been exceeded.</p> |
| 82 | + * |
| 83 | + * @throws {@link ConnectServiceException} |
| 84 | + * <p>Base exception class for all service exceptions from Connect service.</p> |
| 85 | + * |
| 86 | + */ |
| 87 | +export class TagContactCommand extends $Command< |
| 88 | + TagContactCommandInput, |
| 89 | + TagContactCommandOutput, |
| 90 | + ConnectClientResolvedConfig |
| 91 | +> { |
| 92 | + public static getEndpointParameterInstructions(): EndpointParameterInstructions { |
| 93 | + return { |
| 94 | + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, |
| 95 | + Endpoint: { type: "builtInParams", name: "endpoint" }, |
| 96 | + Region: { type: "builtInParams", name: "region" }, |
| 97 | + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, |
| 98 | + }; |
| 99 | + } |
| 100 | + |
| 101 | + /** |
| 102 | + * @public |
| 103 | + */ |
| 104 | + constructor(readonly input: TagContactCommandInput) { |
| 105 | + super(); |
| 106 | + } |
| 107 | + |
| 108 | + /** |
| 109 | + * @internal |
| 110 | + */ |
| 111 | + resolveMiddleware( |
| 112 | + clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, |
| 113 | + configuration: ConnectClientResolvedConfig, |
| 114 | + options?: __HttpHandlerOptions |
| 115 | + ): Handler<TagContactCommandInput, TagContactCommandOutput> { |
| 116 | + this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); |
| 117 | + this.middlewareStack.use(getEndpointPlugin(configuration, TagContactCommand.getEndpointParameterInstructions())); |
| 118 | + |
| 119 | + const stack = clientStack.concat(this.middlewareStack); |
| 120 | + |
| 121 | + const { logger } = configuration; |
| 122 | + const clientName = "ConnectClient"; |
| 123 | + const commandName = "TagContactCommand"; |
| 124 | + const handlerExecutionContext: HandlerExecutionContext = { |
| 125 | + logger, |
| 126 | + clientName, |
| 127 | + commandName, |
| 128 | + inputFilterSensitiveLog: (_: any) => _, |
| 129 | + outputFilterSensitiveLog: (_: any) => _, |
| 130 | + [SMITHY_CONTEXT_KEY]: { |
| 131 | + service: "AmazonConnectService", |
| 132 | + operation: "TagContact", |
| 133 | + }, |
| 134 | + }; |
| 135 | + const { requestHandler } = configuration; |
| 136 | + return stack.resolve( |
| 137 | + (request: FinalizeHandlerArguments<any>) => |
| 138 | + requestHandler.handle(request.request as __HttpRequest, options || {}), |
| 139 | + handlerExecutionContext |
| 140 | + ); |
| 141 | + } |
| 142 | + |
| 143 | + /** |
| 144 | + * @internal |
| 145 | + */ |
| 146 | + private serialize(input: TagContactCommandInput, context: __SerdeContext): Promise<__HttpRequest> { |
| 147 | + return se_TagContactCommand(input, context); |
| 148 | + } |
| 149 | + |
| 150 | + /** |
| 151 | + * @internal |
| 152 | + */ |
| 153 | + private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<TagContactCommandOutput> { |
| 154 | + return de_TagContactCommand(output, context); |
| 155 | + } |
| 156 | +} |
0 commit comments