Package software.amazon.awssdk.services.connect.model

Interface GetMetricDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>, SdkBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetMetricDataRequest
public static interface GetMetricDataRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>

  • Method Details

    • instanceId

      GetMetricDataRequest.Builder instanceId(String instanceId)

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      GetMetricDataRequest.Builder startTime(Instant startTime)

      The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

      The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

      Parameters:
      startTime - The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

      The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      GetMetricDataRequest.Builder endTime(Instant endTime)

      The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

      The time range between the start and end time must be less than 24 hours.

      Parameters:
      endTime - The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

      The time range between the start and end time must be less than 24 hours.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      GetMetricDataRequest.Builder filters(Filters filters)

      The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      To filter by Queues, enter the queue ID/ARN, not the name of the queue.

      Parameters:
      filters - The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      To filter by Queues, enter the queue ID/ARN, not the name of the queue.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default GetMetricDataRequest.Builder filters(Consumer<Filters.Builder> filters)

      The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      To filter by Queues, enter the queue ID/ARN, not the name of the queue.

      This is a convenience method that creates an instance of the Filters.Builder avoiding the need to create one manually via Filters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(Filters).

      Parameters:
      filters - a consumer that will call methods on Filters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupingsWithStrings

      GetMetricDataRequest.Builder groupingsWithStrings(Collection<String> groupings)

      The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Parameters:
      groupings - The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupingsWithStrings

      GetMetricDataRequest.Builder groupingsWithStrings(String... groupings)

      The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Parameters:
      groupings - The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupings

      GetMetricDataRequest.Builder groupings(Collection<Grouping> groupings)

      The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Parameters:
      groupings - The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupings

      GetMetricDataRequest.Builder groupings(Grouping... groupings)

      The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Parameters:
      groupings - The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

      If no grouping is specified, a summary of metrics for all queues is returned.

      RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • historicalMetrics

      GetMetricDataRequest.Builder historicalMetrics(Collection<HistoricalMetric> historicalMetrics)

      The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

      Parameters:
      historicalMetrics - The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • historicalMetrics

      GetMetricDataRequest.Builder historicalMetrics(HistoricalMetric... historicalMetrics)

      The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

      Parameters:
      historicalMetrics - The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • historicalMetrics

      GetMetricDataRequest.Builder historicalMetrics(Consumer<HistoricalMetric.Builder>... historicalMetrics)

      The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

      This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

      ABANDON_TIME

      Unit: SECONDS

      Statistic: AVG

      AFTER_CONTACT_WORK_TIME

      Unit: SECONDS

      Statistic: AVG

      API_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CALLBACK_CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_ABANDONED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_AGENT_HUNG_UP_FIRST

      Unit: COUNT

      Statistic: SUM

      CONTACTS_CONSULTED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_INCOMING

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HANDLED_OUTBOUND

      Unit: COUNT

      Statistic: SUM

      CONTACTS_HOLD_ABANDONS

      Unit: COUNT

      Statistic: SUM

      CONTACTS_MISSED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_QUEUED

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_IN_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT

      Unit: COUNT

      Statistic: SUM

      CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

      Unit: COUNT

      Statistic: SUM

      HANDLE_TIME

      Unit: SECONDS

      Statistic: AVG

      HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_AND_HOLD_TIME

      Unit: SECONDS

      Statistic: AVG

      INTERACTION_TIME

      Unit: SECONDS

      Statistic: AVG

      OCCUPANCY

      Unit: PERCENT

      Statistic: AVG

      QUEUE_ANSWER_TIME

      Unit: SECONDS

      Statistic: AVG

      QUEUED_TIME

      Unit: SECONDS

      Statistic: MAX

      SERVICE_LEVEL

      You can include up to 20 SERVICE_LEVEL metrics in a request.

      Unit: PERCENT

      Statistic: AVG

      Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

      This is a convenience method that creates an instance of the HistoricalMetric.Builder avoiding the need to create one manually via HistoricalMetric.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to historicalMetrics(List<HistoricalMetric>).

      Parameters:
      historicalMetrics - a consumer that will call methods on HistoricalMetric.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      GetMetricDataRequest.Builder nextToken(String nextToken)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      Parameters:
      nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetMetricDataRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per page.

      Parameters:
      maxResults - The maximum number of results to return per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.