|
7184 | 7184 | } |
7185 | 7185 | ], |
7186 | 7186 | "traits": { |
7187 | | - "smithy.api#documentation": "<p>Creates a new contact.</p>", |
| 7187 | + "smithy.api#documentation": "<important>\n <p>Only the EMAIL channel is supported. The supported initiation\n methods are: OUTBOUND, AGENT_REPLY, and FLOW.</p>\n </important>\n <p>Creates a new EMAIL contact. </p>", |
7188 | 7188 | "smithy.api#http": { |
7189 | 7189 | "method": "PUT", |
7190 | 7190 | "uri": "/contact/create-contact", |
|
7586 | 7586 | "Channel": { |
7587 | 7587 | "target": "com.amazonaws.connect#Channel", |
7588 | 7588 | "traits": { |
7589 | | - "smithy.api#documentation": "<p>The channel for the contact</p>", |
| 7589 | + "smithy.api#documentation": "<p>The channel for the contact</p>\n <important>\n <p>CreateContact only supports the EMAIL channel. The following information that states other\n channels are supported is incorrect. We are working to update this topic.</p>\n </important>", |
7590 | 7590 | "smithy.api#required": {} |
7591 | 7591 | } |
7592 | 7592 | }, |
7593 | 7593 | "InitiationMethod": { |
7594 | 7594 | "target": "com.amazonaws.connect#ContactInitiationMethod", |
7595 | 7595 | "traits": { |
7596 | | - "smithy.api#documentation": "<p>Indicates how the contact was initiated.</p>", |
| 7596 | + "smithy.api#documentation": "<p>Indicates how the contact was initiated. </p>\n <important>\n <p>CreateContact only supports the following initiation methods: OUTBOUND, AGENT_REPLY, and\n FLOW. The following information that states other initiation methods are supported is incorrect. We are\n working to update this topic.</p>\n </important>", |
7597 | 7597 | "smithy.api#required": {} |
7598 | 7598 | } |
7599 | 7599 | }, |
|
9342 | 9342 | "TagRestrictedResources": { |
9343 | 9343 | "target": "com.amazonaws.connect#TagRestrictedResourceList", |
9344 | 9344 | "traits": { |
9345 | | - "smithy.api#documentation": "<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code> |\n <code>SecurityProfile</code> | <code>Queue</code> | <code>RoutingProfile</code>\n </p>" |
| 9345 | + "smithy.api#documentation": "<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see\n <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html\">Add tags to resources\n in Amazon Connect</a> in the <i>Amazon Connect Administrator\n Guide</i>. </p>" |
9346 | 9346 | } |
9347 | 9347 | }, |
9348 | 9348 | "Applications": { |
|
27449 | 27449 | "UserIds": { |
27450 | 27450 | "target": "com.amazonaws.connect#UserIdList", |
27451 | 27451 | "traits": { |
27452 | | - "smithy.api#documentation": "<p>A list of user IDs.</p>" |
| 27452 | + "smithy.api#documentation": "<p>A list of user IDs. Supports variable injection of\n <code>$.ContactLens.ContactEvaluation.Agent.AgentId</code> for\n <code>OnContactEvaluationSubmit</code> event source. </p>" |
27453 | 27453 | } |
27454 | 27454 | } |
27455 | 27455 | }, |
|
35185 | 35185 | "ResourceTypes": { |
35186 | 35186 | "target": "com.amazonaws.connect#ResourceTypeList", |
35187 | 35187 | "traits": { |
35188 | | - "smithy.api#documentation": "<p>The list of resource types to be used to search tags from. If not provided or if any empty\n list is provided, this API will search from all supported resource types.</p>\n <p class=\"title\">\n <b>Supported resource types</b>\n </p>\n <ul>\n <li>\n <p>AGENT</p>\n </li>\n <li>\n <p>ROUTING_PROFILE</p>\n </li>\n <li>\n <p>STANDARD_QUEUE</p>\n </li>\n <li>\n <p>SECURITY_PROFILE</p>\n </li>\n <li>\n <p>OPERATING_HOURS</p>\n </li>\n <li>\n <p>PROMPT</p>\n </li>\n <li>\n <p>CONTACT_FLOW</p>\n </li>\n <li>\n <p>FLOW_MODULE</p>\n </li>\n </ul>" |
| 35188 | + "smithy.api#documentation": "<p>The list of resource types to be used to search tags from. If not provided or if any empty\n list is provided, this API will search from all supported resource types. Note that lowercase and\n - are required.</p>\n <p class=\"title\">\n <b>Supported resource types</b>\n </p>\n <ul>\n <li>\n <p>agent</p>\n </li>\n <li>\n <p>agent-state</p>\n </li>\n <li>\n <p>routing-profile</p>\n </li>\n <li>\n <p>standard-queue</p>\n </li>\n <li>\n <p>security-profile</p>\n </li>\n <li>\n <p>operating-hours</p>\n </li>\n <li>\n <p>prompt</p>\n </li>\n <li>\n <p>contact-flow</p>\n </li>\n <li>\n <p>flow- module</p>\n </li>\n <li>\n <p>transfer-destination (also known as quick connect)</p>\n </li>\n </ul>" |
35189 | 35189 | } |
35190 | 35190 | }, |
35191 | 35191 | "NextToken": { |
|
35614 | 35614 | "InstanceId": { |
35615 | 35615 | "target": "com.amazonaws.connect#InstanceId", |
35616 | 35616 | "traits": { |
35617 | | - "smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>\n <note>\n <p>InstanceID is a required field. The \"Required: No\" below is incorrect.</p>\n </note>", |
| 35617 | + "smithy.api#documentation": "<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", |
35618 | 35618 | "smithy.api#required": {} |
35619 | 35619 | } |
35620 | 35620 | }, |
|
40686 | 40686 | "Attributes": { |
40687 | 40687 | "target": "com.amazonaws.connect#Attributes", |
40688 | 40688 | "traits": { |
40689 | | - "smithy.api#documentation": "<p>The Amazon Connect attributes. These attributes can be accessed in flows just like any\n other contact attributes.</p>\n <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.</p>\n <p>When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch\n of the flow. As a mitigation, consider the following options:</p>\n <ul>\n <li>\n <p>Remove unnecessary attributes by setting their values to empty.</p>\n </li>\n <li>\n <p>If the attributes are only used in one flow and don't need to be referred to outside of\n that flow (for example, by a Lambda or another flow), then use flow attributes. This way you\n aren't needlessly persisting the 32 KB of information from one flow to another. For more\n information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Flow block: Set contact\n attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </p>\n </li>\n </ul>", |
| 40689 | + "smithy.api#documentation": "<p>The Amazon Connect attributes. These attributes can be accessed in flows just like any\n other contact attributes.</p>\n <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.</p>\n <p>In the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Set contact attributes</a>\n block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error\n branch of the flow. As a mitigation, consider the following options:</p>\n <ul>\n <li>\n <p>Remove unnecessary attributes by setting their values to empty.</p>\n </li>\n <li>\n <p>If the attributes are only used in one flow and don't need to be referred to outside of\n that flow (for example, by a Lambda or another flow), then use flow attributes. This way you\n aren't needlessly persisting the 32 KB of information from one flow to another. For more\n information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Flow block: Set contact\n attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </p>\n </li>\n </ul>", |
40690 | 40690 | "smithy.api#required": {} |
40691 | 40691 | } |
40692 | 40692 | } |
|
43806 | 43806 | } |
43807 | 43807 | ], |
43808 | 43808 | "traits": { |
43809 | | - "smithy.api#documentation": "<p>Updates the traffic distribution for a given traffic distribution group. </p>\n <note>\n <p>The <code>SignInConfig</code> distribution is available only on a \ndefault <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the \n<a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a>\n data type). If you call\n <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>,\n an <code>InvalidRequestException</code> is returned.</p>\n </note>\n <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony\n traffic distribution across Amazon Web Services Regions\n </a> in the <i>Amazon Connect Administrator Guide</i>. </p>", |
| 43809 | + "smithy.api#documentation": "<p>Updates the traffic distribution for a given traffic distribution group. </p>\n <important>\n <p>When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they\n can handle the calls in the other Region. If you don't shift the agents, voice calls will go to\n the shifted Region but there won't be any agents available to receive the calls.</p>\n </important>\n <note>\n <p>The <code>SignInConfig</code> distribution is available only on a \ndefault <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the \n<a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a>\n data type). If you call\n <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>,\n an <code>InvalidRequestException</code> is returned.</p>\n </note>\n <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony\n traffic distribution across Amazon Web Services Regions\n </a> in the <i>Amazon Connect Administrator Guide</i>. </p>", |
43810 | 43810 | "smithy.api#http": { |
43811 | 43811 | "method": "PUT", |
43812 | 43812 | "uri": "/traffic-distribution/{Id}", |
|
0 commit comments