This API is in preview release for Amazon Connect and is subject to change.
- *Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can - * associate multiple datasets in a single call.
+ *Associates a list of analytics datasets for a given Amazon Connect instance to a target + * account. You can associate multiple datasets in a single call.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/DescribeContactCommand.ts b/clients/client-connect/src/commands/DescribeContactCommand.ts index e9ab39249fb6..806c1f607cf5 100644 --- a/clients/client-connect/src/commands/DescribeContactCommand.ts +++ b/clients/client-connect/src/commands/DescribeContactCommand.ts @@ -83,6 +83,9 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _ * // WisdomInfo: { // WisdomInfo * // SessionArn: "STRING_VALUE", * // }, + * // Tags: { // ContactTagMap + * // "Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed + * view of your Amazon Connect usage. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, TagContactCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, TagContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // TagContactRequest + * ContactId: "STRING_VALUE", // required + * InstanceId: "STRING_VALUE", // required + * Tags: { // ContactTagMap // required + * "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.
+ * + */ +export class TagContactCommand extends $Command< + TagContactCommandInput, + TagContactCommandOutput, + ConnectClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TagContactCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRemoves the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed + * view of your Amazon Connect usage.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, UntagContactCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, UntagContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // UntagContactRequest + * ContactId: "STRING_VALUE", // required + * InstanceId: "STRING_VALUE", // required + * TagKeys: [ // ContactTagKeys // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagContactCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagContactCommandInput - {@link UntagContactCommandInput} + * @returns {@link UntagContactCommandOutput} + * @see {@link UntagContactCommandInput} for command's `input` shape. + * @see {@link UntagContactCommandOutput} 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.
+ * + */ +export class UntagContactCommand extends $Command< + UntagContactCommandInput, + UntagContactCommandOutput, + ConnectClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UntagContactCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordA list of errors for datasets that aren't successfully associated - * with the target account.
+ *A list of errors for datasets that aren't successfully associated with the target + * account.
*/ Errors?: ErrorResult[]; } @@ -1838,7 +1838,7 @@ export interface ClaimPhoneNumberRequest { /** * @public - *The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
The tags used to organize, track, or control access for this resource. For example, \{
+ * "tags": \{"key1":"value1", "key2":"value2"\} \}.
The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}. Amazon Connect users with the specified tags will be notified.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}. Amazon Connect users with the specified tags will be notified.
*/ UserTags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordInformation about Amazon Connect Wisdom.
*/ WisdomInfo?: WisdomInfo; + + /** + * @public + *Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
+ */ + Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordAn array of successful results: DataSetId, TargetAccountId,
- * ResourceShareId, ResourceShareArn. This is a paginated API, so
- * nextToken is given if there are more results to be returned.
ResourceShareId, ResourceShareArn. This is a paginated API, so
+ * nextToken is given if there are more results to be returned.
*/
Results?: AnalyticsDataAssociationResult[];
@@ -8734,7 +8734,7 @@ export interface SecurityProfileSearchSummary {
/**
* @public
- * The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordEVENT.
* For allowed message content, see the Content parameter in the SendMessage topic
- * in the Amazon Connect Participant Service API Reference.
For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API
+ * Reference.
For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API
diff --git a/clients/client-connect/src/models/models_2.ts b/clients/client-connect/src/models/models_2.ts
index 0d3aa4ebaa58..9f47c08af6ab 100644
--- a/clients/client-connect/src/models/models_2.ts
+++ b/clients/client-connect/src/models/models_2.ts
@@ -125,8 +125,9 @@ export interface SendChatIntegrationEventRequest {
/**
* @public
*
Chat system identifier, used in part to uniquely identify chat. This is associated with the - * Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone - * number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.
+ * Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone + * number destination of inbound SMS messages represented by an Amazon Pinpoint phone number + * ARN. */ DestinationId: string | undefined; @@ -359,9 +360,10 @@ export interface StartChatContactRequest { *This field can be used to show channel subtype, such as connect:Guide.
The types application/vnd.amazonaws.connect.message.interactive and
- * application/vnd.amazonaws.connect.message.interactive.response must be present in the
- * SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as \{
- * "connect:Subtype": \{"valueString" : "connect:Guide" \}\}.
application/vnd.amazonaws.connect.message.interactive.response must be present in
+ * the SupportedMessagingContentTypes field of this API in order to set
+ * SegmentAttributes as \{ "connect:Subtype": \{"valueString" : "connect:Guide"
+ * \}\}.
* The identifier of the contact in this instance of Amazon Connect.
+ */ + ContactId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; + + /** + * @public + *The tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *Authorization is not supported by this tag.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ tags: RecordThe identifier of the contact in this instance of Amazon Connect.
+ */ + ContactId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; + + /** + * @public + *A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
+ */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagContactResponse {} + /** * @public */ @@ -3317,7 +3378,7 @@ export interface EvaluationForm { /** * @public - *The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordThe tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "LastModifiedTime": { @@ -1189,12 +1189,18 @@ { "target": "com.amazonaws.connect#SuspendContactRecording" }, + { + "target": "com.amazonaws.connect#TagContact" + }, { "target": "com.amazonaws.connect#TagResource" }, { "target": "com.amazonaws.connect#TransferContact" }, + { + "target": "com.amazonaws.connect#UntagContact" + }, { "target": "com.amazonaws.connect#UntagResource" }, @@ -3425,7 +3431,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nAssociates a list of analytics datasets for a given Amazon Connect instance to a target account. You can\n associate multiple datasets in a single call.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nAssociates a list of analytics datasets for a given Amazon Connect instance to a target\n account. You can associate multiple datasets in a single call.
", "smithy.api#http": { "method": "PUT", "uri": "/analytics-data/instance/{InstanceId}/associations", @@ -3474,7 +3480,7 @@ "Errors": { "target": "com.amazonaws.connect#ErrorResults", "traits": { - "smithy.api#documentation": "A list of errors for datasets that aren't successfully associated \n with the target account.
" + "smithy.api#documentation": "A list of errors for datasets that aren't successfully associated with the target\n account.
" } } }, @@ -3893,7 +3899,7 @@ "Content": { "target": "com.amazonaws.connect#ChatContent", "traits": { - "smithy.api#documentation": "Content of the message or event. This is required when Type is\n MESSAGE and for certain ContentTypes when Type is\n EVENT.
For allowed message content, see the Content parameter in the SendMessage topic\n in the Amazon Connect Participant Service API Reference.
For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API\n Reference.
Content of the message or event. This is required when Type is\n MESSAGE and for certain ContentTypes when Type is\n EVENT.
For allowed message content, see the Content parameter in the SendMessage topic in the Amazon Connect Participant Service API\n Reference.
For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API\n Reference.
The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "ClientToken": { @@ -4142,7 +4148,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "PhoneNumberStatus": { @@ -4318,6 +4324,12 @@ "traits": { "smithy.api#documentation": "Information about Amazon Connect Wisdom.
" } + }, + "Tags": { + "target": "com.amazonaws.connect#ContactTagMap", + "traits": { + "smithy.api#documentation": "Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
" + } } }, "traits": { @@ -4442,7 +4454,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -4513,7 +4525,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -4952,6 +4964,52 @@ } } }, + "com.amazonaws.connect#ContactTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.connect#ContactTagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.connect#ContactTagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#ContactTagKey" + }, + "value": { + "target": "com.amazonaws.connect#ContactTagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 6 + } + } + }, + "com.amazonaws.connect#ContactTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.connect#Content": { "type": "string", "traits": { @@ -5076,7 +5134,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -5230,7 +5288,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "ClientToken": { @@ -5306,7 +5364,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -5524,7 +5582,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -5631,7 +5689,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The tags used to organize, track, or control access for this resource. For example, {\n \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -6023,7 +6081,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -6144,7 +6202,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -6246,7 +6304,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -6362,7 +6420,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "AgentAvailabilityTimer": { @@ -6599,7 +6657,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "AllowedAccessControlTags": { @@ -6847,7 +6905,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -6938,7 +6996,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -7073,7 +7131,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -7167,7 +7225,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -7487,7 +7545,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -12163,7 +12221,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -12373,7 +12431,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -14645,7 +14703,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -14827,7 +14885,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "LastModifiedTime": { @@ -15475,7 +15533,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "LastModifiedTime": { @@ -15794,7 +15852,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "ClientToken": { @@ -16909,7 +16967,7 @@ "Results": { "target": "com.amazonaws.connect#AnalyticsDataAssociationResults", "traits": { - "smithy.api#documentation": "An array of successful results: DataSetId, TargetAccountId,\n ResourceShareId, ResourceShareArn. This is a paginated API, so\n nextToken is given if there are more results to be returned.
An array of successful results: DataSetId, TargetAccountId,\n ResourceShareId, ResourceShareArn. This is a paginated API, so\n nextToken is given if there are more results to be returned.
The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }. Amazon Connect users with the specified tags will be notified.
" } }, "UserIds": { @@ -23673,7 +23731,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "LastModifiedTime": { @@ -24047,7 +24105,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "LastModifiedTime": { @@ -24358,7 +24416,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "LastModifiedTime": { @@ -25909,7 +25967,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "NumberOfAssociatedQueues": { @@ -26303,7 +26361,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -27649,7 +27707,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "AllowedAccessControlTags": { @@ -27800,7 +27858,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } }, @@ -27963,7 +28021,7 @@ "DestinationId": { "target": "com.amazonaws.connect#DestinationId", "traits": { - "smithy.api#documentation": "Chat system identifier, used in part to uniquely identify chat. This is associated with the\n Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone\n number destination of inbound SMS messages represented by an Amazon Pinpoint phone number ARN.
", + "smithy.api#documentation": "Chat system identifier, used in part to uniquely identify chat. This is associated with the\n Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone\n number destination of inbound SMS messages represented by an Amazon Pinpoint phone number\n ARN.
", "smithy.api#required": {} } }, @@ -28331,7 +28389,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in\n flows.
\nAttribute keys can include only alphanumeric, -, and _.
\nThis field can be used to show channel subtype, such as connect:Guide.
The types application/vnd.amazonaws.connect.message.interactive and\n application/vnd.amazonaws.connect.message.interactive.response must be present in the\n SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as {\n \"connect:Subtype\": {\"valueString\" : \"connect:Guide\" }}.
A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in\n flows.
\nAttribute keys can include only alphanumeric, -, and _.
\nThis field can be used to show channel subtype, such as connect:Guide.
The types application/vnd.amazonaws.connect.message.interactive and\n application/vnd.amazonaws.connect.message.interactive.response must be present in\n the SupportedMessagingContentTypes field of this API in order to set\n SegmentAttributes as { \"connect:Subtype\": {\"valueString\" : \"connect:Guide\"\n }}.
A leaf node condition which can be used to specify a tag condition, for example, HAVE\n BPO = 123.
Adds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed\n view of your Amazon Connect usage.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/tags", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#TagContactRequest": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "The identifier of the contact in this instance of Amazon Connect.
", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#ContactTagMap", + "traits": { + "smithy.api#documentation": "The tags to be assigned to the contact resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
\nAuthorization is not supported by this tag.
\nThe tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
", "smithy.api#required": {} } } @@ -30357,7 +30486,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "IsDefault": { @@ -30671,6 +30800,80 @@ } } }, + "com.amazonaws.connect#UntagContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UntagContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#UntagContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed\n view of your Amazon Connect usage.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/contact/tags/{InstanceId}/{ContactId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#UntagContactRequest": { + "type": "structure", + "members": { + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "The identifier of the contact in this instance of Amazon Connect.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.connect#ContactTagKeys", + "traits": { + "smithy.api#documentation": "A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
", + "smithy.api#httpQuery": "TagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#UntagContactResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#UntagResource": { "type": "operation", "input": { @@ -34690,7 +34893,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } }, "Username": { @@ -35223,7 +35426,7 @@ "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } } },