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.

GetCurrentMetricDataInput

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

type GetCurrentMetricDataInput struct { CurrentMetrics []*CurrentMetric `type:"list" required:"true"` Filters *Filters `type:"structure" required:"true"` Groupings []*string `type:"list"` InstanceId *string `location:"uri" locationName:"InstanceId" min:"1" type:"string" required:"true"` MaxResults *int64 `min:"1" type:"integer"` NextToken *string `type:"string"` }

CurrentMetrics

A CurrentMetric object that contains the Name and Unit for the metric.

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 grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics is returned.

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

MaxResults indicates the maximum number of results to return per page in the response, between 1 and 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.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.

Method

GoString

func (s GetCurrentMetricDataInput) GoString() string

GoString returns the string representation

SetCurrentMetrics

func (s *GetCurrentMetricDataInput) SetCurrentMetrics(v []*CurrentMetric) *GetCurrentMetricDataInput

SetCurrentMetrics sets the CurrentMetrics field's value.

SetFilters

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

SetFilters sets the Filters field's value.

SetGroupings

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

SetGroupings sets the Groupings field's value.

SetInstanceId

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

SetInstanceId sets the InstanceId field's value.

SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

SetNextToken

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

SetNextToken sets the NextToken field's value.

String

func (s GetCurrentMetricDataInput) String() string

String returns the string representation

Validate

func (s *GetCurrentMetricDataInput) Validate() error

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

On this page: