AWS connect documentation change
Summary
Restructured scheduling metrics documentation with expanded API/web access details, metric type/category specifications, and formatting improvements
Security assessment
Changes focus on metric documentation clarity and access methods without addressing security vulnerabilities or introducing security-related content.
Diff
diff --git a/connect/latest/adminguide/scheduling-metrics.md b/connect/latest/adminguide/scheduling-metrics.md index d4c9d3990..8f27cbee7 100644 --- a//connect/latest/adminguide/scheduling-metrics.md +++ b//connect/latest/adminguide/scheduling-metrics.md @@ -17 +17 @@ These metrics are available in AWS Regions only where [Forecasting, capacity pla -The percentage of time that an agent correctly follows their schedule. +This metric measures the percentage of time that an agent correctly follows their schedule. @@ -19 +19 @@ The percentage of time that an agent correctly follows their schedule. -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AGENT_SCHEDULE_ADHERENCE`. +**Metric type** : String @@ -21 +21 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Type: String + * Min value: 0.00% @@ -23 +23 @@ Type: String -Min value: 0.00% + * Max value: 100.00% @@ -25 +24,0 @@ Min value: 0.00% -Max value: 100.00% @@ -27 +25,0 @@ Max value: 100.00% -Category: Agent activity driven metric @@ -29 +26,0 @@ Category: Agent activity driven metric -###### Note @@ -31 +28,22 @@ Category: Agent activity driven metric -Any time you change the schedule, Schedule Adherence is re-calculated up to 30 days in the past from the current date (not the date of the schedule), if schedules are changed. +**Metric category** : Agent activity-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: `AGENT_SCHEDULE_ADHERENCE` + + + + +**How to access using the Amazon Connect admin website** : + + * Historical metrics reports: Adherence + + + + +**Notes** : + + * Any time you change the schedule, Schedule Adherence is re-calculated up to 30 days in the past from the current date (not the date of the schedule), if schedules are changed. + + + @@ -35 +53,16 @@ Any time you change the schedule, Schedule Adherence is re-calculated up to 30 d -The total time an agent adhered to their schedule. +This metric measures the total time an agent adhered to their schedule. + +**Metric type** : String + +**Metric category** : Agent activity-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: `AGENT_ADHERENT_TIME` + + + + +**How to access using the Amazon Connect admin website** : + + * Historical metrics reports: Adherent time @@ -37 +69,0 @@ The total time an agent adhered to their schedule. -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AGENT_ADHERENT_TIME`. @@ -39 +70,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Type: String @@ -41 +71,0 @@ Type: String -Category: Agent activity driven metric @@ -45 +75,7 @@ Category: Agent activity driven metric -The total time an agent did not adhere to their schedule. +This metric measures the total time an agent did not adhere to their schedule. + +**Metric type** : String (_hh:mm:ss_) + +**Metric category** : Agent activity-driven metric + +**How to access using the Amazon Connect API** : @@ -47 +83 @@ The total time an agent did not adhere to their schedule. -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AGENT_NON_ADHERENT_TIME`. + * [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API metric identifier: `AGENT_NON_ADHERENT_TIME` @@ -49 +84,0 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference - * Type: String (_hh:mm:ss_) @@ -51 +86,5 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference - * Category: Agent activity driven metric + + +**How to access using the Amazon Connect admin website** : + + * Historical metrics reports: Non-Adherent time @@ -58 +97,11 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference -Total time an agent was scheduled (either for productive or non-productive time) and _Adherence_ for those shifts was set to `Yes`. +This metric measures the total time an agent was scheduled (either for productive or non-productive time) and _Adherence_ for those shifts was set to `Yes`. + +**Metric type** : String + +**Metric category** : Agent activity-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: `AGENT_SCHEDULED_TIME` + + @@ -60 +108,0 @@ Total time an agent was scheduled (either for productive or non-productive time) -In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API, this metric can be retrieved by using `AGENT_SCHEDULED_TIME`. @@ -62 +110 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference - * Type: String ((hh:mm:ss) +**How to access using the Amazon Connect admin website** : @@ -64 +112 @@ In the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference - * Category: Agent activity driven metric + * Historical metrics reports: Scheduled time