« blib/lib/Paws/Connect/GetContactAttributesResponse.pm
↑ Summary
blib/lib/Paws/Connect/GetCurrentMetricDataResponse.pm »
| 1 | |||
| 2 | package Paws::Connect::GetCurrentMetricData; | ||
| 3 | use Moose; | ||
| 4 | has CurrentMetrics => (is => 'ro', isa => 'ArrayRef[Paws::Connect::CurrentMetric]', required => 1); | ||
| 5 | has Filters => (is => 'ro', isa => 'Paws::Connect::Filters', required => 1); | ||
| 6 | has Groupings => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has InstanceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'InstanceId', required => 1); | ||
| 8 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 9 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCurrentMetricData'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/metrics/current/{InstanceId}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::GetCurrentMetricDataResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Connect::GetCurrentMetricData - Arguments for method GetCurrentMetricData on L<Paws::Connect> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetCurrentMetricData on the | ||
| 28 | L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class | ||
| 29 | as arguments to method GetCurrentMetricData. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCurrentMetricData. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $connect = Paws->service('Connect'); | ||
| 36 | my $GetCurrentMetricDataResponse = $connect->GetCurrentMetricData( | ||
| 37 | CurrentMetrics => [ | ||
| 38 | { | ||
| 39 | Name => 'AGENTS_ONLINE' | ||
| 40 | , # values: AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE; OPTIONAL | ||
| 41 | Unit => 'SECONDS', # values: SECONDS, COUNT, PERCENT; OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], | ||
| 45 | Filters => { | ||
| 46 | Channels => [ | ||
| 47 | 'VOICE', ... # values: VOICE, CHAT, TASK | ||
| 48 | ], # max: 1; OPTIONAL | ||
| 49 | Queues => [ 'MyQueueId', ... ], # min: 1, max: 100; OPTIONAL | ||
| 50 | }, | ||
| 51 | InstanceId => 'MyInstanceId', | ||
| 52 | Groupings => [ | ||
| 53 | 'QUEUE', ... # values: QUEUE, CHANNEL | ||
| 54 | ], # OPTIONAL | ||
| 55 | MaxResults => 1, # OPTIONAL | ||
| 56 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | # Results: | ||
| 60 | my $DataSnapshotTime = $GetCurrentMetricDataResponse->DataSnapshotTime; | ||
| 61 | my $MetricResults = $GetCurrentMetricDataResponse->MetricResults; | ||
| 62 | my $NextToken = $GetCurrentMetricDataResponse->NextToken; | ||
| 63 | |||
| 64 | # Returns a L<Paws::Connect::GetCurrentMetricDataResponse> object. | ||
| 65 | |||
| 66 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/GetCurrentMetricData> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> CurrentMetrics => ArrayRef[L<Paws::Connect::CurrentMetric>] | ||
| 73 | |||
| 74 | The metrics to retrieve. Specify the name and unit for each metric. The | ||
| 75 | following metrics are available. For a description of all the metrics, | ||
| 76 | see Real-time Metrics Definitions | ||
| 77 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html) | ||
| 78 | in the I<Amazon Connect Administrator Guide>. | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item AGENTS_AFTER_CONTACT_WORK | ||
| 83 | |||
| 84 | Unit: COUNT | ||
| 85 | |||
| 86 | Name in real-time metrics report: ACW | ||
| 87 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time) | ||
| 88 | |||
| 89 | =item AGENTS_AVAILABLE | ||
| 90 | |||
| 91 | Unit: COUNT | ||
| 92 | |||
| 93 | Name in real-time metrics report: Available | ||
| 94 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time) | ||
| 95 | |||
| 96 | =item AGENTS_ERROR | ||
| 97 | |||
| 98 | Unit: COUNT | ||
| 99 | |||
| 100 | Name in real-time metrics report: Error | ||
| 101 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time) | ||
| 102 | |||
| 103 | =item AGENTS_NON_PRODUCTIVE | ||
| 104 | |||
| 105 | Unit: COUNT | ||
| 106 | |||
| 107 | Name in real-time metrics report: NPT (Non-Productive Time) | ||
| 108 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time) | ||
| 109 | |||
| 110 | =item AGENTS_ON_CALL | ||
| 111 | |||
| 112 | Unit: COUNT | ||
| 113 | |||
| 114 | Name in real-time metrics report: On contact | ||
| 115 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time) | ||
| 116 | |||
| 117 | =item AGENTS_ON_CONTACT | ||
| 118 | |||
| 119 | Unit: COUNT | ||
| 120 | |||
| 121 | Name in real-time metrics report: On contact | ||
| 122 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time) | ||
| 123 | |||
| 124 | =item AGENTS_ONLINE | ||
| 125 | |||
| 126 | Unit: COUNT | ||
| 127 | |||
| 128 | Name in real-time metrics report: Online | ||
| 129 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time) | ||
| 130 | |||
| 131 | =item AGENTS_STAFFED | ||
| 132 | |||
| 133 | Unit: COUNT | ||
| 134 | |||
| 135 | Name in real-time metrics report: Staffed | ||
| 136 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time) | ||
| 137 | |||
| 138 | =item CONTACTS_IN_QUEUE | ||
| 139 | |||
| 140 | Unit: COUNT | ||
| 141 | |||
| 142 | Name in real-time metrics report: In queue | ||
| 143 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time) | ||
| 144 | |||
| 145 | =item CONTACTS_SCHEDULED | ||
| 146 | |||
| 147 | Unit: COUNT | ||
| 148 | |||
| 149 | Name in real-time metrics report: Scheduled | ||
| 150 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time) | ||
| 151 | |||
| 152 | =item OLDEST_CONTACT_AGE | ||
| 153 | |||
| 154 | Unit: SECONDS | ||
| 155 | |||
| 156 | When you use groupings, Unit says SECONDS but the Value is returned in | ||
| 157 | MILLISECONDS. For example, if you get a response like this: | ||
| 158 | |||
| 159 | C<{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, | ||
| 160 | "Value": 24113.0 >} | ||
| 161 | |||
| 162 | The actual OLDEST_CONTACT_AGE is 24 seconds. | ||
| 163 | |||
| 164 | Name in real-time metrics report: Oldest | ||
| 165 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time) | ||
| 166 | |||
| 167 | =item SLOTS_ACTIVE | ||
| 168 | |||
| 169 | Unit: COUNT | ||
| 170 | |||
| 171 | Name in real-time metrics report: Active | ||
| 172 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time) | ||
| 173 | |||
| 174 | =item SLOTS_AVAILABLE | ||
| 175 | |||
| 176 | Unit: COUNT | ||
| 177 | |||
| 178 | Name in real-time metrics report: Availability | ||
| 179 | (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time) | ||
| 180 | |||
| 181 | =back | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | |||
| 186 | =head2 B<REQUIRED> Filters => L<Paws::Connect::Filters> | ||
| 187 | |||
| 188 | The queues, up to 100, or channels, to use to filter the metrics | ||
| 189 | returned. Metric data is retrieved only for the resources associated | ||
| 190 | with the queues or channels included in the filter. You can include | ||
| 191 | both queue IDs and queue ARNs in the same request. VOICE, CHAT, and | ||
| 192 | TASK channels are supported. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 Groupings => ArrayRef[Str|Undef] | ||
| 197 | |||
| 198 | The grouping applied to the metrics returned. For example, when grouped | ||
| 199 | by C<QUEUE>, the metrics returned apply to each queue rather than | ||
| 200 | aggregated for all queues. If you group by C<CHANNEL>, you should | ||
| 201 | include a Channels filter. VOICE, CHAT, and TASK channels are | ||
| 202 | supported. | ||
| 203 | |||
| 204 | If no C<Grouping> is included in the request, a summary of metrics is | ||
| 205 | returned. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 B<REQUIRED> InstanceId => Str | ||
| 210 | |||
| 211 | The identifier of the Amazon Connect instance. You can find the | ||
| 212 | instanceId in the ARN of the instance. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head2 MaxResults => Int | ||
| 217 | |||
| 218 | The maximum number of results to return per page. | ||
| 219 | |||
| 220 | |||
| 221 | |||
| 222 | =head2 NextToken => Str | ||
| 223 | |||
| 224 | The token for the next set of results. Use the value returned in the | ||
| 225 | previous response in the next request to retrieve the next set of | ||
| 226 | results. | ||
| 227 | |||
| 228 | The token expires after 5 minutes from the time it is created. | ||
| 229 | Subsequent requests that use the token must use the same request | ||
| 230 | parameters as the request that generated the token. | ||
| 231 | |||
| 232 | |||
| 233 | |||
| 234 | |||
| 235 | =head1 SEE ALSO | ||
| 236 | |||
| 237 | This class forms part of L<Paws>, documenting arguments for method GetCurrentMetricData in L<Paws::Connect> | ||
| 238 | |||
| 239 | =head1 BUGS and CONTRIBUTIONS | ||
| 240 | |||
| 241 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 242 | |||
| 243 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 244 | |||
| 245 | =cut | ||
| 246 |