AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetMetricDataInput

import "github.com/aws/aws-sdk-go/service/connect"

type GetMetricDataInput struct { EndTime *time.Time `type:"timestamp" required:"true"` Filters *Filters `type:"structure" required:"true"` Groupings []*string `type:"list"` HistoricalMetrics []*HistoricalMetric `type:"list" required:"true"` InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` MaxResults *int64 `min:"1" type:"integer"` NextToken *string `type:"string"` StartTime *time.Time `type:"timestamp" required:"true"` }

EndTime

Type: *time.Time

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 StartTime timestamp.

The time range between StartTime and EndTime must be less than 24 hours.

EndTime is a required field

Filters

The filter, either channel or queues, to apply to the metric results retrieved.

Groupings

Type: []*string

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

The current version supports grouping by Queue

If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.

HistoricalMetrics

A HistoricalMetric object that contains the Name, Unit, Statistic, and Threshold for the metric.

InstanceId

Type: *string

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

InstanceId is a required field

MaxResults

Type: *int64

Indicates the maximum number of results to return per page in the response, between 1-100.

NextToken

Type: *string

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.

StartTime

Type: *time.Time

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.

StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.

StartTime is a required field

Method

GoString

func (s GetMetricDataInput) GoString() string

GoString returns the string representation

SetEndTime

func (s *GetMetricDataInput) SetEndTime(v time.Time) *GetMetricDataInput

SetEndTime sets the EndTime field's value.

SetFilters

func (s *GetMetricDataInput) SetFilters(v *Filters) *GetMetricDataInput

SetFilters sets the Filters field's value.

SetGroupings

func (s *GetMetricDataInput) SetGroupings(v []*string) *GetMetricDataInput

SetGroupings sets the Groupings field's value.

SetHistoricalMetrics

func (s *GetMetricDataInput) SetHistoricalMetrics(v []*HistoricalMetric) *GetMetricDataInput

SetHistoricalMetrics sets the HistoricalMetrics field's value.

SetInstanceId

func (s *GetMetricDataInput) SetInstanceId(v string) *GetMetricDataInput

SetInstanceId sets the InstanceId field's value.

SetMaxResults

func (s *GetMetricDataInput) SetMaxResults(v int64) *GetMetricDataInput

SetMaxResults sets the MaxResults field's value.

SetNextToken

func (s *GetMetricDataInput) SetNextToken(v string) *GetMetricDataInput

SetNextToken sets the NextToken field's value.

SetStartTime

func (s *GetMetricDataInput) SetStartTime(v time.Time) *GetMetricDataInput

SetStartTime sets the StartTime field's value.

String

func (s GetMetricDataInput) String() string

String returns the string representation

Validate

func (s *GetMetricDataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: