cloudwatchrum

package
v1.44.206 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2023 License: Apache-2.0 Imports: 10 Imported by: 17

Documentation

Overview

Package cloudwatchrum provides the client and types for making API requests to CloudWatch RUM.

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.

You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.

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

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

Using the Client

To contact CloudWatch RUM 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 CloudWatch RUM client CloudWatchRUM for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchrum/#New

Index

Constants

View Source 
const (
	// CustomEventsStatusEnabled is a CustomEventsStatus enum value
	CustomEventsStatusEnabled = "ENABLED"

	// CustomEventsStatusDisabled is a CustomEventsStatus enum value
	CustomEventsStatusDisabled = "DISABLED"
)
View Source 
const (
	// MetricDestinationCloudWatch is a MetricDestination enum value
	MetricDestinationCloudWatch = "CloudWatch"

	// MetricDestinationEvidently is a MetricDestination enum value
	MetricDestinationEvidently = "Evidently"
)
View Source 
const (
	// StateEnumCreated is a StateEnum enum value
	StateEnumCreated = "CREATED"

	// StateEnumDeleting is a StateEnum enum value
	StateEnumDeleting = "DELETING"

	// StateEnumActive is a StateEnum enum value
	StateEnumActive = "ACTIVE"
)
View Source 
const (
	// TelemetryErrors is a Telemetry enum value
	TelemetryErrors = "errors"

	// TelemetryPerformance is a Telemetry enum value
	TelemetryPerformance = "performance"

	// TelemetryHttp is a Telemetry enum value
	TelemetryHttp = "http"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have sufficient permissions to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// This operation attempted to create a resource that already exists.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Internal service exception.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Resource not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// This request exceeds a service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was throttled because of quota limits.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// One of the arguments for the request is not valid.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "RUM" // Name of service.
	EndpointsID = "rum" // ID to lookup a service endpoint with.
	ServiceID   = "RUM" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func CustomEventsStatus_Values added in v1.44.140 

func CustomEventsStatus_Values() []string

CustomEventsStatus_Values returns all elements of the CustomEventsStatus enum

func MetricDestination_Values added in v1.44.120 

func MetricDestination_Values() []string

MetricDestination_Values returns all elements of the MetricDestination enum

func StateEnum_Values 

func StateEnum_Values() []string

StateEnum_Values returns all elements of the StateEnum enum

func Telemetry_Values 

func Telemetry_Values() []string

Telemetry_Values returns all elements of the Telemetry enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You don't have sufficient permissions to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppMonitor 

type AppMonitor struct {

	// A structure that contains much of the configuration data for the app monitor.
	AppMonitorConfiguration *AppMonitorConfiguration `type:"structure"`

	// The date and time that this app monitor was created.
	Created *string `min:"19" type:"string"`

	// Specifies whether this app monitor allows the web client to define and send
	// custom events.
	//
	// For more information about custom events, see Send custom events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html).
	CustomEvents *CustomEvents `type:"structure"`

	// A structure that contains information about whether this app monitor stores
	// a copy of the telemetry data that RUM collects using CloudWatch Logs.
	DataStorage *DataStorage `type:"structure"`

	// The top-level internet domain name for which your application has administrative
	// authority.
	Domain *string `min:"1" type:"string"`

	// The unique ID of this app monitor.
	Id *string `min:"36" type:"string"`

	// The date and time of the most recent changes to this app monitor's configuration.
	LastModified *string `min:"19" type:"string"`

	// The name of the app monitor.
	Name *string `min:"1" type:"string"`

	// The current state of the app monitor.
	State *string `type:"string" enum:"StateEnum"`

	// The list of tag keys and values associated with this app monitor.
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

A RUM app monitor collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

func (AppMonitor) GoString 

func (s AppMonitor) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppMonitor) SetAppMonitorConfiguration 

func (s *AppMonitor) SetAppMonitorConfiguration(v *AppMonitorConfiguration) *AppMonitor

SetAppMonitorConfiguration sets the AppMonitorConfiguration field's value.

func (*AppMonitor) SetCreated 

func (s *AppMonitor) SetCreated(v string) *AppMonitor

SetCreated sets the Created field's value.

func (*AppMonitor) SetCustomEvents added in v1.44.140 

func (s *AppMonitor) SetCustomEvents(v *CustomEvents) *AppMonitor

SetCustomEvents sets the CustomEvents field's value.

func (*AppMonitor) SetDataStorage 

func (s *AppMonitor) SetDataStorage(v *DataStorage) *AppMonitor

SetDataStorage sets the DataStorage field's value.

func (*AppMonitor) SetDomain 

func (s *AppMonitor) SetDomain(v string) *AppMonitor

SetDomain sets the Domain field's value.

func (*AppMonitor) SetId 

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

SetId sets the Id field's value.

func (*AppMonitor) SetLastModified 

func (s *AppMonitor) SetLastModified(v string) *AppMonitor

SetLastModified sets the LastModified field's value.

func (*AppMonitor) SetName 

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

SetName sets the Name field's value.

func (*AppMonitor) SetState 

func (s *AppMonitor) SetState(v string) *AppMonitor

SetState sets the State field's value.

func (*AppMonitor) SetTags 

func (s *AppMonitor) SetTags(v map[string]*string) *AppMonitor

SetTags sets the Tags field's value.

func (AppMonitor) String 

func (s AppMonitor) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppMonitorConfiguration 

type AppMonitorConfiguration struct {

	// If you set this to true, the RUM web client sets two cookies, a session cookie
	// and a user cookie. The cookies allow the RUM web client to collect data relating
	// to the number of users an application has and the behavior of the application
	// across a sequence of events. Cookies are stored in the top-level domain of
	// the current page.
	AllowCookies *bool `type:"boolean"`

	// If you set this to true, RUM enables X-Ray tracing for the user sessions
	// that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests.
	// It also records an X-Ray segment for allowed HTTP requests. You can see traces
	// and segments from these user sessions in the X-Ray console and the CloudWatch
	// ServiceLens console. For more information, see What is X-Ray? (https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html)
	EnableXRay *bool `type:"boolean"`

	// A list of URLs in your website or application to exclude from RUM data collection.
	//
	// You can't include both ExcludedPages and IncludedPages in the same operation.
	ExcludedPages []*string `type:"list"`

	// A list of pages in your application that are to be displayed with a "favorite"
	// icon in the CloudWatch RUM console.
	FavoritePages []*string `type:"list"`

	// The ARN of the guest IAM role that is attached to the Amazon Cognito identity
	// pool that is used to authorize the sending of data to RUM.
	GuestRoleArn *string `type:"string"`

	// The ID of the Amazon Cognito identity pool that is used to authorize the
	// sending of data to RUM.
	IdentityPoolId *string `min:"1" type:"string"`

	// If this app monitor is to collect data from only certain pages in your application,
	// this structure lists those pages.
	//
	// You can't include both ExcludedPages and IncludedPages in the same operation.
	IncludedPages []*string `type:"list"`

	// Specifies the portion of user sessions to use for RUM data collection. Choosing
	// a higher portion gives you more data but also incurs more costs.
	//
	// The range for this value is 0 to 1 inclusive. Setting this to 1 means that
	// 100% of user sessions are sampled, and setting it to 0.1 means that 10% of
	// user sessions are sampled.
	//
	// If you omit this parameter, the default of 0.1 is used, and 10% of sessions
	// will be sampled.
	SessionSampleRate *float64 `type:"double"`

	// An array that lists the types of telemetry data that this app monitor is
	// to collect.
	//
	//    * errors indicates that RUM collects data about unhandled JavaScript errors
	//    raised by your application.
	//
	//    * performance indicates that RUM collects performance data about how your
	//    application and its resources are loaded and rendered. This includes Core
	//    Web Vitals.
	//
	//    * http indicates that RUM collects data about HTTP errors thrown by your
	//    application.
	Telemetries []*string `type:"list" enum:"Telemetry"`
	// contains filtered or unexported fields
}

This structure contains much of the configuration data for the app monitor.

func (AppMonitorConfiguration) GoString 

func (s AppMonitorConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppMonitorConfiguration) SetAllowCookies 

func (s *AppMonitorConfiguration) SetAllowCookies(v bool) *AppMonitorConfiguration

SetAllowCookies sets the AllowCookies field's value.

func (*AppMonitorConfiguration) SetEnableXRay 

func (s *AppMonitorConfiguration) SetEnableXRay(v bool) *AppMonitorConfiguration

SetEnableXRay sets the EnableXRay field's value.

func (*AppMonitorConfiguration) SetExcludedPages 

func (s *AppMonitorConfiguration) SetExcludedPages(v []*string) *AppMonitorConfiguration

SetExcludedPages sets the ExcludedPages field's value.

func (*AppMonitorConfiguration) SetFavoritePages 

func (s *AppMonitorConfiguration) SetFavoritePages(v []*string) *AppMonitorConfiguration

SetFavoritePages sets the FavoritePages field's value.

func (*AppMonitorConfiguration) SetGuestRoleArn 

func (s *AppMonitorConfiguration) SetGuestRoleArn(v string) *AppMonitorConfiguration

SetGuestRoleArn sets the GuestRoleArn field's value.

func (*AppMonitorConfiguration) SetIdentityPoolId 

func (s *AppMonitorConfiguration) SetIdentityPoolId(v string) *AppMonitorConfiguration

SetIdentityPoolId sets the IdentityPoolId field's value.

func (*AppMonitorConfiguration) SetIncludedPages 

func (s *AppMonitorConfiguration) SetIncludedPages(v []*string) *AppMonitorConfiguration

SetIncludedPages sets the IncludedPages field's value.

func (*AppMonitorConfiguration) SetSessionSampleRate 

func (s *AppMonitorConfiguration) SetSessionSampleRate(v float64) *AppMonitorConfiguration

SetSessionSampleRate sets the SessionSampleRate field's value.

func (*AppMonitorConfiguration) SetTelemetries 

func (s *AppMonitorConfiguration) SetTelemetries(v []*string) *AppMonitorConfiguration

SetTelemetries sets the Telemetries field's value.

func (AppMonitorConfiguration) String 

func (s AppMonitorConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppMonitorConfiguration) Validate 

func (s *AppMonitorConfiguration) Validate() error

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

type AppMonitorDetails 

type AppMonitorDetails struct {

	// The unique ID of the app monitor.
	Id *string `locationName:"id" type:"string"`

	// The name of the app monitor.
	Name *string `locationName:"name" type:"string"`

	// The version of the app monitor.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A structure that contains information about the RUM app monitor.

func (AppMonitorDetails) GoString 

func (s AppMonitorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppMonitorDetails) SetId 

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

SetId sets the Id field's value.

func (*AppMonitorDetails) SetName 

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

SetName sets the Name field's value.

func (*AppMonitorDetails) SetVersion 

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

SetVersion sets the Version field's value.

func (AppMonitorDetails) String 

func (s AppMonitorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AppMonitorSummary 

type AppMonitorSummary struct {

	// The date and time that the app monitor was created.
	Created *string `min:"19" type:"string"`

	// The unique ID of this app monitor.
	Id *string `min:"36" type:"string"`

	// The date and time of the most recent changes to this app monitor's configuration.
	LastModified *string `min:"19" type:"string"`

	// The name of this app monitor.
	Name *string `min:"1" type:"string"`

	// The current state of this app monitor.
	State *string `type:"string" enum:"StateEnum"`
	// contains filtered or unexported fields
}

A structure that includes some data about app monitors and their settings.

func (AppMonitorSummary) GoString 

func (s AppMonitorSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AppMonitorSummary) SetCreated 

func (s *AppMonitorSummary) SetCreated(v string) *AppMonitorSummary

SetCreated sets the Created field's value.

func (*AppMonitorSummary) SetId 

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

SetId sets the Id field's value.

func (*AppMonitorSummary) SetLastModified 

func (s *AppMonitorSummary) SetLastModified(v string) *AppMonitorSummary

SetLastModified sets the LastModified field's value.

func (*AppMonitorSummary) SetName 

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

SetName sets the Name field's value.

func (*AppMonitorSummary) SetState 

func (s *AppMonitorSummary) SetState(v string) *AppMonitorSummary

SetState sets the State field's value.

func (AppMonitorSummary) String 

func (s AppMonitorSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchCreateRumMetricDefinitionsError added in v1.44.120 

type BatchCreateRumMetricDefinitionsError struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	// The error message for this metric definition.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `type:"string" required:"true"`

	// The metric definition that caused this error.
	//
	// MetricDefinition is a required field
	MetricDefinition *MetricDefinitionRequest `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A structure that defines one error caused by a BatchCreateRumMetricsDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html) operation.

func (BatchCreateRumMetricDefinitionsError) GoString added in v1.44.120 

func (s BatchCreateRumMetricDefinitionsError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchCreateRumMetricDefinitionsError) SetErrorCode added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsError) SetErrorCode(v string) *BatchCreateRumMetricDefinitionsError

SetErrorCode sets the ErrorCode field's value.

func (*BatchCreateRumMetricDefinitionsError) SetErrorMessage added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsError) SetErrorMessage(v string) *BatchCreateRumMetricDefinitionsError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchCreateRumMetricDefinitionsError) SetMetricDefinition added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsError) SetMetricDefinition(v *MetricDefinitionRequest) *BatchCreateRumMetricDefinitionsError

SetMetricDefinition sets the MetricDefinition field's value.

func (BatchCreateRumMetricDefinitionsError) String added in v1.44.120 

func (s BatchCreateRumMetricDefinitionsError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchCreateRumMetricDefinitionsInput added in v1.44.120 

type BatchCreateRumMetricDefinitionsInput struct {

	// The name of the CloudWatch RUM app monitor that is to send the metrics.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// The destination to send the metrics to. Valid values are CloudWatch and Evidently.
	// If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently
	// experiment that will receive the metrics and an IAM role that has permission
	// to write to the experiment.
	//
	// Destination is a required field
	Destination *string `type:"string" required:"true" enum:"MetricDestination"`

	// This parameter is required if Destination is Evidently. If Destination is
	// CloudWatch, do not use this parameter.
	//
	// This parameter specifies the ARN of the Evidently experiment that is to receive
	// the metrics. You must have already defined this experiment as a valid destination.
	// For more information, see PutRumMetricsDestination (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html).
	DestinationArn *string `type:"string"`

	// An array of structures which define the metrics that you want to send.
	//
	// MetricDefinitions is a required field
	MetricDefinitions []*MetricDefinitionRequest `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchCreateRumMetricDefinitionsInput) GoString added in v1.44.120 

func (s BatchCreateRumMetricDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchCreateRumMetricDefinitionsInput) SetAppMonitorName added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsInput) SetAppMonitorName(v string) *BatchCreateRumMetricDefinitionsInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*BatchCreateRumMetricDefinitionsInput) SetDestination added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsInput) SetDestination(v string) *BatchCreateRumMetricDefinitionsInput

SetDestination sets the Destination field's value.

func (*BatchCreateRumMetricDefinitionsInput) SetDestinationArn added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsInput) SetDestinationArn(v string) *BatchCreateRumMetricDefinitionsInput

SetDestinationArn sets the DestinationArn field's value.

func (*BatchCreateRumMetricDefinitionsInput) SetMetricDefinitions added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsInput) SetMetricDefinitions(v []*MetricDefinitionRequest) *BatchCreateRumMetricDefinitionsInput

SetMetricDefinitions sets the MetricDefinitions field's value.

func (BatchCreateRumMetricDefinitionsInput) String added in v1.44.120 

func (s BatchCreateRumMetricDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchCreateRumMetricDefinitionsInput) Validate added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsInput) Validate() error

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

type BatchCreateRumMetricDefinitionsOutput added in v1.44.120 

type BatchCreateRumMetricDefinitionsOutput struct {

	// An array of error objects, if the operation caused any errors.
	//
	// Errors is a required field
	Errors []*BatchCreateRumMetricDefinitionsError `type:"list" required:"true"`

	// An array of structures that define the extended metrics.
	MetricDefinitions []*MetricDefinition `type:"list"`
	// contains filtered or unexported fields
}

func (BatchCreateRumMetricDefinitionsOutput) GoString added in v1.44.120 

func (s BatchCreateRumMetricDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchCreateRumMetricDefinitionsOutput) SetErrors added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsOutput) SetErrors(v []*BatchCreateRumMetricDefinitionsError) *BatchCreateRumMetricDefinitionsOutput

SetErrors sets the Errors field's value.

func (*BatchCreateRumMetricDefinitionsOutput) SetMetricDefinitions added in v1.44.120 

func (s *BatchCreateRumMetricDefinitionsOutput) SetMetricDefinitions(v []*MetricDefinition) *BatchCreateRumMetricDefinitionsOutput

SetMetricDefinitions sets the MetricDefinitions field's value.

func (BatchCreateRumMetricDefinitionsOutput) String added in v1.44.120 

func (s BatchCreateRumMetricDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteRumMetricDefinitionsError added in v1.44.120 

type BatchDeleteRumMetricDefinitionsError struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	// The error message for this metric definition.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `type:"string" required:"true"`

	// The ID of the metric definition that caused this error.
	//
	// MetricDefinitionId is a required field
	MetricDefinitionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure that defines one error caused by a BatchCreateRumMetricsDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchDeleteRumMetricsDefinitions.html) operation.

func (BatchDeleteRumMetricDefinitionsError) GoString added in v1.44.120 

func (s BatchDeleteRumMetricDefinitionsError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteRumMetricDefinitionsError) SetErrorCode added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsError) SetErrorCode(v string) *BatchDeleteRumMetricDefinitionsError

SetErrorCode sets the ErrorCode field's value.

func (*BatchDeleteRumMetricDefinitionsError) SetErrorMessage added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsError) SetErrorMessage(v string) *BatchDeleteRumMetricDefinitionsError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchDeleteRumMetricDefinitionsError) SetMetricDefinitionId added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsError) SetMetricDefinitionId(v string) *BatchDeleteRumMetricDefinitionsError

SetMetricDefinitionId sets the MetricDefinitionId field's value.

func (BatchDeleteRumMetricDefinitionsError) String added in v1.44.120 

func (s BatchDeleteRumMetricDefinitionsError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDeleteRumMetricDefinitionsInput added in v1.44.120 

type BatchDeleteRumMetricDefinitionsInput struct {

	// The name of the CloudWatch RUM app monitor that is sending these metrics.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// Defines the destination where you want to stop sending the specified metrics.
	// Valid values are CloudWatch and Evidently. If you specify Evidently, you
	// must also specify the ARN of the CloudWatchEvidently experiment that is to
	// be the destination and an IAM role that has permission to write to the experiment.
	//
	// Destination is a required field
	Destination *string `location:"querystring" locationName:"destination" type:"string" required:"true" enum:"MetricDestination"`

	// This parameter is required if Destination is Evidently. If Destination is
	// CloudWatch, do not use this parameter.
	//
	// This parameter specifies the ARN of the Evidently experiment that was receiving
	// the metrics that are being deleted.
	DestinationArn *string `location:"querystring" locationName:"destinationArn" type:"string"`

	// An array of structures which define the metrics that you want to stop sending.
	//
	// MetricDefinitionIds is a required field
	MetricDefinitionIds []*string `location:"querystring" locationName:"metricDefinitionIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDeleteRumMetricDefinitionsInput) GoString added in v1.44.120 

func (s BatchDeleteRumMetricDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteRumMetricDefinitionsInput) SetAppMonitorName added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsInput) SetAppMonitorName(v string) *BatchDeleteRumMetricDefinitionsInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*BatchDeleteRumMetricDefinitionsInput) SetDestination added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsInput) SetDestination(v string) *BatchDeleteRumMetricDefinitionsInput

SetDestination sets the Destination field's value.

func (*BatchDeleteRumMetricDefinitionsInput) SetDestinationArn added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsInput) SetDestinationArn(v string) *BatchDeleteRumMetricDefinitionsInput

SetDestinationArn sets the DestinationArn field's value.

func (*BatchDeleteRumMetricDefinitionsInput) SetMetricDefinitionIds added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsInput) SetMetricDefinitionIds(v []*string) *BatchDeleteRumMetricDefinitionsInput

SetMetricDefinitionIds sets the MetricDefinitionIds field's value.

func (BatchDeleteRumMetricDefinitionsInput) String added in v1.44.120 

func (s BatchDeleteRumMetricDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteRumMetricDefinitionsInput) Validate added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsInput) Validate() error

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

type BatchDeleteRumMetricDefinitionsOutput added in v1.44.120 

type BatchDeleteRumMetricDefinitionsOutput struct {

	// An array of error objects, if the operation caused any errors.
	//
	// Errors is a required field
	Errors []*BatchDeleteRumMetricDefinitionsError `type:"list" required:"true"`

	// The IDs of the metric definitions that were deleted.
	MetricDefinitionIds []*string `type:"list"`
	// contains filtered or unexported fields
}

func (BatchDeleteRumMetricDefinitionsOutput) GoString added in v1.44.120 

func (s BatchDeleteRumMetricDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDeleteRumMetricDefinitionsOutput) SetErrors added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsOutput) SetErrors(v []*BatchDeleteRumMetricDefinitionsError) *BatchDeleteRumMetricDefinitionsOutput

SetErrors sets the Errors field's value.

func (*BatchDeleteRumMetricDefinitionsOutput) SetMetricDefinitionIds added in v1.44.120 

func (s *BatchDeleteRumMetricDefinitionsOutput) SetMetricDefinitionIds(v []*string) *BatchDeleteRumMetricDefinitionsOutput

SetMetricDefinitionIds sets the MetricDefinitionIds field's value.

func (BatchDeleteRumMetricDefinitionsOutput) String added in v1.44.120 

func (s BatchDeleteRumMetricDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetRumMetricDefinitionsInput added in v1.44.120 

type BatchGetRumMetricDefinitionsInput struct {

	// The name of the CloudWatch RUM app monitor that is sending the metrics.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// The type of destination that you want to view metrics for. Valid values are
	// CloudWatch and Evidently.
	//
	// Destination is a required field
	Destination *string `location:"querystring" locationName:"destination" type:"string" required:"true" enum:"MetricDestination"`

	// This parameter is required if Destination is Evidently. If Destination is
	// CloudWatch, do not use this parameter.
	//
	// This parameter specifies the ARN of the Evidently experiment that corresponds
	// to the destination.
	DestinationArn *string `location:"querystring" locationName:"destinationArn" type:"string"`

	// The maximum number of results to return in one operation. The default is
	// 50. The maximum that you can specify is 100.
	//
	// To retrieve the remaining results, make another call with the returned NextToken
	// value.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Use the token returned by the previous operation to request the next page
	// of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (BatchGetRumMetricDefinitionsInput) GoString added in v1.44.120 

func (s BatchGetRumMetricDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRumMetricDefinitionsInput) SetAppMonitorName added in v1.44.120 

func (s *BatchGetRumMetricDefinitionsInput) SetAppMonitorName(v string) *BatchGetRumMetricDefinitionsInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*BatchGetRumMetricDefinitionsInput) SetDestination added in v1.44.120 

func (s *BatchGetRumMetricDefinitionsInput) SetDestination(v string) *BatchGetRumMetricDefinitionsInput

SetDestination sets the Destination field's value.

func (*BatchGetRumMetricDefinitionsInput) SetDestinationArn added in v1.44.120 

func (s *BatchGetRumMetricDefinitionsInput) SetDestinationArn(v string) *BatchGetRumMetricDefinitionsInput

SetDestinationArn sets the DestinationArn field's value.

func (*BatchGetRumMetricDefinitionsInput) SetMaxResults added in v1.44.120 

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

SetMaxResults sets the MaxResults field's value.

func (*BatchGetRumMetricDefinitionsInput) SetNextToken added in v1.44.120 

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

SetNextToken sets the NextToken field's value.

func (BatchGetRumMetricDefinitionsInput) String added in v1.44.120 

func (s BatchGetRumMetricDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRumMetricDefinitionsInput) Validate added in v1.44.120 

func (s *BatchGetRumMetricDefinitionsInput) Validate() error

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

type BatchGetRumMetricDefinitionsOutput added in v1.44.120 

type BatchGetRumMetricDefinitionsOutput struct {

	// An array of structures that display information about the metrics that are
	// sent by the specified app monitor to the specified destination.
	MetricDefinitions []*MetricDefinition `type:"list"`

	// A token that you can use in a subsequent operation to retrieve the next set
	// of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (BatchGetRumMetricDefinitionsOutput) GoString added in v1.44.120 

func (s BatchGetRumMetricDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetRumMetricDefinitionsOutput) SetMetricDefinitions added in v1.44.120 

func (s *BatchGetRumMetricDefinitionsOutput) SetMetricDefinitions(v []*MetricDefinition) *BatchGetRumMetricDefinitionsOutput

SetMetricDefinitions sets the MetricDefinitions field's value.

func (*BatchGetRumMetricDefinitionsOutput) SetNextToken added in v1.44.120 

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

SetNextToken sets the NextToken field's value.

func (BatchGetRumMetricDefinitionsOutput) String added in v1.44.120 

func (s BatchGetRumMetricDefinitionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchRUM 

type CloudWatchRUM struct {
	*client.Client
}

CloudWatchRUM provides the API operation methods for making requests to CloudWatch RUM. See this package's package overview docs for details on the service.

CloudWatchRUM 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) *CloudWatchRUM

New creates a new instance of the CloudWatchRUM 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 CloudWatchRUM client from just a session.
svc := cloudwatchrum.New(mySession)

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

func (*CloudWatchRUM) BatchCreateRumMetricDefinitions added in v1.44.120 

func (c *CloudWatchRUM) BatchCreateRumMetricDefinitions(input *BatchCreateRumMetricDefinitionsInput) (*BatchCreateRumMetricDefinitionsOutput, error)

BatchCreateRumMetricDefinitions API operation for CloudWatch RUM.

Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.

By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html).

If you also send extended metrics, you can send metrics to Evidently as well as CloudWatch, and you can also optionally send the metrics with additional dimensions. The valid dimension names for the additional dimensions are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html).

The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.

The maximum number of metric definitions that one destination can contain is 2000.

Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).

You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html).

If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.

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 CloudWatch RUM's API operation BatchCreateRumMetricDefinitions for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchCreateRumMetricDefinitions

func (*CloudWatchRUM) BatchCreateRumMetricDefinitionsRequest added in v1.44.120 

func (c *CloudWatchRUM) BatchCreateRumMetricDefinitionsRequest(input *BatchCreateRumMetricDefinitionsInput) (req *request.Request, output *BatchCreateRumMetricDefinitionsOutput)

BatchCreateRumMetricDefinitionsRequest generates a "aws/request.Request" representing the client's request for the BatchCreateRumMetricDefinitions 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 BatchCreateRumMetricDefinitions for more information on using the BatchCreateRumMetricDefinitions 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 BatchCreateRumMetricDefinitionsRequest method.
req, resp := client.BatchCreateRumMetricDefinitionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchCreateRumMetricDefinitions

func (*CloudWatchRUM) BatchCreateRumMetricDefinitionsWithContext added in v1.44.120 

func (c *CloudWatchRUM) BatchCreateRumMetricDefinitionsWithContext(ctx aws.Context, input *BatchCreateRumMetricDefinitionsInput, opts ...request.Option) (*BatchCreateRumMetricDefinitionsOutput, error)

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

See BatchCreateRumMetricDefinitions 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.

func (*CloudWatchRUM) BatchDeleteRumMetricDefinitions added in v1.44.120 

func (c *CloudWatchRUM) BatchDeleteRumMetricDefinitions(input *BatchDeleteRumMetricDefinitionsInput) (*BatchDeleteRumMetricDefinitionsOutput, error)

BatchDeleteRumMetricDefinitions API operation for CloudWatch RUM.

Removes the specified metrics from being sent to an extended metrics destination.

If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.

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 CloudWatch RUM's API operation BatchDeleteRumMetricDefinitions for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchDeleteRumMetricDefinitions

func (*CloudWatchRUM) BatchDeleteRumMetricDefinitionsRequest added in v1.44.120 

func (c *CloudWatchRUM) BatchDeleteRumMetricDefinitionsRequest(input *BatchDeleteRumMetricDefinitionsInput) (req *request.Request, output *BatchDeleteRumMetricDefinitionsOutput)

BatchDeleteRumMetricDefinitionsRequest generates a "aws/request.Request" representing the client's request for the BatchDeleteRumMetricDefinitions 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 BatchDeleteRumMetricDefinitions for more information on using the BatchDeleteRumMetricDefinitions 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 BatchDeleteRumMetricDefinitionsRequest method.
req, resp := client.BatchDeleteRumMetricDefinitionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchDeleteRumMetricDefinitions

func (*CloudWatchRUM) BatchDeleteRumMetricDefinitionsWithContext added in v1.44.120 

func (c *CloudWatchRUM) BatchDeleteRumMetricDefinitionsWithContext(ctx aws.Context, input *BatchDeleteRumMetricDefinitionsInput, opts ...request.Option) (*BatchDeleteRumMetricDefinitionsOutput, error)

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

See BatchDeleteRumMetricDefinitions 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.

func (*CloudWatchRUM) BatchGetRumMetricDefinitions added in v1.44.120 

func (c *CloudWatchRUM) BatchGetRumMetricDefinitions(input *BatchGetRumMetricDefinitionsInput) (*BatchGetRumMetricDefinitionsOutput, error)

BatchGetRumMetricDefinitions API operation for CloudWatch RUM.

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

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 CloudWatch RUM's API operation BatchGetRumMetricDefinitions for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchGetRumMetricDefinitions

func (*CloudWatchRUM) BatchGetRumMetricDefinitionsPages added in v1.44.120 

func (c *CloudWatchRUM) BatchGetRumMetricDefinitionsPages(input *BatchGetRumMetricDefinitionsInput, fn func(*BatchGetRumMetricDefinitionsOutput, bool) bool) error

BatchGetRumMetricDefinitionsPages iterates over the pages of a BatchGetRumMetricDefinitions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See BatchGetRumMetricDefinitions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a BatchGetRumMetricDefinitions operation.
pageNum := 0
err := client.BatchGetRumMetricDefinitionsPages(params,
    func(page *cloudwatchrum.BatchGetRumMetricDefinitionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchRUM) BatchGetRumMetricDefinitionsPagesWithContext added in v1.44.120 

func (c *CloudWatchRUM) BatchGetRumMetricDefinitionsPagesWithContext(ctx aws.Context, input *BatchGetRumMetricDefinitionsInput, fn func(*BatchGetRumMetricDefinitionsOutput, bool) bool, opts ...request.Option) error

BatchGetRumMetricDefinitionsPagesWithContext same as BatchGetRumMetricDefinitionsPages except it takes a Context and allows setting request options on the pages.

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.

func (*CloudWatchRUM) BatchGetRumMetricDefinitionsRequest added in v1.44.120 

func (c *CloudWatchRUM) BatchGetRumMetricDefinitionsRequest(input *BatchGetRumMetricDefinitionsInput) (req *request.Request, output *BatchGetRumMetricDefinitionsOutput)

BatchGetRumMetricDefinitionsRequest generates a "aws/request.Request" representing the client's request for the BatchGetRumMetricDefinitions 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 BatchGetRumMetricDefinitions for more information on using the BatchGetRumMetricDefinitions 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 BatchGetRumMetricDefinitionsRequest method.
req, resp := client.BatchGetRumMetricDefinitionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/BatchGetRumMetricDefinitions

func (*CloudWatchRUM) BatchGetRumMetricDefinitionsWithContext added in v1.44.120 

func (c *CloudWatchRUM) BatchGetRumMetricDefinitionsWithContext(ctx aws.Context, input *BatchGetRumMetricDefinitionsInput, opts ...request.Option) (*BatchGetRumMetricDefinitionsOutput, error)

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

See BatchGetRumMetricDefinitions 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.

func (*CloudWatchRUM) CreateAppMonitor 

func (c *CloudWatchRUM) CreateAppMonitor(input *CreateAppMonitorInput) (*CreateAppMonitorOutput, error)

CreateAppMonitor API operation for CloudWatch RUM.

Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_UpdateAppMonitor.html) instead.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html)

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 CloudWatch RUM's API operation CreateAppMonitor for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/CreateAppMonitor

func (*CloudWatchRUM) CreateAppMonitorRequest 

func (c *CloudWatchRUM) CreateAppMonitorRequest(input *CreateAppMonitorInput) (req *request.Request, output *CreateAppMonitorOutput)

CreateAppMonitorRequest generates a "aws/request.Request" representing the client's request for the CreateAppMonitor 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 CreateAppMonitor for more information on using the CreateAppMonitor 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 CreateAppMonitorRequest method.
req, resp := client.CreateAppMonitorRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/CreateAppMonitor

func (*CloudWatchRUM) CreateAppMonitorWithContext 

func (c *CloudWatchRUM) CreateAppMonitorWithContext(ctx aws.Context, input *CreateAppMonitorInput, opts ...request.Option) (*CreateAppMonitorOutput, error)

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

See CreateAppMonitor 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.

func (*CloudWatchRUM) DeleteAppMonitor 

func (c *CloudWatchRUM) DeleteAppMonitor(input *DeleteAppMonitorInput) (*DeleteAppMonitorOutput, error)

DeleteAppMonitor API operation for CloudWatch RUM.

Deletes an existing app monitor. This immediately stops the collection of data.

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 CloudWatch RUM's API operation DeleteAppMonitor for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/DeleteAppMonitor

func (*CloudWatchRUM) DeleteAppMonitorRequest 

func (c *CloudWatchRUM) DeleteAppMonitorRequest(input *DeleteAppMonitorInput) (req *request.Request, output *DeleteAppMonitorOutput)

DeleteAppMonitorRequest generates a "aws/request.Request" representing the client's request for the DeleteAppMonitor 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 DeleteAppMonitor for more information on using the DeleteAppMonitor 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 DeleteAppMonitorRequest method.
req, resp := client.DeleteAppMonitorRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/DeleteAppMonitor

func (*CloudWatchRUM) DeleteAppMonitorWithContext 

func (c *CloudWatchRUM) DeleteAppMonitorWithContext(ctx aws.Context, input *DeleteAppMonitorInput, opts ...request.Option) (*DeleteAppMonitorOutput, error)

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

See DeleteAppMonitor 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.

func (*CloudWatchRUM) DeleteRumMetricsDestination added in v1.44.120 

func (c *CloudWatchRUM) DeleteRumMetricsDestination(input *DeleteRumMetricsDestinationInput) (*DeleteRumMetricsDestinationOutput, error)

DeleteRumMetricsDestination API operation for CloudWatch RUM.

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

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 CloudWatch RUM's API operation DeleteRumMetricsDestination for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/DeleteRumMetricsDestination

func (*CloudWatchRUM) DeleteRumMetricsDestinationRequest added in v1.44.120 

func (c *CloudWatchRUM) DeleteRumMetricsDestinationRequest(input *DeleteRumMetricsDestinationInput) (req *request.Request, output *DeleteRumMetricsDestinationOutput)

DeleteRumMetricsDestinationRequest generates a "aws/request.Request" representing the client's request for the DeleteRumMetricsDestination 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 DeleteRumMetricsDestination for more information on using the DeleteRumMetricsDestination 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 DeleteRumMetricsDestinationRequest method.
req, resp := client.DeleteRumMetricsDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/DeleteRumMetricsDestination

func (*CloudWatchRUM) DeleteRumMetricsDestinationWithContext added in v1.44.120 

func (c *CloudWatchRUM) DeleteRumMetricsDestinationWithContext(ctx aws.Context, input *DeleteRumMetricsDestinationInput, opts ...request.Option) (*DeleteRumMetricsDestinationOutput, error)

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

See DeleteRumMetricsDestination 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.

func (*CloudWatchRUM) GetAppMonitor 

func (c *CloudWatchRUM) GetAppMonitor(input *GetAppMonitorInput) (*GetAppMonitorOutput, error)

GetAppMonitor API operation for CloudWatch RUM.

Retrieves the complete configuration information for one app monitor.

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 CloudWatch RUM's API operation GetAppMonitor for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/GetAppMonitor

func (*CloudWatchRUM) GetAppMonitorData 

func (c *CloudWatchRUM) GetAppMonitorData(input *GetAppMonitorDataInput) (*GetAppMonitorDataOutput, error)

GetAppMonitorData API operation for CloudWatch RUM.

Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.

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 CloudWatch RUM's API operation GetAppMonitorData for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/GetAppMonitorData

func (*CloudWatchRUM) GetAppMonitorDataPages 

func (c *CloudWatchRUM) GetAppMonitorDataPages(input *GetAppMonitorDataInput, fn func(*GetAppMonitorDataOutput, bool) bool) error

GetAppMonitorDataPages iterates over the pages of a GetAppMonitorData operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetAppMonitorData method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetAppMonitorData operation.
pageNum := 0
err := client.GetAppMonitorDataPages(params,
    func(page *cloudwatchrum.GetAppMonitorDataOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchRUM) GetAppMonitorDataPagesWithContext 

func (c *CloudWatchRUM) GetAppMonitorDataPagesWithContext(ctx aws.Context, input *GetAppMonitorDataInput, fn func(*GetAppMonitorDataOutput, bool) bool, opts ...request.Option) error

GetAppMonitorDataPagesWithContext same as GetAppMonitorDataPages except it takes a Context and allows setting request options on the pages.

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.

func (*CloudWatchRUM) GetAppMonitorDataRequest 

func (c *CloudWatchRUM) GetAppMonitorDataRequest(input *GetAppMonitorDataInput) (req *request.Request, output *GetAppMonitorDataOutput)

GetAppMonitorDataRequest generates a "aws/request.Request" representing the client's request for the GetAppMonitorData 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 GetAppMonitorData for more information on using the GetAppMonitorData 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 GetAppMonitorDataRequest method.
req, resp := client.GetAppMonitorDataRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/GetAppMonitorData

func (*CloudWatchRUM) GetAppMonitorDataWithContext 

func (c *CloudWatchRUM) GetAppMonitorDataWithContext(ctx aws.Context, input *GetAppMonitorDataInput, opts ...request.Option) (*GetAppMonitorDataOutput, error)

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

See GetAppMonitorData 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.

func (*CloudWatchRUM) GetAppMonitorRequest 

func (c *CloudWatchRUM) GetAppMonitorRequest(input *GetAppMonitorInput) (req *request.Request, output *GetAppMonitorOutput)

GetAppMonitorRequest generates a "aws/request.Request" representing the client's request for the GetAppMonitor 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 GetAppMonitor for more information on using the GetAppMonitor 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 GetAppMonitorRequest method.
req, resp := client.GetAppMonitorRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/GetAppMonitor

func (*CloudWatchRUM) GetAppMonitorWithContext 

func (c *CloudWatchRUM) GetAppMonitorWithContext(ctx aws.Context, input *GetAppMonitorInput, opts ...request.Option) (*GetAppMonitorOutput, error)

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

See GetAppMonitor 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.

func (*CloudWatchRUM) ListAppMonitors 

func (c *CloudWatchRUM) ListAppMonitors(input *ListAppMonitorsInput) (*ListAppMonitorsOutput, error)

ListAppMonitors API operation for CloudWatch RUM.

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

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 CloudWatch RUM's API operation ListAppMonitors for usage and error information.

Returned Error Types:

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListAppMonitors

func (*CloudWatchRUM) ListAppMonitorsPages 

func (c *CloudWatchRUM) ListAppMonitorsPages(input *ListAppMonitorsInput, fn func(*ListAppMonitorsOutput, bool) bool) error

ListAppMonitorsPages iterates over the pages of a ListAppMonitors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAppMonitors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAppMonitors operation.
pageNum := 0
err := client.ListAppMonitorsPages(params,
    func(page *cloudwatchrum.ListAppMonitorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchRUM) ListAppMonitorsPagesWithContext 

func (c *CloudWatchRUM) ListAppMonitorsPagesWithContext(ctx aws.Context, input *ListAppMonitorsInput, fn func(*ListAppMonitorsOutput, bool) bool, opts ...request.Option) error

ListAppMonitorsPagesWithContext same as ListAppMonitorsPages except it takes a Context and allows setting request options on the pages.

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.

func (*CloudWatchRUM) ListAppMonitorsRequest 

func (c *CloudWatchRUM) ListAppMonitorsRequest(input *ListAppMonitorsInput) (req *request.Request, output *ListAppMonitorsOutput)

ListAppMonitorsRequest generates a "aws/request.Request" representing the client's request for the ListAppMonitors 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 ListAppMonitors for more information on using the ListAppMonitors 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 ListAppMonitorsRequest method.
req, resp := client.ListAppMonitorsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListAppMonitors

func (*CloudWatchRUM) ListAppMonitorsWithContext 

func (c *CloudWatchRUM) ListAppMonitorsWithContext(ctx aws.Context, input *ListAppMonitorsInput, opts ...request.Option) (*ListAppMonitorsOutput, error)

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

See ListAppMonitors 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.

func (*CloudWatchRUM) ListRumMetricsDestinations added in v1.44.120 

func (c *CloudWatchRUM) ListRumMetricsDestinations(input *ListRumMetricsDestinationsInput) (*ListRumMetricsDestinationsOutput, error)

ListRumMetricsDestinations API operation for CloudWatch RUM.

Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor.

For more information about extended metrics, see AddRumMetrics (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrcs.html).

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 CloudWatch RUM's API operation ListRumMetricsDestinations for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListRumMetricsDestinations

func (*CloudWatchRUM) ListRumMetricsDestinationsPages added in v1.44.120 

func (c *CloudWatchRUM) ListRumMetricsDestinationsPages(input *ListRumMetricsDestinationsInput, fn func(*ListRumMetricsDestinationsOutput, bool) bool) error

ListRumMetricsDestinationsPages iterates over the pages of a ListRumMetricsDestinations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRumMetricsDestinations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListRumMetricsDestinations operation.
pageNum := 0
err := client.ListRumMetricsDestinationsPages(params,
    func(page *cloudwatchrum.ListRumMetricsDestinationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudWatchRUM) ListRumMetricsDestinationsPagesWithContext added in v1.44.120 

func (c *CloudWatchRUM) ListRumMetricsDestinationsPagesWithContext(ctx aws.Context, input *ListRumMetricsDestinationsInput, fn func(*ListRumMetricsDestinationsOutput, bool) bool, opts ...request.Option) error

ListRumMetricsDestinationsPagesWithContext same as ListRumMetricsDestinationsPages except it takes a Context and allows setting request options on the pages.

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.

func (*CloudWatchRUM) ListRumMetricsDestinationsRequest added in v1.44.120 

func (c *CloudWatchRUM) ListRumMetricsDestinationsRequest(input *ListRumMetricsDestinationsInput) (req *request.Request, output *ListRumMetricsDestinationsOutput)

ListRumMetricsDestinationsRequest generates a "aws/request.Request" representing the client's request for the ListRumMetricsDestinations 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 ListRumMetricsDestinations for more information on using the ListRumMetricsDestinations 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 ListRumMetricsDestinationsRequest method.
req, resp := client.ListRumMetricsDestinationsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListRumMetricsDestinations

func (*CloudWatchRUM) ListRumMetricsDestinationsWithContext added in v1.44.120 

func (c *CloudWatchRUM) ListRumMetricsDestinationsWithContext(ctx aws.Context, input *ListRumMetricsDestinationsInput, opts ...request.Option) (*ListRumMetricsDestinationsOutput, error)

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

See ListRumMetricsDestinations 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.

func (*CloudWatchRUM) ListTagsForResource 

func (c *CloudWatchRUM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for CloudWatch RUM.

Displays the tags associated with a CloudWatch RUM resource.

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 CloudWatch RUM's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListTagsForResource

func (*CloudWatchRUM) ListTagsForResourceRequest 

func (c *CloudWatchRUM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/ListTagsForResource

func (*CloudWatchRUM) ListTagsForResourceWithContext 

func (c *CloudWatchRUM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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.

func (*CloudWatchRUM) PutRumEvents 

func (c *CloudWatchRUM) PutRumEvents(input *PutRumEventsInput) (*PutRumEventsOutput, error)

PutRumEvents API operation for CloudWatch RUM.

Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM.

Each PutRumEvents operation can send a batch of events from one user session.

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 CloudWatch RUM's API operation PutRumEvents for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumEvents

func (*CloudWatchRUM) PutRumEventsRequest 

func (c *CloudWatchRUM) PutRumEventsRequest(input *PutRumEventsInput) (req *request.Request, output *PutRumEventsOutput)

PutRumEventsRequest generates a "aws/request.Request" representing the client's request for the PutRumEvents 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 PutRumEvents for more information on using the PutRumEvents 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 PutRumEventsRequest method.
req, resp := client.PutRumEventsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumEvents

func (*CloudWatchRUM) PutRumEventsWithContext 

func (c *CloudWatchRUM) PutRumEventsWithContext(ctx aws.Context, input *PutRumEventsInput, opts ...request.Option) (*PutRumEventsOutput, error)

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

See PutRumEvents 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.

func (*CloudWatchRUM) PutRumMetricsDestination added in v1.44.120 

func (c *CloudWatchRUM) PutRumMetricsDestination(input *PutRumMetricsDestinationInput) (*PutRumMetricsDestinationOutput, error)

PutRumMetricsDestination API operation for CloudWatch RUM.

Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

For more information about extended metrics, see AddRumMetrics (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_AddRumMetrics.html).

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 CloudWatch RUM's API operation PutRumMetricsDestination for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumMetricsDestination

func (*CloudWatchRUM) PutRumMetricsDestinationRequest added in v1.44.120 

func (c *CloudWatchRUM) PutRumMetricsDestinationRequest(input *PutRumMetricsDestinationInput) (req *request.Request, output *PutRumMetricsDestinationOutput)

PutRumMetricsDestinationRequest generates a "aws/request.Request" representing the client's request for the PutRumMetricsDestination 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 PutRumMetricsDestination for more information on using the PutRumMetricsDestination 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 PutRumMetricsDestinationRequest method.
req, resp := client.PutRumMetricsDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/PutRumMetricsDestination

func (*CloudWatchRUM) PutRumMetricsDestinationWithContext added in v1.44.120 

func (c *CloudWatchRUM) PutRumMetricsDestinationWithContext(ctx aws.Context, input *PutRumMetricsDestinationInput, opts ...request.Option) (*PutRumMetricsDestinationOutput, error)

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

See PutRumMetricsDestination 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.

func (*CloudWatchRUM) TagResource 

func (c *CloudWatchRUM) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for CloudWatch RUM.

Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).

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 CloudWatch RUM's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/TagResource

func (*CloudWatchRUM) TagResourceRequest 

func (c *CloudWatchRUM) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/TagResource

func (*CloudWatchRUM) TagResourceWithContext 

func (c *CloudWatchRUM) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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.

func (*CloudWatchRUM) UntagResource 

func (c *CloudWatchRUM) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for CloudWatch RUM.

Removes one or more tags from the specified resource.

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 CloudWatch RUM's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UntagResource

func (*CloudWatchRUM) UntagResourceRequest 

func (c *CloudWatchRUM) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UntagResource

func (*CloudWatchRUM) UntagResourceWithContext 

func (c *CloudWatchRUM) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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.

func (*CloudWatchRUM) UpdateAppMonitor 

func (c *CloudWatchRUM) UpdateAppMonitor(input *UpdateAppMonitorInput) (*UpdateAppMonitorOutput, error)

UpdateAppMonitor API operation for CloudWatch RUM.

Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept.

You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_TagResource.html).

To create a new app monitor, use CreateAppMonitor (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_CreateAppMonitor.html).

After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated? (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-find-code-snippet.html)

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 CloudWatch RUM's API operation UpdateAppMonitor for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UpdateAppMonitor

func (*CloudWatchRUM) UpdateAppMonitorRequest 

func (c *CloudWatchRUM) UpdateAppMonitorRequest(input *UpdateAppMonitorInput) (req *request.Request, output *UpdateAppMonitorOutput)

UpdateAppMonitorRequest generates a "aws/request.Request" representing the client's request for the UpdateAppMonitor 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 UpdateAppMonitor for more information on using the UpdateAppMonitor 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 UpdateAppMonitorRequest method.
req, resp := client.UpdateAppMonitorRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UpdateAppMonitor

func (*CloudWatchRUM) UpdateAppMonitorWithContext 

func (c *CloudWatchRUM) UpdateAppMonitorWithContext(ctx aws.Context, input *UpdateAppMonitorInput, opts ...request.Option) (*UpdateAppMonitorOutput, error)

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

See UpdateAppMonitor 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.

func (*CloudWatchRUM) UpdateRumMetricDefinition added in v1.44.120 

func (c *CloudWatchRUM) UpdateRumMetricDefinition(input *UpdateRumMetricDefinitionInput) (*UpdateRumMetricDefinitionOutput, error)

UpdateRumMetricDefinition API operation for CloudWatch RUM.

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricsDefinitions.html).

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 CloudWatch RUM's API operation UpdateRumMetricDefinition for usage and error information.

Returned Error Types:

  • ConflictException This operation attempted to create a resource that already exists.

  • ServiceQuotaExceededException This request exceeds a service quota.

  • ResourceNotFoundException Resource not found.

  • InternalServerException Internal service exception.

  • ValidationException One of the arguments for the request is not valid.

  • ThrottlingException The request was throttled because of quota limits.

  • AccessDeniedException You don't have sufficient permissions to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UpdateRumMetricDefinition

func (*CloudWatchRUM) UpdateRumMetricDefinitionRequest added in v1.44.120 

func (c *CloudWatchRUM) UpdateRumMetricDefinitionRequest(input *UpdateRumMetricDefinitionInput) (req *request.Request, output *UpdateRumMetricDefinitionOutput)

UpdateRumMetricDefinitionRequest generates a "aws/request.Request" representing the client's request for the UpdateRumMetricDefinition 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 UpdateRumMetricDefinition for more information on using the UpdateRumMetricDefinition 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 UpdateRumMetricDefinitionRequest method.
req, resp := client.UpdateRumMetricDefinitionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/UpdateRumMetricDefinition

func (*CloudWatchRUM) UpdateRumMetricDefinitionWithContext added in v1.44.120 

func (c *CloudWatchRUM) UpdateRumMetricDefinitionWithContext(ctx aws.Context, input *UpdateRumMetricDefinitionInput, opts ...request.Option) (*UpdateRumMetricDefinitionOutput, error)

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

See UpdateRumMetricDefinition 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 ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The name of the resource that is associated with the error.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`

	// The type of the resource that is associated with the error.
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

This operation attempted to create a resource that already exists.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAppMonitorInput 

type CreateAppMonitorInput struct {

	// A structure that contains much of the configuration data for the app monitor.
	// If you are using Amazon Cognito for authorization, you must include this
	// structure in your request, and it must include the ID of the Amazon Cognito
	// identity pool to use for authorization. If you don't include AppMonitorConfiguration,
	// you must set up your own authorization method. For more information, see
	// Authorize your application to send data to Amazon Web Services (https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html).
	//
	// If you omit this argument, the sample rate used for RUM is set to 10% of
	// the user sessions.
	AppMonitorConfiguration *AppMonitorConfiguration `type:"structure"`

	// Specifies whether this app monitor allows the web client to define and send
	// custom events. If you omit this parameter, custom events are DISABLED.
	//
	// For more information about custom events, see Send custom events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html).
	CustomEvents *CustomEvents `type:"structure"`

	// Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter
	// specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch
	// Logs in your account. This enables you to keep the telemetry data for more
	// than 30 days, but it does incur Amazon CloudWatch Logs charges.
	//
	// If you omit this parameter, the default is false.
	CwLogEnabled *bool `type:"boolean"`

	// The top-level internet domain name for which your application has administrative
	// authority.
	//
	// Domain is a required field
	Domain *string `min:"1" type:"string" required:"true"`

	// A name for the app monitor.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Assigns one or more tags (key-value pairs) to the app monitor.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions by granting a user permission to access or
	// change only resources with certain tag values.
	//
	// Tags don't have any semantic meaning to Amazon Web Services and are interpreted
	// strictly as strings of characters.
	//
	// You can associate as many as 50 tags with an app monitor.
	//
	// For more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (CreateAppMonitorInput) GoString 

func (s CreateAppMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppMonitorInput) SetAppMonitorConfiguration 

func (s *CreateAppMonitorInput) SetAppMonitorConfiguration(v *AppMonitorConfiguration) *CreateAppMonitorInput

SetAppMonitorConfiguration sets the AppMonitorConfiguration field's value.

func (*CreateAppMonitorInput) SetCustomEvents added in v1.44.140 

func (s *CreateAppMonitorInput) SetCustomEvents(v *CustomEvents) *CreateAppMonitorInput

SetCustomEvents sets the CustomEvents field's value.

func (*CreateAppMonitorInput) SetCwLogEnabled 

func (s *CreateAppMonitorInput) SetCwLogEnabled(v bool) *CreateAppMonitorInput

SetCwLogEnabled sets the CwLogEnabled field's value.

func (*CreateAppMonitorInput) SetDomain 

func (s *CreateAppMonitorInput) SetDomain(v string) *CreateAppMonitorInput

SetDomain sets the Domain field's value.

func (*CreateAppMonitorInput) SetName 

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

SetName sets the Name field's value.

func (*CreateAppMonitorInput) SetTags 

func (s *CreateAppMonitorInput) SetTags(v map[string]*string) *CreateAppMonitorInput

SetTags sets the Tags field's value.

func (CreateAppMonitorInput) String 

func (s CreateAppMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppMonitorInput) Validate 

func (s *CreateAppMonitorInput) Validate() error

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

type CreateAppMonitorOutput 

type CreateAppMonitorOutput struct {

	// The unique ID of the new app monitor.
	Id *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAppMonitorOutput) GoString 

func (s CreateAppMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAppMonitorOutput) SetId 

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

SetId sets the Id field's value.

func (CreateAppMonitorOutput) String 

func (s CreateAppMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomEvents added in v1.44.140 

type CustomEvents struct {

	// Specifies whether this app monitor allows the web client to define and send
	// custom events. The default is for custom events to be DISABLED.
	Status *string `type:"string" enum:"CustomEventsStatus"`
	// contains filtered or unexported fields
}

A structure that contains information about custom events for this app monitor.

func (CustomEvents) GoString added in v1.44.140 

func (s CustomEvents) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomEvents) SetStatus added in v1.44.140 

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

SetStatus sets the Status field's value.

func (CustomEvents) String added in v1.44.140 

func (s CustomEvents) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CwLog 

type CwLog struct {

	// Indicated whether the app monitor stores copies of the data that RUM collects
	// in CloudWatch Logs.
	CwLogEnabled *bool `type:"boolean"`

	// The name of the log group where the copies are stored.
	CwLogGroup *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.

func (CwLog) GoString 

func (s CwLog) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CwLog) SetCwLogEnabled 

func (s *CwLog) SetCwLogEnabled(v bool) *CwLog

SetCwLogEnabled sets the CwLogEnabled field's value.

func (*CwLog) SetCwLogGroup 

func (s *CwLog) SetCwLogGroup(v string) *CwLog

SetCwLogGroup sets the CwLogGroup field's value.

func (CwLog) String 

func (s CwLog) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataStorage 

type DataStorage struct {

	// A structure that contains the information about whether the app monitor stores
	// copies of the data that RUM collects in CloudWatch Logs. If it does, this
	// structure also contains the name of the log group.
	CwLog *CwLog `type:"structure"`
	// contains filtered or unexported fields
}

A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.

func (DataStorage) GoString 

func (s DataStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataStorage) SetCwLog 

func (s *DataStorage) SetCwLog(v *CwLog) *DataStorage

SetCwLog sets the CwLog field's value.

func (DataStorage) String 

func (s DataStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAppMonitorInput 

type DeleteAppMonitorInput struct {

	// The name of the app monitor to delete.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAppMonitorInput) GoString 

func (s DeleteAppMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppMonitorInput) SetName 

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

SetName sets the Name field's value.

func (DeleteAppMonitorInput) String 

func (s DeleteAppMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAppMonitorInput) Validate 

func (s *DeleteAppMonitorInput) Validate() error

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

type DeleteAppMonitorOutput 

type DeleteAppMonitorOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAppMonitorOutput) GoString 

func (s DeleteAppMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAppMonitorOutput) String 

func (s DeleteAppMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRumMetricsDestinationInput added in v1.44.120 

type DeleteRumMetricsDestinationInput struct {

	// The name of the app monitor that is sending metrics to the destination that
	// you want to delete.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// The type of destination to delete. Valid values are CloudWatch and Evidently.
	//
	// Destination is a required field
	Destination *string `location:"querystring" locationName:"destination" type:"string" required:"true" enum:"MetricDestination"`

	// This parameter is required if Destination is Evidently. If Destination is
	// CloudWatch, do not use this parameter. This parameter specifies the ARN of
	// the Evidently experiment that corresponds to the destination to delete.
	DestinationArn *string `location:"querystring" locationName:"destinationArn" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteRumMetricsDestinationInput) GoString added in v1.44.120 

func (s DeleteRumMetricsDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRumMetricsDestinationInput) SetAppMonitorName added in v1.44.120 

func (s *DeleteRumMetricsDestinationInput) SetAppMonitorName(v string) *DeleteRumMetricsDestinationInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*DeleteRumMetricsDestinationInput) SetDestination added in v1.44.120 

func (s *DeleteRumMetricsDestinationInput) SetDestination(v string) *DeleteRumMetricsDestinationInput

SetDestination sets the Destination field's value.

func (*DeleteRumMetricsDestinationInput) SetDestinationArn added in v1.44.120 

func (s *DeleteRumMetricsDestinationInput) SetDestinationArn(v string) *DeleteRumMetricsDestinationInput

SetDestinationArn sets the DestinationArn field's value.

func (DeleteRumMetricsDestinationInput) String added in v1.44.120 

func (s DeleteRumMetricsDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRumMetricsDestinationInput) Validate added in v1.44.120 

func (s *DeleteRumMetricsDestinationInput) Validate() error

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

type DeleteRumMetricsDestinationOutput added in v1.44.120 

type DeleteRumMetricsDestinationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRumMetricsDestinationOutput) GoString added in v1.44.120 

func (s DeleteRumMetricsDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRumMetricsDestinationOutput) String added in v1.44.120 

func (s DeleteRumMetricsDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAppMonitorDataInput 

type GetAppMonitorDataInput struct {

	// An array of structures that you can use to filter the results to those that
	// match one or more sets of key-value pairs that you specify.
	Filters []*QueryFilter `type:"list"`

	// The maximum number of results to return in one operation.
	MaxResults *int64 `type:"integer"`

	// The name of the app monitor that collected the data that you want to retrieve.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`

	// Use the token returned by the previous operation to request the next page
	// of results.
	NextToken *string `type:"string"`

	// A structure that defines the time range that you want to retrieve results
	// from.
	//
	// TimeRange is a required field
	TimeRange *TimeRange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppMonitorDataInput) GoString 

func (s GetAppMonitorDataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppMonitorDataInput) SetFilters 

func (s *GetAppMonitorDataInput) SetFilters(v []*QueryFilter) *GetAppMonitorDataInput

SetFilters sets the Filters field's value.

func (*GetAppMonitorDataInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*GetAppMonitorDataInput) SetName 

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

SetName sets the Name field's value.

func (*GetAppMonitorDataInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*GetAppMonitorDataInput) SetTimeRange 

func (s *GetAppMonitorDataInput) SetTimeRange(v *TimeRange) *GetAppMonitorDataInput

SetTimeRange sets the TimeRange field's value.

func (GetAppMonitorDataInput) String 

func (s GetAppMonitorDataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppMonitorDataInput) Validate 

func (s *GetAppMonitorDataInput) Validate() error

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

type GetAppMonitorDataOutput 

type GetAppMonitorDataOutput struct {

	// The events that RUM collected that match your request.
	Events []*string `type:"list"`

	// A token that you can use in a subsequent operation to retrieve the next set
	// of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetAppMonitorDataOutput) GoString 

func (s GetAppMonitorDataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppMonitorDataOutput) SetEvents 

func (s *GetAppMonitorDataOutput) SetEvents(v []*string) *GetAppMonitorDataOutput

SetEvents sets the Events field's value.

func (*GetAppMonitorDataOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (GetAppMonitorDataOutput) String 

func (s GetAppMonitorDataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAppMonitorInput 

type GetAppMonitorInput struct {

	// The app monitor to retrieve information for.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppMonitorInput) GoString 

func (s GetAppMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppMonitorInput) SetName 

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

SetName sets the Name field's value.

func (GetAppMonitorInput) String 

func (s GetAppMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppMonitorInput) Validate 

func (s *GetAppMonitorInput) Validate() error

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

type GetAppMonitorOutput 

type GetAppMonitorOutput struct {

	// A structure containing all the configuration information for the app monitor.
	AppMonitor *AppMonitor `type:"structure"`
	// contains filtered or unexported fields
}

func (GetAppMonitorOutput) GoString 

func (s GetAppMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAppMonitorOutput) SetAppMonitor 

func (s *GetAppMonitorOutput) SetAppMonitor(v *AppMonitor) *GetAppMonitorOutput

SetAppMonitor sets the AppMonitor field's value.

func (GetAppMonitorOutput) String 

func (s GetAppMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The value of a parameter in the request caused an error.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

Internal service exception.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAppMonitorsInput 

type ListAppMonitorsInput struct {

	// The maximum number of results to return in one operation. The default is
	// 50. The maximum that you can specify is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Use the token returned by the previous operation to request the next page
	// of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListAppMonitorsInput) GoString 

func (s ListAppMonitorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppMonitorsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListAppMonitorsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListAppMonitorsInput) String 

func (s ListAppMonitorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppMonitorsInput) Validate added in v1.44.120 

func (s *ListAppMonitorsInput) Validate() error

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

type ListAppMonitorsOutput 

type ListAppMonitorsOutput struct {

	// An array of structures that contain information about the returned app monitors.
	AppMonitorSummaries []*AppMonitorSummary `type:"list"`

	// A token that you can use in a subsequent operation to retrieve the next set
	// of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAppMonitorsOutput) GoString 

func (s ListAppMonitorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAppMonitorsOutput) SetAppMonitorSummaries 

func (s *ListAppMonitorsOutput) SetAppMonitorSummaries(v []*AppMonitorSummary) *ListAppMonitorsOutput

SetAppMonitorSummaries sets the AppMonitorSummaries field's value.

func (*ListAppMonitorsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListAppMonitorsOutput) String 

func (s ListAppMonitorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRumMetricsDestinationsInput added in v1.44.120 

type ListRumMetricsDestinationsInput struct {

	// The name of the app monitor associated with the destinations that you want
	// to retrieve.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// The maximum number of results to return in one operation. The default is
	// 50. The maximum that you can specify is 100.
	//
	// To retrieve the remaining results, make another call with the returned NextToken
	// value.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Use the token returned by the previous operation to request the next page
	// of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListRumMetricsDestinationsInput) GoString added in v1.44.120 

func (s ListRumMetricsDestinationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRumMetricsDestinationsInput) SetAppMonitorName added in v1.44.120 

func (s *ListRumMetricsDestinationsInput) SetAppMonitorName(v string) *ListRumMetricsDestinationsInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*ListRumMetricsDestinationsInput) SetMaxResults added in v1.44.120 

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

SetMaxResults sets the MaxResults field's value.

func (*ListRumMetricsDestinationsInput) SetNextToken added in v1.44.120 

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

SetNextToken sets the NextToken field's value.

func (ListRumMetricsDestinationsInput) String added in v1.44.120 

func (s ListRumMetricsDestinationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRumMetricsDestinationsInput) Validate added in v1.44.120 

func (s *ListRumMetricsDestinationsInput) Validate() error

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

type ListRumMetricsDestinationsOutput added in v1.44.120 

type ListRumMetricsDestinationsOutput struct {

	// The list of CloudWatch RUM extended metrics destinations associated with
	// the app monitor that you specified.
	Destinations []*MetricDestinationSummary `type:"list"`

	// A token that you can use in a subsequent operation to retrieve the next set
	// of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListRumMetricsDestinationsOutput) GoString added in v1.44.120 

func (s ListRumMetricsDestinationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRumMetricsDestinationsOutput) SetDestinations added in v1.44.120 

func (s *ListRumMetricsDestinationsOutput) SetDestinations(v []*MetricDestinationSummary) *ListRumMetricsDestinationsOutput

SetDestinations sets the Destinations field's value.

func (*ListRumMetricsDestinationsOutput) SetNextToken added in v1.44.120 

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

SetNextToken sets the NextToken field's value.

func (ListRumMetricsDestinationsOutput) String added in v1.44.120 

func (s ListRumMetricsDestinationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource that you want to see the tags of.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The ARN of the resource that you are viewing.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The list of tag keys and values associated with the resource you specified.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetResourceArn 

func (s *ListTagsForResourceOutput) SetResourceArn(v string) *ListTagsForResourceOutput

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDefinition added in v1.44.120 

type MetricDefinition struct {

	// This field is a map of field paths to dimension names. It defines the dimensions
	// to associate with this metric in CloudWatch The value of this field is used
	// only if the metric destination is CloudWatch. If the metric destination is
	// Evidently, the value of DimensionKeys is ignored.
	DimensionKeys map[string]*string `type:"map"`

	// The pattern that defines the metric. RUM checks events that happen in a user's
	// session against the pattern, and events that match the pattern are sent to
	// the metric destination.
	//
	// If the metrics destination is CloudWatch and the event also matches a value
	// in DimensionKeys, then the metric is published with the specified dimensions.
	EventPattern *string `type:"string"`

	// The ID of this metric definition.
	//
	// MetricDefinitionId is a required field
	MetricDefinitionId *string `min:"1" type:"string" required:"true"`

	// The name of the metric that is defined in this structure.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Use this field only if you are sending this metric to CloudWatch. It defines
	// the CloudWatch metric unit that this metric is measured in.
	UnitLabel *string `min:"1" type:"string"`

	// The field within the event object that the metric value is sourced from.
	ValueKey *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html).

func (MetricDefinition) GoString added in v1.44.120 

func (s MetricDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDefinition) SetDimensionKeys added in v1.44.120 

func (s *MetricDefinition) SetDimensionKeys(v map[string]*string) *MetricDefinition

SetDimensionKeys sets the DimensionKeys field's value.

func (*MetricDefinition) SetEventPattern added in v1.44.120 

func (s *MetricDefinition) SetEventPattern(v string) *MetricDefinition

SetEventPattern sets the EventPattern field's value.

func (*MetricDefinition) SetMetricDefinitionId added in v1.44.120 

func (s *MetricDefinition) SetMetricDefinitionId(v string) *MetricDefinition

SetMetricDefinitionId sets the MetricDefinitionId field's value.

func (*MetricDefinition) SetName added in v1.44.120 

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

SetName sets the Name field's value.

func (*MetricDefinition) SetUnitLabel added in v1.44.120 

func (s *MetricDefinition) SetUnitLabel(v string) *MetricDefinition

SetUnitLabel sets the UnitLabel field's value.

func (*MetricDefinition) SetValueKey added in v1.44.120 

func (s *MetricDefinition) SetValueKey(v string) *MetricDefinition

SetValueKey sets the ValueKey field's value.

func (MetricDefinition) String added in v1.44.120 

func (s MetricDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDefinitionRequest added in v1.44.120 

type MetricDefinitionRequest struct {

	// Use this field only if you are sending the metric to CloudWatch.
	//
	// This field is a map of field paths to dimension names. It defines the dimensions
	// to associate with this metric in CloudWatch. Valid values for the entries
	// in this field are the following:
	//
	//    * "metadata.pageId": "PageId"
	//
	//    * "metadata.browserName": "BrowserName"
	//
	//    * "metadata.deviceType": "DeviceType"
	//
	//    * "metadata.osName": "OSName"
	//
	//    * "metadata.countryCode": "CountryCode"
	//
	//    * "event_details.fileType": "FileType"
	//
	// All dimensions listed in this field must also be included in EventPattern.
	DimensionKeys map[string]*string `type:"map"`

	// The pattern that defines the metric, specified as a JSON object. RUM checks
	// events that happen in a user's session against the pattern, and events that
	// match the pattern are sent to the metric destination.
	//
	// When you define extended metrics, the metric definition is not valid if EventPattern
	// is omitted.
	//
	// Example event patterns:
	//
	//    * '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName":
	//    [ "Chrome", "Safari" ], } }'
	//
	//    * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata":
	//    { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration":
	//    [{ "numeric": [ "<", 2000 ] }] } }'
	//
	//    * '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata":
	//    { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details":
	//    { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
	//
	// If the metrics destination' is CloudWatch and the event also matches a value
	// in DimensionKeys, then the metric is published with the specified dimensions.
	EventPattern *string `type:"string"`

	// The name for the metric that is defined in this structure. Valid values are
	// the following:
	//
	//    * PerformanceNavigationDuration
	//
	//    * PerformanceResourceDuration
	//
	//    * NavigationSatisfiedTransaction
	//
	//    * NavigationToleratedTransaction
	//
	//    * NavigationFrustratedTransaction
	//
	//    * WebVitalsCumulativeLayoutShift
	//
	//    * WebVitalsFirstInputDelay
	//
	//    * WebVitalsLargestContentfulPaint
	//
	//    * JsErrorCount
	//
	//    * HttpErrorCount
	//
	//    * SessionCount
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The CloudWatch metric unit to use for this metric. If you omit this field,
	// the metric is recorded with no unit.
	UnitLabel *string `min:"1" type:"string"`

	// The field within the event object that the metric value is sourced from.
	//
	// If you omit this field, a hardcoded value of 1 is pushed as the metric value.
	// This is useful if you just want to count the number of events that the filter
	// catches.
	//
	// If this metric is sent to CloudWatch Evidently, this field will be passed
	// to Evidently raw and Evidently will handle data extraction from the event.
	ValueKey *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Use this structure to define one extended metric that RUM will send to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html).

Only certain combinations of values for Name, ValueKey, and EventPattern are valid. In addition to what is displayed in the list below, the EventPattern can also include information used by the DimensionKeys field.

  • If Name is PerformanceNavigationDuration, then ValueKeymust be event_details.duration and the EventPattern must include {"event_type":["com.amazon.rum.performance_navigation_event"]}

  • If Name is PerformanceResourceDuration, then ValueKeymust be event_details.duration and the EventPattern must include {"event_type":["com.amazon.rum.performance_resource_event"]}

  • If Name is NavigationSatisfiedTransaction, then ValueKeymust be null and the EventPattern must include { "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">",2000] }] } }

  • If Name is NavigationToleratedTransaction, then ValueKeymust be null and the EventPattern must include { "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } }

  • If Name is NavigationFrustratedTransaction, then ValueKeymust be null and the EventPattern must include { "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",8000] }] } }

  • If Name is WebVitalsCumulativeLayoutShift, then ValueKeymust be event_details.value and the EventPattern must include {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}

  • If Name is WebVitalsFirstInputDelay, then ValueKeymust be event_details.value and the EventPattern must include {"event_type":["com.amazon.rum.first_input_delay_event"]}

  • If Name is WebVitalsLargestContentfulPaint, then ValueKeymust be event_details.value and the EventPattern must include {"event_type":["com.amazon.rum.largest_contentful_paint_event"]}

  • If Name is JsErrorCount, then ValueKeymust be null and the EventPattern must include {"event_type":["com.amazon.rum.js_error_event"]}

  • If Name is HttpErrorCount, then ValueKeymust be null and the EventPattern must include {"event_type":["com.amazon.rum.http_event"]}

  • If Name is SessionCount, then ValueKeymust be null and the EventPattern must include {"event_type":["com.amazon.rum.session_start_event"]}

func (MetricDefinitionRequest) GoString added in v1.44.120 

func (s MetricDefinitionRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDefinitionRequest) SetDimensionKeys added in v1.44.120 

func (s *MetricDefinitionRequest) SetDimensionKeys(v map[string]*string) *MetricDefinitionRequest

SetDimensionKeys sets the DimensionKeys field's value.

func (*MetricDefinitionRequest) SetEventPattern added in v1.44.120 

func (s *MetricDefinitionRequest) SetEventPattern(v string) *MetricDefinitionRequest

SetEventPattern sets the EventPattern field's value.

func (*MetricDefinitionRequest) SetName added in v1.44.120 

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

SetName sets the Name field's value.

func (*MetricDefinitionRequest) SetUnitLabel added in v1.44.120 

func (s *MetricDefinitionRequest) SetUnitLabel(v string) *MetricDefinitionRequest

SetUnitLabel sets the UnitLabel field's value.

func (*MetricDefinitionRequest) SetValueKey added in v1.44.120 

func (s *MetricDefinitionRequest) SetValueKey(v string) *MetricDefinitionRequest

SetValueKey sets the ValueKey field's value.

func (MetricDefinitionRequest) String added in v1.44.120 

func (s MetricDefinitionRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDefinitionRequest) Validate added in v1.44.120 

func (s *MetricDefinitionRequest) Validate() error

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

type MetricDestinationSummary added in v1.44.120 

type MetricDestinationSummary struct {

	// Specifies whether the destination is CloudWatch or Evidently.
	Destination *string `type:"string" enum:"MetricDestination"`

	// If the destination is Evidently, this specifies the ARN of the Evidently
	// experiment that receives the metrics.
	DestinationArn *string `type:"string"`

	// This field appears only when the destination is Evidently. It specifies the
	// ARN of the IAM role that is used to write to the Evidently experiment that
	// receives the metrics.
	IamRoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

A structure that displays information about one destination that CloudWatch RUM sends extended metrics to.

func (MetricDestinationSummary) GoString added in v1.44.120 

func (s MetricDestinationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDestinationSummary) SetDestination added in v1.44.120 

func (s *MetricDestinationSummary) SetDestination(v string) *MetricDestinationSummary

SetDestination sets the Destination field's value.

func (*MetricDestinationSummary) SetDestinationArn added in v1.44.120 

func (s *MetricDestinationSummary) SetDestinationArn(v string) *MetricDestinationSummary

SetDestinationArn sets the DestinationArn field's value.

func (*MetricDestinationSummary) SetIamRoleArn added in v1.44.120 

func (s *MetricDestinationSummary) SetIamRoleArn(v string) *MetricDestinationSummary

SetIamRoleArn sets the IamRoleArn field's value.

func (MetricDestinationSummary) String added in v1.44.120 

func (s MetricDestinationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRumEventsInput 

type PutRumEventsInput struct {

	// A structure that contains information about the app monitor that collected
	// this telemetry information.
	//
	// AppMonitorDetails is a required field
	AppMonitorDetails *AppMonitorDetails `type:"structure" required:"true"`

	// A unique identifier for this batch of RUM event data.
	//
	// BatchId is a required field
	BatchId *string `type:"string" required:"true"`

	// The ID of the app monitor that is sending this data.
	//
	// Id is a required field
	Id *string `location:"uri" locationName:"Id" min:"36" type:"string" required:"true"`

	// An array of structures that contain the telemetry event data.
	//
	// RumEvents is a required field
	RumEvents []*RumEvent `type:"list" required:"true"`

	// A structure that contains information about the user session that this batch
	// of events was collected from.
	//
	// UserDetails is a required field
	UserDetails *UserDetails `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutRumEventsInput) GoString 

func (s PutRumEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRumEventsInput) SetAppMonitorDetails 

func (s *PutRumEventsInput) SetAppMonitorDetails(v *AppMonitorDetails) *PutRumEventsInput

SetAppMonitorDetails sets the AppMonitorDetails field's value.

func (*PutRumEventsInput) SetBatchId 

func (s *PutRumEventsInput) SetBatchId(v string) *PutRumEventsInput

SetBatchId sets the BatchId field's value.

func (*PutRumEventsInput) SetId 

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

SetId sets the Id field's value.

func (*PutRumEventsInput) SetRumEvents 

func (s *PutRumEventsInput) SetRumEvents(v []*RumEvent) *PutRumEventsInput

SetRumEvents sets the RumEvents field's value.

func (*PutRumEventsInput) SetUserDetails 

func (s *PutRumEventsInput) SetUserDetails(v *UserDetails) *PutRumEventsInput

SetUserDetails sets the UserDetails field's value.

func (PutRumEventsInput) String 

func (s PutRumEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRumEventsInput) Validate 

func (s *PutRumEventsInput) Validate() error

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

type PutRumEventsOutput 

type PutRumEventsOutput struct {
	// contains filtered or unexported fields
}

func (PutRumEventsOutput) GoString 

func (s PutRumEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutRumEventsOutput) String 

func (s PutRumEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRumMetricsDestinationInput added in v1.44.120 

type PutRumMetricsDestinationInput struct {

	// The name of the CloudWatch RUM app monitor that will send the metrics.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// Defines the destination to send the metrics to. Valid values are CloudWatch
	// and Evidently. If you specify Evidently, you must also specify the ARN of
	// the CloudWatchEvidently experiment that is to be the destination and an IAM
	// role that has permission to write to the experiment.
	//
	// Destination is a required field
	Destination *string `type:"string" required:"true" enum:"MetricDestination"`

	// Use this parameter only if Destination is Evidently. This parameter specifies
	// the ARN of the Evidently experiment that will receive the extended metrics.
	DestinationArn *string `type:"string"`

	// This parameter is required if Destination is Evidently. If Destination is
	// CloudWatch, do not use this parameter.
	//
	// This parameter specifies the ARN of an IAM role that RUM will assume to write
	// to the Evidently experiment that you are sending metrics to. This role must
	// have permission to write to that experiment.
	IamRoleArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutRumMetricsDestinationInput) GoString added in v1.44.120 

func (s PutRumMetricsDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRumMetricsDestinationInput) SetAppMonitorName added in v1.44.120 

func (s *PutRumMetricsDestinationInput) SetAppMonitorName(v string) *PutRumMetricsDestinationInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*PutRumMetricsDestinationInput) SetDestination added in v1.44.120 

func (s *PutRumMetricsDestinationInput) SetDestination(v string) *PutRumMetricsDestinationInput

SetDestination sets the Destination field's value.

func (*PutRumMetricsDestinationInput) SetDestinationArn added in v1.44.120 

func (s *PutRumMetricsDestinationInput) SetDestinationArn(v string) *PutRumMetricsDestinationInput

SetDestinationArn sets the DestinationArn field's value.

func (*PutRumMetricsDestinationInput) SetIamRoleArn added in v1.44.120 

func (s *PutRumMetricsDestinationInput) SetIamRoleArn(v string) *PutRumMetricsDestinationInput

SetIamRoleArn sets the IamRoleArn field's value.

func (PutRumMetricsDestinationInput) String added in v1.44.120 

func (s PutRumMetricsDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRumMetricsDestinationInput) Validate added in v1.44.120 

func (s *PutRumMetricsDestinationInput) Validate() error

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

type PutRumMetricsDestinationOutput added in v1.44.120 

type PutRumMetricsDestinationOutput struct {
	// contains filtered or unexported fields
}

func (PutRumMetricsDestinationOutput) GoString added in v1.44.120 

func (s PutRumMetricsDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutRumMetricsDestinationOutput) String added in v1.44.120 

func (s PutRumMetricsDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryFilter 

type QueryFilter struct {

	// The name of a key to search for. The filter returns only the events that
	// match the Name and Values that you specify.
	//
	// Valid values for Name are Browser | Device | Country | Page | OS | EventType
	// | Invert
	Name *string `type:"string"`

	// The values of the Name that are to be be included in the returned results.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

A structure that defines a key and values that you can use to filter the results. The only performance events that are returned are those that have values matching the ones that you specify in one of your QueryFilter structures.

For example, you could specify Browser as the Name and specify Chrome,Firefox as the Values to return events generated only from those browsers.

Specifying Invert as the Name works as a "not equal to" filter. For example, specify Invert as the Name and specify Chrome as the value to return all events except events from user sessions with the Chrome browser.

func (QueryFilter) GoString 

func (s QueryFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryFilter) SetName 

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

SetName sets the Name field's value.

func (*QueryFilter) SetValues 

func (s *QueryFilter) SetValues(v []*string) *QueryFilter

SetValues sets the Values field's value.

func (QueryFilter) String 

func (s QueryFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The name of the resource that is associated with the error.
	//
	// ResourceName is a required field
	ResourceName *string `locationName:"resourceName" type:"string" required:"true"`

	// The type of the resource that is associated with the error.
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

Resource not found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RumEvent 

type RumEvent struct {

	// A string containing details about the event.
	//
	// Details is a required field
	Details aws.JSONValue `locationName:"details" type:"jsonvalue" required:"true"`

	// A unique ID for this event.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// Metadata about this event, which contains a JSON serialization of the identity
	// of the user for this session. The user information comes from information
	// such as the HTTP user-agent request header and document interface.
	Metadata aws.JSONValue `locationName:"metadata" type:"jsonvalue"`

	// The exact time that this event occurred.
	//
	// Timestamp is a required field
	Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"`

	// The JSON schema that denotes the type of event this is, such as a page load
	// or a new session.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure that contains the information for one performance event that RUM collects from a user session with your application.

func (RumEvent) GoString 

func (s RumEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RumEvent) SetDetails 

func (s *RumEvent) SetDetails(v aws.JSONValue) *RumEvent

SetDetails sets the Details field's value.

func (*RumEvent) SetId 

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

SetId sets the Id field's value.

func (*RumEvent) SetMetadata 

func (s *RumEvent) SetMetadata(v aws.JSONValue) *RumEvent

SetMetadata sets the Metadata field's value.

func (*RumEvent) SetTimestamp 

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

SetTimestamp sets the Timestamp field's value.

func (*RumEvent) SetType 

func (s *RumEvent) SetType(v string) *RumEvent

SetType sets the Type field's value.

func (RumEvent) String 

func (s RumEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RumEvent) Validate 

func (s *RumEvent) Validate() error

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

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This request exceeds a service quota.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the CloudWatch RUM resource that you're adding tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The list of key-value pairs to associate with the resource.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ID of the service quota that was exceeded.
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// The value of a parameter in the request caused an error.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`

	// The ID of the service that is associated with the error.
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// contains filtered or unexported fields
}

The request was throttled because of quota limits.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeRange 

type TimeRange struct {

	// The beginning of the time range to retrieve performance events from.
	//
	// After is a required field
	After *int64 `type:"long" required:"true"`

	// The end of the time range to retrieve performance events from. If you omit
	// this, the time range extends to the time that this operation is performed.
	Before *int64 `type:"long"`
	// contains filtered or unexported fields
}

A structure that defines the time range that you want to retrieve results from.

func (TimeRange) GoString 

func (s TimeRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeRange) SetAfter 

func (s *TimeRange) SetAfter(v int64) *TimeRange

SetAfter sets the After field's value.

func (*TimeRange) SetBefore 

func (s *TimeRange) SetBefore(v int64) *TimeRange

SetBefore sets the Before field's value.

func (TimeRange) String 

func (s TimeRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeRange) Validate 

func (s *TimeRange) Validate() error

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the CloudWatch RUM resource that you're removing tags from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"`

	// The list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAppMonitorInput 

type UpdateAppMonitorInput struct {

	// A structure that contains much of the configuration data for the app monitor.
	// If you are using Amazon Cognito for authorization, you must include this
	// structure in your request, and it must include the ID of the Amazon Cognito
	// identity pool to use for authorization. If you don't include AppMonitorConfiguration,
	// you must set up your own authorization method. For more information, see
	// Authorize your application to send data to Amazon Web Services (https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html).
	AppMonitorConfiguration *AppMonitorConfiguration `type:"structure"`

	// Specifies whether this app monitor allows the web client to define and send
	// custom events. The default is for custom events to be DISABLED.
	//
	// For more information about custom events, see Send custom events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-events.html).
	CustomEvents *CustomEvents `type:"structure"`

	// Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter
	// specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch
	// Logs in your account. This enables you to keep the telemetry data for more
	// than 30 days, but it does incur Amazon CloudWatch Logs charges.
	CwLogEnabled *bool `type:"boolean"`

	// The top-level internet domain name for which your application has administrative
	// authority.
	Domain *string `min:"1" type:"string"`

	// The name of the app monitor to update.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAppMonitorInput) GoString 

func (s UpdateAppMonitorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppMonitorInput) SetAppMonitorConfiguration 

func (s *UpdateAppMonitorInput) SetAppMonitorConfiguration(v *AppMonitorConfiguration) *UpdateAppMonitorInput

SetAppMonitorConfiguration sets the AppMonitorConfiguration field's value.

func (*UpdateAppMonitorInput) SetCustomEvents added in v1.44.140 

func (s *UpdateAppMonitorInput) SetCustomEvents(v *CustomEvents) *UpdateAppMonitorInput

SetCustomEvents sets the CustomEvents field's value.

func (*UpdateAppMonitorInput) SetCwLogEnabled 

func (s *UpdateAppMonitorInput) SetCwLogEnabled(v bool) *UpdateAppMonitorInput

SetCwLogEnabled sets the CwLogEnabled field's value.

func (*UpdateAppMonitorInput) SetDomain 

func (s *UpdateAppMonitorInput) SetDomain(v string) *UpdateAppMonitorInput

SetDomain sets the Domain field's value.

func (*UpdateAppMonitorInput) SetName 

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

SetName sets the Name field's value.

func (UpdateAppMonitorInput) String 

func (s UpdateAppMonitorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAppMonitorInput) Validate 

func (s *UpdateAppMonitorInput) Validate() error

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

type UpdateAppMonitorOutput 

type UpdateAppMonitorOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAppMonitorOutput) GoString 

func (s UpdateAppMonitorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAppMonitorOutput) String 

func (s UpdateAppMonitorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRumMetricDefinitionInput added in v1.44.120 

type UpdateRumMetricDefinitionInput struct {

	// The name of the CloudWatch RUM app monitor that sends these metrics.
	//
	// AppMonitorName is a required field
	AppMonitorName *string `location:"uri" locationName:"AppMonitorName" min:"1" type:"string" required:"true"`

	// The destination to send the metrics to. Valid values are CloudWatch and Evidently.
	// If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently
	// experiment that will receive the metrics and an IAM role that has permission
	// to write to the experiment.
	//
	// Destination is a required field
	Destination *string `type:"string" required:"true" enum:"MetricDestination"`

	// This parameter is required if Destination is Evidently. If Destination is
	// CloudWatch, do not use this parameter.
	//
	// This parameter specifies the ARN of the Evidently experiment that is to receive
	// the metrics. You must have already defined this experiment as a valid destination.
	// For more information, see PutRumMetricsDestination (https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html).
	DestinationArn *string `type:"string"`

	// A structure that contains the new definition that you want to use for this
	// metric.
	//
	// MetricDefinition is a required field
	MetricDefinition *MetricDefinitionRequest `type:"structure" required:"true"`

	// The ID of the metric definition to update.
	//
	// MetricDefinitionId is a required field
	MetricDefinitionId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRumMetricDefinitionInput) GoString added in v1.44.120 

func (s UpdateRumMetricDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRumMetricDefinitionInput) SetAppMonitorName added in v1.44.120 

func (s *UpdateRumMetricDefinitionInput) SetAppMonitorName(v string) *UpdateRumMetricDefinitionInput

SetAppMonitorName sets the AppMonitorName field's value.

func (*UpdateRumMetricDefinitionInput) SetDestination added in v1.44.120 

func (s *UpdateRumMetricDefinitionInput) SetDestination(v string) *UpdateRumMetricDefinitionInput

SetDestination sets the Destination field's value.

func (*UpdateRumMetricDefinitionInput) SetDestinationArn added in v1.44.120 

func (s *UpdateRumMetricDefinitionInput) SetDestinationArn(v string) *UpdateRumMetricDefinitionInput

SetDestinationArn sets the DestinationArn field's value.

func (*UpdateRumMetricDefinitionInput) SetMetricDefinition added in v1.44.120 

func (s *UpdateRumMetricDefinitionInput) SetMetricDefinition(v *MetricDefinitionRequest) *UpdateRumMetricDefinitionInput

SetMetricDefinition sets the MetricDefinition field's value.

func (*UpdateRumMetricDefinitionInput) SetMetricDefinitionId added in v1.44.120 

func (s *UpdateRumMetricDefinitionInput) SetMetricDefinitionId(v string) *UpdateRumMetricDefinitionInput

SetMetricDefinitionId sets the MetricDefinitionId field's value.

func (UpdateRumMetricDefinitionInput) String added in v1.44.120 

func (s UpdateRumMetricDefinitionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRumMetricDefinitionInput) Validate added in v1.44.120 

func (s *UpdateRumMetricDefinitionInput) Validate() error

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

type UpdateRumMetricDefinitionOutput added in v1.44.120 

type UpdateRumMetricDefinitionOutput struct {
	// contains filtered or unexported fields
}

func (UpdateRumMetricDefinitionOutput) GoString added in v1.44.120 

func (s UpdateRumMetricDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateRumMetricDefinitionOutput) String added in v1.44.120 

func (s UpdateRumMetricDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserDetails 

type UserDetails struct {

	// The session ID that the performance events are from.
	SessionId *string `locationName:"sessionId" type:"string"`

	// The ID of the user for this user session. This ID is generated by RUM and
	// does not include any personally identifiable information about the user.
	UserId *string `locationName:"userId" type:"string"`
	// contains filtered or unexported fields
}

A structure that contains information about the user session that this batch of events was collected from.

func (UserDetails) GoString 

func (s UserDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserDetails) SetSessionId 

func (s *UserDetails) SetSessionId(v string) *UserDetails

SetSessionId sets the SessionId field's value.

func (*UserDetails) SetUserId 

func (s *UserDetails) SetUserId(v string) *UserDetails

SetUserId sets the UserId field's value.

func (UserDetails) String 

func (s UserDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

One of the arguments for the request is not valid.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package cloudwatchrumiface provides an interface to enable mocking the CloudWatch RUM service client for testing your code.
 Package cloudwatchrumiface provides an interface to enable mocking the CloudWatch RUM 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.