sdkmetricsdataplane

package
v1.300001.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 24, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package sdkmetricsdataplane provides the client and types for making API requests to AWS SDK Metrics Dataplane.

See https://docs.aws.amazon.com/goto/WebAPI/sdkmetrics-dataplane-2018-10-22 for more information on this service.

See sdkmetricsdataplane package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sdkmetricsdataplane/

Using the Client

To contact AWS SDK Metrics Dataplane with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS SDK Metrics Dataplane client SDKMetricsDataplane for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sdkmetricsdataplane/#New

Index

Constants

View Source 
const (
	// EnvironmentPropertyTagEc2 is a EnvironmentPropertyTag enum value
	EnvironmentPropertyTagEc2 = "EC2"

	// EnvironmentPropertyTagLambda is a EnvironmentPropertyTag enum value
	EnvironmentPropertyTagLambda = "LAMBDA"
)
View Source 
const (
	// StatusOk is a Status enum value
	StatusOk = "OK"

	// StatusError is a Status enum value
	StatusError = "ERROR"
)
View Source 
const (
	ServiceName = "SDK Metrics Dataplane" // Name of service.
	EndpointsID = "sdkmetrics"            // ID to lookup a service endpoint with.
	ServiceID   = "SDK Metrics Dataplane" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type EnvironmentProperty 

type EnvironmentProperty struct {

	// EnvironmentPropertyTag is a required field
	EnvironmentPropertyTag *string `type:"string" required:"true" enum:"EnvironmentPropertyTag"`
	// contains filtered or unexported fields
}

func (EnvironmentProperty) GoString 

func (s EnvironmentProperty) GoString() string

GoString returns the string representation

func (*EnvironmentProperty) SetEnvironmentPropertyTag 

func (s *EnvironmentProperty) SetEnvironmentPropertyTag(v string) *EnvironmentProperty

SetEnvironmentPropertyTag sets the EnvironmentPropertyTag field's value.

func (EnvironmentProperty) String 

func (s EnvironmentProperty) String() string

String returns the string representation

func (*EnvironmentProperty) Validate 

func (s *EnvironmentProperty) Validate() error

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

type FrequencyDistributionEntry 

type FrequencyDistributionEntry struct {

	// Count is a required field
	Count *int64 `locationName:"count" type:"integer" required:"true"`

	Key *string `locationName:"key" type:"string"`
	// contains filtered or unexported fields
}

func (FrequencyDistributionEntry) GoString 

func (s FrequencyDistributionEntry) GoString() string

GoString returns the string representation

func (*FrequencyDistributionEntry) SetCount 

func (s *FrequencyDistributionEntry) SetCount(v int64) *FrequencyDistributionEntry

SetCount sets the Count field's value.

func (*FrequencyDistributionEntry) SetKey 

func (s *FrequencyDistributionEntry) SetKey(v string) *FrequencyDistributionEntry

SetKey sets the Key field's value.

func (FrequencyDistributionEntry) String 

func (s FrequencyDistributionEntry) String() string

String returns the string representation

func (*FrequencyDistributionEntry) Validate 

func (s *FrequencyDistributionEntry) Validate() error

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

type FrequencyMetric 

type FrequencyMetric struct {

	// Distribution is a required field
	Distribution []*FrequencyDistributionEntry `locationName:"distribution" type:"list" required:"true"`

	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (FrequencyMetric) GoString 

func (s FrequencyMetric) GoString() string

GoString returns the string representation

func (*FrequencyMetric) SetDistribution 

func (s *FrequencyMetric) SetDistribution(v []*FrequencyDistributionEntry) *FrequencyMetric

SetDistribution sets the Distribution field's value.

func (*FrequencyMetric) SetName 

func (s *FrequencyMetric) SetName(v string) *FrequencyMetric

SetName sets the Name field's value.

func (FrequencyMetric) String 

func (s FrequencyMetric) String() string

String returns the string representation

func (*FrequencyMetric) Validate 

func (s *FrequencyMetric) Validate() error

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

type HostEnvironment 

type HostEnvironment struct {
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	InstanceId *string `locationName:"instanceId" type:"string"`

	// Os is a required field
	Os *string `locationName:"os" type:"string" required:"true"`

	Properties []*EnvironmentProperty `locationName:"properties" type:"list"`

	SourceIps []*string `locationName:"sourceIps" type:"list"`

	VpcId *string `locationName:"vpcId" type:"string"`
	// contains filtered or unexported fields
}

func (HostEnvironment) GoString 

func (s HostEnvironment) GoString() string

GoString returns the string representation

func (*HostEnvironment) SetAvailabilityZone 

func (s *HostEnvironment) SetAvailabilityZone(v string) *HostEnvironment

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*HostEnvironment) SetInstanceId 

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

SetInstanceId sets the InstanceId field's value.

func (*HostEnvironment) SetOs 

func (s *HostEnvironment) SetOs(v string) *HostEnvironment

SetOs sets the Os field's value.

func (*HostEnvironment) SetProperties 

func (s *HostEnvironment) SetProperties(v []*EnvironmentProperty) *HostEnvironment

SetProperties sets the Properties field's value.

func (*HostEnvironment) SetSourceIps 

func (s *HostEnvironment) SetSourceIps(v []*string) *HostEnvironment

SetSourceIps sets the SourceIps field's value.

func (*HostEnvironment) SetVpcId 

func (s *HostEnvironment) SetVpcId(v string) *HostEnvironment

SetVpcId sets the VpcId field's value.

func (HostEnvironment) String 

func (s HostEnvironment) String() string

String returns the string representation

func (*HostEnvironment) Validate 

func (s *HostEnvironment) Validate() error

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

type PutRecordsInput 

type PutRecordsInput struct {

	// Environment is a required field
	Environment *HostEnvironment `locationName:"environment" type:"structure" required:"true"`

	// SdkRecords is a required field
	SdkRecords []*SdkMonitoringRecord `locationName:"sdkRecords" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutRecordsInput) GoString 

func (s PutRecordsInput) GoString() string

GoString returns the string representation

func (*PutRecordsInput) SetEnvironment 

func (s *PutRecordsInput) SetEnvironment(v *HostEnvironment) *PutRecordsInput

SetEnvironment sets the Environment field's value.

func (*PutRecordsInput) SetSdkRecords 

func (s *PutRecordsInput) SetSdkRecords(v []*SdkMonitoringRecord) *PutRecordsInput

SetSdkRecords sets the SdkRecords field's value.

func (PutRecordsInput) String 

func (s PutRecordsInput) String() string

String returns the string representation

func (*PutRecordsInput) Validate 

func (s *PutRecordsInput) Validate() error

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

type PutRecordsOutput 

type PutRecordsOutput struct {
	Statuses []*RecordStatus `locationName:"statuses" type:"list"`
	// contains filtered or unexported fields
}

func (PutRecordsOutput) GoString 

func (s PutRecordsOutput) GoString() string

GoString returns the string representation

func (*PutRecordsOutput) SetStatuses 

func (s *PutRecordsOutput) SetStatuses(v []*RecordStatus) *PutRecordsOutput

SetStatuses sets the Statuses field's value.

func (PutRecordsOutput) String 

func (s PutRecordsOutput) String() string

String returns the string representation

type RecordStatus 

type RecordStatus struct {
	Error *string `locationName:"error" type:"string"`

	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`
	// contains filtered or unexported fields
}

func (RecordStatus) GoString 

func (s RecordStatus) GoString() string

GoString returns the string representation

func (*RecordStatus) SetError 

func (s *RecordStatus) SetError(v string) *RecordStatus

SetError sets the Error field's value.

func (*RecordStatus) SetStatus 

func (s *RecordStatus) SetStatus(v string) *RecordStatus

SetStatus sets the Status field's value.

func (RecordStatus) String 

func (s RecordStatus) String() string

String returns the string representation

type SDKMetricsDataplane 

type SDKMetricsDataplane struct {
	*client.Client
}

SDKMetricsDataplane provides the API operation methods for making requests to AWS SDK Metrics Dataplane. See this package's package overview docs for details on the service.

SDKMetricsDataplane methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SDKMetricsDataplane

New creates a new instance of the SDKMetricsDataplane client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a SDKMetricsDataplane client from just a session.
svc := sdkmetricsdataplane.New(mySession)

// Create a SDKMetricsDataplane client with additional configuration
svc := sdkmetricsdataplane.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SDKMetricsDataplane) PutRecords 

func (c *SDKMetricsDataplane) PutRecords(input *PutRecordsInput) (*PutRecordsOutput, error)

PutRecords API operation for AWS SDK Metrics Dataplane.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS SDK Metrics Dataplane's API operation PutRecords for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sdkmetrics-dataplane-2018-10-22/PutRecords

func (*SDKMetricsDataplane) PutRecordsRequest 

func (c *SDKMetricsDataplane) PutRecordsRequest(input *PutRecordsInput) (req *request.Request, output *PutRecordsOutput)

PutRecordsRequest generates a "aws/request.Request" representing the client's request for the PutRecords operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRecords for more information on using the PutRecords API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutRecordsRequest method.
req, resp := client.PutRecordsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/sdkmetrics-dataplane-2018-10-22/PutRecords

func (*SDKMetricsDataplane) PutRecordsWithContext 

func (c *SDKMetricsDataplane) PutRecordsWithContext(ctx aws.Context, input *PutRecordsInput, opts ...request.Option) (*PutRecordsOutput, error)

PutRecordsWithContext is the same as PutRecords with the addition of the ability to pass a context and additional request options.

See PutRecords for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SdkAggregationKey 

type SdkAggregationKey struct {
	Keys []*SdkAggregationKeyEntry `locationName:"keys" type:"list"`

	// Timestamp is a required field
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"`
	// contains filtered or unexported fields
}

func (SdkAggregationKey) GoString 

func (s SdkAggregationKey) GoString() string

GoString returns the string representation

func (*SdkAggregationKey) SetKeys 

func (s *SdkAggregationKey) SetKeys(v []*SdkAggregationKeyEntry) *SdkAggregationKey

SetKeys sets the Keys field's value.

func (*SdkAggregationKey) SetTimestamp 

func (s *SdkAggregationKey) SetTimestamp(v time.Time) *SdkAggregationKey

SetTimestamp sets the Timestamp field's value.

func (SdkAggregationKey) String 

func (s SdkAggregationKey) String() string

String returns the string representation

func (*SdkAggregationKey) Validate 

func (s *SdkAggregationKey) Validate() error

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

type SdkAggregationKeyEntry 

type SdkAggregationKeyEntry struct {

	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SdkAggregationKeyEntry) GoString 

func (s SdkAggregationKeyEntry) GoString() string

GoString returns the string representation

func (*SdkAggregationKeyEntry) SetKey 

func (s *SdkAggregationKeyEntry) SetKey(v string) *SdkAggregationKeyEntry

SetKey sets the Key field's value.

func (*SdkAggregationKeyEntry) SetValue 

func (s *SdkAggregationKeyEntry) SetValue(v string) *SdkAggregationKeyEntry

SetValue sets the Value field's value.

func (SdkAggregationKeyEntry) String 

func (s SdkAggregationKeyEntry) String() string

String returns the string representation

func (*SdkAggregationKeyEntry) Validate 

func (s *SdkAggregationKeyEntry) Validate() error

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

type SdkMonitoringRecord 

type SdkMonitoringRecord struct {

	// AggregationKey is a required field
	AggregationKey *SdkAggregationKey `locationName:"aggregationKey" type:"structure" required:"true"`

	CompressedEventSamples *string `locationName:"compressedEventSamples" type:"string"`

	FrequencyMetrics []*FrequencyMetric `locationName:"frequencyMetrics" type:"list"`

	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	SehMetrics []*SehMetric `locationName:"sehMetrics" type:"list"`

	UncompressedSamplesChecksum *int64 `locationName:"uncompressedSamplesChecksum" type:"long"`

	UncompressedSamplesLength *int64 `locationName:"uncompressedSamplesLength" min:"1" type:"integer"`

	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SdkMonitoringRecord) GoString 

func (s SdkMonitoringRecord) GoString() string

GoString returns the string representation

func (*SdkMonitoringRecord) SetAggregationKey 

func (s *SdkMonitoringRecord) SetAggregationKey(v *SdkAggregationKey) *SdkMonitoringRecord

SetAggregationKey sets the AggregationKey field's value.

func (*SdkMonitoringRecord) SetCompressedEventSamples 

func (s *SdkMonitoringRecord) SetCompressedEventSamples(v string) *SdkMonitoringRecord

SetCompressedEventSamples sets the CompressedEventSamples field's value.

func (*SdkMonitoringRecord) SetFrequencyMetrics 

func (s *SdkMonitoringRecord) SetFrequencyMetrics(v []*FrequencyMetric) *SdkMonitoringRecord

SetFrequencyMetrics sets the FrequencyMetrics field's value.

func (*SdkMonitoringRecord) SetId 

func (s *SdkMonitoringRecord) SetId(v string) *SdkMonitoringRecord

SetId sets the Id field's value.

func (*SdkMonitoringRecord) SetSehMetrics 

func (s *SdkMonitoringRecord) SetSehMetrics(v []*SehMetric) *SdkMonitoringRecord

SetSehMetrics sets the SehMetrics field's value.

func (*SdkMonitoringRecord) SetUncompressedSamplesChecksum 

func (s *SdkMonitoringRecord) SetUncompressedSamplesChecksum(v int64) *SdkMonitoringRecord

SetUncompressedSamplesChecksum sets the UncompressedSamplesChecksum field's value.

func (*SdkMonitoringRecord) SetUncompressedSamplesLength 

func (s *SdkMonitoringRecord) SetUncompressedSamplesLength(v int64) *SdkMonitoringRecord

SetUncompressedSamplesLength sets the UncompressedSamplesLength field's value.

func (*SdkMonitoringRecord) SetVersion 

func (s *SdkMonitoringRecord) SetVersion(v string) *SdkMonitoringRecord

SetVersion sets the Version field's value.

func (SdkMonitoringRecord) String 

func (s SdkMonitoringRecord) String() string

String returns the string representation

func (*SdkMonitoringRecord) Validate 

func (s *SdkMonitoringRecord) Validate() error

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

type SehBucket 

type SehBucket struct {

	// Index is a required field
	Index *int64 `locationName:"index" type:"long" required:"true"`

	// Value is a required field
	Value *float64 `locationName:"value" type:"double" required:"true"`
	// contains filtered or unexported fields
}

func (SehBucket) GoString 

func (s SehBucket) GoString() string

GoString returns the string representation

func (*SehBucket) SetIndex 

func (s *SehBucket) SetIndex(v int64) *SehBucket

SetIndex sets the Index field's value.

func (*SehBucket) SetValue 

func (s *SehBucket) SetValue(v float64) *SehBucket

SetValue sets the Value field's value.

func (SehBucket) String 

func (s SehBucket) String() string

String returns the string representation

func (*SehBucket) Validate 

func (s *SehBucket) Validate() error

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

type SehMetric 

type SehMetric struct {

	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// SehBuckets is a required field
	SehBuckets []*SehBucket `locationName:"sehBuckets" type:"list" required:"true"`

	// Stats is a required field
	Stats *StatisticSet `locationName:"stats" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SehMetric) GoString 

func (s SehMetric) GoString() string

GoString returns the string representation

func (*SehMetric) SetName 

func (s *SehMetric) SetName(v string) *SehMetric

SetName sets the Name field's value.

func (*SehMetric) SetSehBuckets 

func (s *SehMetric) SetSehBuckets(v []*SehBucket) *SehMetric

SetSehBuckets sets the SehBuckets field's value.

func (*SehMetric) SetStats 

func (s *SehMetric) SetStats(v *StatisticSet) *SehMetric

SetStats sets the Stats field's value.

func (SehMetric) String 

func (s SehMetric) String() string

String returns the string representation

func (*SehMetric) Validate 

func (s *SehMetric) Validate() error

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

type StatisticSet 

type StatisticSet struct {

	// Count is a required field
	Count *float64 `locationName:"count" type:"double" required:"true"`

	// Max is a required field
	Max *float64 `locationName:"max" type:"double" required:"true"`

	// Min is a required field
	Min *float64 `locationName:"min" type:"double" required:"true"`

	// Sum is a required field
	Sum *float64 `locationName:"sum" type:"double" required:"true"`
	// contains filtered or unexported fields
}

func (StatisticSet) GoString 

func (s StatisticSet) GoString() string

GoString returns the string representation

func (*StatisticSet) SetCount 

func (s *StatisticSet) SetCount(v float64) *StatisticSet

SetCount sets the Count field's value.

func (*StatisticSet) SetMax 

func (s *StatisticSet) SetMax(v float64) *StatisticSet

SetMax sets the Max field's value.

func (*StatisticSet) SetMin 

func (s *StatisticSet) SetMin(v float64) *StatisticSet

SetMin sets the Min field's value.

func (*StatisticSet) SetSum 

func (s *StatisticSet) SetSum(v float64) *StatisticSet

SetSum sets the Sum field's value.

func (StatisticSet) String 

func (s StatisticSet) String() string

String returns the string representation

func (*StatisticSet) Validate 

func (s *StatisticSet) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package sdkmetricsdataplaneiface provides an interface to enable mocking the AWS SDK Metrics Dataplane service client for testing your code.
 Package sdkmetricsdataplaneiface provides an interface to enable mocking the AWS SDK Metrics Dataplane service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.