AWS connect documentation change
Summary
Restructured metric documentation with added details about metric types, categories, API access methods, and availability dates. Improved formatting with bullet points and section headers.
Security assessment
Changes focus on documentation organization and metric specification enhancements without mentioning security vulnerabilities, patches, or security controls. While some metrics relate to call handling (e.g., answering machine detection), there's no explicit security context or new security features documented.
Diff
diff --git a/connect/latest/adminguide/outbound-campaign-metrics.md b/connect/latest/adminguide/outbound-campaign-metrics.md index 67a9d45d5..dab5182ad 100644 --- a//connect/latest/adminguide/outbound-campaign-metrics.md +++ b//connect/latest/adminguide/outbound-campaign-metrics.md @@ -15 +15 @@ Also check out the [outbound campaigns performance dashboard](./outbound-campaig -The average number of outbound campaign dials per minute for the specified start time and end time. +This metric measures the average number of outbound campaign dials per minute for the specified start time and end time. @@ -17 +17 @@ The average number of outbound campaign dials per minute for the specified start -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AVG_DIALS_PER_MINUTE`. +**Metric type** : Double @@ -19 +19 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -###### Note +**Metric category** : Outbound campaigns driven metric @@ -21 +21,12 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes. +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `AVG_DIALS_PER_MINUTE` + + + + +**Notes** : + + * This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes. + + * Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -23 +33,0 @@ This metric is available only for outbound campaigns that use the agent assisted -Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -25 +34,0 @@ Data for this metric is available starting from June 25, 2024 0:00:00 GMT. -Type: Double @@ -27 +35,0 @@ Type: Double -Category: Outbound campaigns driven metric @@ -31 +39,5 @@ Category: Outbound campaigns driven metric -The average duration of total wait time by the customer after they answer the outbound call through the Amazon Connect dialer. +This metric measures the average duration of total wait time by the customer after they answer the outbound call through the Amazon Connect dialer. + +**Metric type** : String (_hh:mm:ss_) + +**Metric category** : Outbound campaigns driven metric @@ -33 +45 @@ The average duration of total wait time by the customer after they answer the ou -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION`. +**How to access using the Amazon Connect API** : @@ -35 +47 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -###### Note + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION` @@ -37 +48,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes. @@ -39 +49,0 @@ This metric is available only for outbound campaigns that use the agent assisted -Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -41 +50,0 @@ Data for this metric is available starting from June 25, 2024 0:00:00 GMT. -Type: String (_hh:mm:ss_) @@ -43 +52,8 @@ Type: String (_hh:mm:ss_) -Category: Outbound campaigns driven metric +**Notes** : + + * This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes. + + * Data for this metric is available starting from June 25, 2024 0:00:00 GMT. + + + @@ -47 +63,7 @@ Category: Outbound campaigns driven metric -The count of outbound campaign calls that were connected to a live customer but did not get connected to an agent within X seconds. The possible values for X are from 1 to 604800 inclusive. This metric is only available with answering machine detection enabled. For more information about answering machine detection, see [Best practices for answering machine detection](./campaign-best-practices.html#machine-detection). +This metric counts the outbound campaign calls that were connected to a live customer but did not get connected to an agent within X seconds. The possible values for X are from 1 to 604800 inclusive. This metric is only available with answering machine detection enabled. For more information about answering machine detection, see [Best practices for answering machine detection](./campaign-best-practices.html#machine-detection). + +**Metric type** : Integer + +**Metric category** : Outbound campaigns driven metric + +**How to access using the Amazon Connect API** : @@ -49 +71 @@ The count of outbound campaign calls that were connected to a live customer but -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `CAMPAIGN_CONTACTS_ABANDONED_AFTER_X`. + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `CAMPAIGN_CONTACTS_ABANDONED_AFTER_X` @@ -51 +72,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -###### Note @@ -53 +73,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes. @@ -55 +74,0 @@ This metric is available only for outbound campaigns using the agent assisted vo -Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -57 +76,7 @@ Data for this metric is available starting from June 25, 2024 0:00:00 GMT. -Type: Integer +**Notes** : + + * This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes. + + * Data for this metric is available starting from June 25, 2024 0:00:00 GMT. + + @@ -59 +83,0 @@ Type: Integer -Category: Outbound campaigns driven metric @@ -63 +87,10 @@ Category: Outbound campaigns driven metric -The percentage of outbound campaign calls that were connected to a live customer but did not get connected to an agent within X seconds divided by the count of contacts connected to a live customer in an outbound campaign. The possible values for X are from 1 to 604800 inclusive. This metric is only available with answering machine detection enabled. +This metric measures the percentage of outbound campaign calls that were connected to a live customer but did not get connected to an agent within X seconds divided by the count of contacts connected to a live customer in an outbound campaign. The possible values for X are from 1 to 604800 inclusive. + +**Metric type** : Percent + +**Metric category** : Outbound campaigns driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE` + @@ -65 +97,0 @@ The percentage of outbound campaign calls that were connected to a live customer -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE`. @@ -67 +98,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -###### Note @@ -69 +100,5 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes. +**Notes** : + + * This metric is only available with answering machine detection enabled. For more information about answering machine detection, see [Best practices for answering machine detection](./campaign-best-practices.html#machine-detection). This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes. + + * Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -71 +105,0 @@ This metric is available only for outbound campaigns using the agent assisted vo -Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -73 +106,0 @@ Data for this metric is available starting from June 25, 2024 0:00:00 GMT. -Type: Percent @@ -75 +107,0 @@ Type: Percent -Category: Outbound campaigns driven metric @@ -79 +111,11 @@ Category: Outbound campaigns driven metric -The count of outbound campaign interactions after a successful delivery attempt. Example interactions include `OPEN`, `CLICK`, and `COMPLAINT`. +This metric counts the outbound campaign interactions after a successful delivery attempt. Example interactions include `OPEN`, `CLICK`, and `COMPLAINT`. + +**Metric type** : Integer + +**Metric category** : Outbound campaigns driven metric + +**How to access using the Amazon Connect API** : + + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `CAMPAIGN_INTERACTIONS` + + @@ -81 +122,0 @@ The count of outbound campaign interactions after a successful delivery attempt. -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `CAMPAIGN_INTERACTIONS`. @@ -83 +124 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -###### Note +**Notes** : @@ -85 +126,3 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -This metric is available only for outbound campaigns that use the email delivery mode. + * This metric is available only for outbound campaigns that use the email delivery mode. + + * Data for this metric is available starting from November 6, 2024 0:00:00 GMT. @@ -87 +129,0 @@ This metric is available only for outbound campaigns that use the email delivery -Data for this metric is available starting from November 6, 2024 0:00:00 GMT. @@ -89 +130,0 @@ Data for this metric is available starting from November 6, 2024 0:00:00 GMT. -Type: Integer @@ -91 +131,0 @@ Type: Integer -Category: Outbound campaigns driven metric @@ -95 +135,14 @@ Category: Outbound campaigns driven metric -The count of outbound campaign send requests sent by Amazon Connect for delivery. A campaign send request represents a send attempt made to reach out to an recipient using email, SMS, or telephony delivery mode. +This metric counts the outbound campaign send requests sent by Amazon Connect for delivery. A campaign send request represents a send attempt made to reach out to an recipient using email, SMS, or telephony delivery mode. + +**Metric type** : Integer + + * Min value: 0.00% + + * Max value: 100.00% + + + + +**Metric category** : Outbound campaigns driven metric + +**How to access using the Amazon Connect API** : @@ -97 +150,8 @@ The count of outbound campaign send requests sent by Amazon Connect for delivery -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using ` CAMPAIGN_SEND_ATTEMPTS`. + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `CAMPAIGN_SEND_ATTEMPTS` + + + + +**Notes** : + + * Data for this metric is available starting from November 6, 2024 0:00:00 GMT. @@ -99 +158,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from November 6, 2024 0:00:00 GMT. @@ -101 +159,0 @@ Data for this metric is available starting from November 6, 2024 0:00:00 GMT. -Type: Integer @@ -103 +160,0 @@ Type: Integer -Category: Outbound campaigns driven metric @@ -107 +164,7 @@ Category: Outbound campaigns driven metric -The delivery outcome of a campaign outreach attempt. The count of outbound campaign contact outcomes from the Amazon Connect dialer, or the count of outbound campaign email or SMS message outcomes that were successfully sent to Amazon Connect to be delivered. +This metric measures the delivery outcome of a campaign outreach attempt. The count of outbound campaign contact outcomes from the Amazon Connect dialer, or the count of outbound campaign email or SMS message outcomes that were successfully sent to Amazon Connect to be delivered. + +**Metric type** : Integer + +**Metric category** : Outbound campaigns driven metric + +**How to access using the Amazon Connect API** : @@ -109 +172 @@ The delivery outcome of a campaign outreach attempt. The count of outbound campa -###### Tip + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `DELIVERY_ATTEMPTS` @@ -111 +173,0 @@ The delivery outcome of a campaign outreach attempt. The count of outbound campa -For details about telephony disposition definitions, see DisconnectReason for outbound campaigns and AnsweringMachineDetectionStatus in the [ContactTraceRecord](./ctr-data-model.html#ctr-ContactTraceRecord). For details about email and SMS disposition definitions, see campaign_event_type in the [Outbound campaign events](./data-lake-outbound-campaigns-data.html#data-lake-oc-events) table. @@ -113 +174,0 @@ For details about telephony disposition definitions, see DisconnectReason for ou -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `DELIVERY_ATTEMPTS`. @@ -115 +175,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Data for this metric is available starting from June 25, 2024 0:00:00 GMT. @@ -117 +177,6 @@ Data for this metric is available starting from June 25, 2024 0:00:00 GMT.