internetmonitor

package
v1.44.279 Latest Latest
Warning

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

 Go to latest Published: Jun 8, 2023 License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Overview

Package internetmonitor provides the client and types for making API requests to Amazon CloudWatch Internet Monitor.

Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end users. It reduces the time it takes for you to diagnose internet issues from days to minutes. Internet Monitor uses the connectivity data that Amazon Web Services captures from its global networking footprint to calculate a baseline of performance and availability for internet traffic. This is the same data that Amazon Web Services uses to monitor internet uptime and availability. With those measurements as a baseline, Internet Monitor raises awareness for you when there are significant problems for your end users in the different geographic locations where your application runs.

Internet Monitor publishes internet measurements to CloudWatch Logs and CloudWatch Metrics, to easily support using CloudWatch tools with health information for geographies and networks specific to your application. Internet Monitor sends health events to Amazon EventBridge so that you can set up notifications. If an issue is caused by the Amazon Web Services network, you also automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking to mitigate the problem.

To use Internet Monitor, you create a monitor and associate your application's resources with it, VPCs, CloudFront distributions, or WorkSpaces directories, to enable Internet Monitor to know where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations and networks that communicate with your application.

For more information, see Using Amazon CloudWatch Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) in the Amazon CloudWatch User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	// HealthEventImpactTypeAvailability is a HealthEventImpactType enum value
	HealthEventImpactTypeAvailability = "AVAILABILITY"

	// HealthEventImpactTypePerformance is a HealthEventImpactType enum value
	HealthEventImpactTypePerformance = "PERFORMANCE"
)
View Source 
const (
	// HealthEventStatusActive is a HealthEventStatus enum value
	HealthEventStatusActive = "ACTIVE"

	// HealthEventStatusResolved is a HealthEventStatus enum value
	HealthEventStatusResolved = "RESOLVED"
)
View Source 
const (
	// LogDeliveryStatusEnabled is a LogDeliveryStatus enum value
	LogDeliveryStatusEnabled = "ENABLED"

	// LogDeliveryStatusDisabled is a LogDeliveryStatus enum value
	LogDeliveryStatusDisabled = "DISABLED"
)
View Source 
const (
	// MonitorConfigStatePending is a MonitorConfigState enum value
	MonitorConfigStatePending = "PENDING"

	// MonitorConfigStateActive is a MonitorConfigState enum value
	MonitorConfigStateActive = "ACTIVE"

	// MonitorConfigStateInactive is a MonitorConfigState enum value
	MonitorConfigStateInactive = "INACTIVE"

	// MonitorConfigStateError is a MonitorConfigState enum value
	MonitorConfigStateError = "ERROR"
)
View Source 
const (
	// MonitorProcessingStatusCodeOk is a MonitorProcessingStatusCode enum value
	MonitorProcessingStatusCodeOk = "OK"

	// MonitorProcessingStatusCodeInactive is a MonitorProcessingStatusCode enum value
	MonitorProcessingStatusCodeInactive = "INACTIVE"

	// MonitorProcessingStatusCodeCollectingData is a MonitorProcessingStatusCode enum value
	MonitorProcessingStatusCodeCollectingData = "COLLECTING_DATA"

	// MonitorProcessingStatusCodeInsufficientData is a MonitorProcessingStatusCode enum value
	MonitorProcessingStatusCodeInsufficientData = "INSUFFICIENT_DATA"

	// MonitorProcessingStatusCodeFaultService is a MonitorProcessingStatusCode enum value
	MonitorProcessingStatusCodeFaultService = "FAULT_SERVICE"

	// MonitorProcessingStatusCodeFaultAccessCloudwatch is a MonitorProcessingStatusCode enum value
	MonitorProcessingStatusCodeFaultAccessCloudwatch = "FAULT_ACCESS_CLOUDWATCH"
)
View Source 
const (
	// TriangulationEventTypeAws is a TriangulationEventType enum value
	TriangulationEventTypeAws = "AWS"

	// TriangulationEventTypeInternet is a TriangulationEventType enum value
	TriangulationEventTypeInternet = "Internet"
)
View Source 
const (

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

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// A bad request was received.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The requested resource is in use.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// There was an internal server error.
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal error occurred.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The request exceeded a service quota.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// The request specifies something that doesn't exist.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request specifies a resource that doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// There were too many requests.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Invalid request.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "InternetMonitor" // Name of service.
	EndpointsID = "internetmonitor" // ID to lookup a service endpoint with.
	ServiceID   = "InternetMonitor" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func HealthEventImpactType_Values 

func HealthEventImpactType_Values() []string

HealthEventImpactType_Values returns all elements of the HealthEventImpactType enum

func HealthEventStatus_Values 

func HealthEventStatus_Values() []string

HealthEventStatus_Values returns all elements of the HealthEventStatus enum

func LogDeliveryStatus_Values added in v1.44.234 

func LogDeliveryStatus_Values() []string

LogDeliveryStatus_Values returns all elements of the LogDeliveryStatus enum

func MonitorConfigState_Values 

func MonitorConfigState_Values() []string

MonitorConfigState_Values returns all elements of the MonitorConfigState enum

func MonitorProcessingStatusCode_Values 

func MonitorProcessingStatusCode_Values() []string

MonitorProcessingStatusCode_Values returns all elements of the MonitorProcessingStatusCode enum

func TriangulationEventType_Values 

func TriangulationEventType_Values() []string

TriangulationEventType_Values returns all elements of the TriangulationEventType 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 permission 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 AvailabilityMeasurement 

type AvailabilityMeasurement struct {

	// Experience scores, or health scores are calculated for different geographic
	// and network provider combinations (that is, different granularities) and
	// also summed into global scores. If you view performance or availability scores
	// without filtering for any specific geography or service provider, Amazon
	// CloudWatch Internet Monitor provides global health scores.
	//
	// The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide
	// includes detailed information about how Internet Monitor calculates health
	// scores, including performance and availability scores, and when it creates
	// and resolves health events. For more information, see How Amazon Web Services
	// calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	ExperienceScore *float64 `type:"double"`

	// The percentage of impact caused by a health event for client location traffic
	// globally.
	//
	// For information about how Internet Monitor calculates impact, see Inside
	// Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html)
	// in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch
	// User Guide.
	PercentOfClientLocationImpacted *float64 `type:"double"`

	// The percentage of impact caused by a health event for total traffic globally.
	//
	// For information about how Internet Monitor calculates impact, see Inside
	// Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html)
	// in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch
	// User Guide.
	PercentOfTotalTrafficImpacted *float64 `type:"double"`
	// contains filtered or unexported fields
}

Measurements about the availability for your application on the internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.

For more information, see How Internet Monitor calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.

func (AvailabilityMeasurement) GoString 

func (s AvailabilityMeasurement) 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 (*AvailabilityMeasurement) SetExperienceScore 

func (s *AvailabilityMeasurement) SetExperienceScore(v float64) *AvailabilityMeasurement

SetExperienceScore sets the ExperienceScore field's value.

func (*AvailabilityMeasurement) SetPercentOfClientLocationImpacted 

func (s *AvailabilityMeasurement) SetPercentOfClientLocationImpacted(v float64) *AvailabilityMeasurement

SetPercentOfClientLocationImpacted sets the PercentOfClientLocationImpacted field's value.

func (*AvailabilityMeasurement) SetPercentOfTotalTrafficImpacted 

func (s *AvailabilityMeasurement) SetPercentOfTotalTrafficImpacted(v float64) *AvailabilityMeasurement

SetPercentOfTotalTrafficImpacted sets the PercentOfTotalTrafficImpacted field's value.

func (AvailabilityMeasurement) String 

func (s AvailabilityMeasurement) 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 BadRequestException 

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

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

A bad request was received.

func (*BadRequestException) Code 

func (s *BadRequestException) Code() string

Code returns the exception type name.

func (*BadRequestException) Error 

func (s *BadRequestException) Error() string

func (BadRequestException) GoString 

func (s BadRequestException) 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 (*BadRequestException) Message 

func (s *BadRequestException) Message() string

Message returns the exception's message.

func (*BadRequestException) OrigErr 

func (s *BadRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BadRequestException) RequestID 

func (s *BadRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BadRequestException) StatusCode 

func (s *BadRequestException) StatusCode() int

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

func (BadRequestException) String 

func (s BadRequestException) 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 ConflictException 

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

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

The requested resource is in use.

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 CreateMonitorInput 

type CreateMonitorInput struct {

	// A unique, case-sensitive string of up to 64 ASCII characters that you specify
	// to make an idempotent API request. Don't reuse the same client token for
	// other API requests.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// Publish internet measurements for Internet Monitor to an Amazon S3 bucket
	// in addition to CloudWatch Logs.
	InternetMeasurementsLogDelivery *InternetMeasurementsLogDelivery `type:"structure"`

	// The maximum number of city-networks to monitor for your resources. A city-network
	// is the location (city) where clients access your application resources from
	// and the network or ASN, such as an internet service provider (ISP), that
	// clients access the resources through. This limit helps control billing costs.
	//
	// To learn more, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	MaxCityNetworksToMonitor *int64 `min:"1" type:"integer"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `min:"1" type:"string" required:"true"`

	// The resources to include in a monitor, which you provide as a set of Amazon
	// Resource Names (ARNs).
	//
	// You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon
	// CloudFront distributions, or you can add Amazon WorkSpaces directories. You
	// can't add all three types of resources.
	//
	// If you add only VPC resources, at least one VPC must have an Internet Gateway
	// attached to it, to make sure that it has internet connectivity.
	Resources []*string `type:"list"`

	// The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
	Tags map[string]*string `type:"map"`

	// The percentage of the internet-facing traffic for your application that you
	// want to monitor with this monitor.
	TrafficPercentageToMonitor *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (CreateMonitorInput) GoString 

func (s CreateMonitorInput) 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 (*CreateMonitorInput) SetClientToken 

func (s *CreateMonitorInput) SetClientToken(v string) *CreateMonitorInput

SetClientToken sets the ClientToken field's value.

func (*CreateMonitorInput) SetInternetMeasurementsLogDelivery added in v1.44.234 

func (s *CreateMonitorInput) SetInternetMeasurementsLogDelivery(v *InternetMeasurementsLogDelivery) *CreateMonitorInput

SetInternetMeasurementsLogDelivery sets the InternetMeasurementsLogDelivery field's value.

func (*CreateMonitorInput) SetMaxCityNetworksToMonitor 

func (s *CreateMonitorInput) SetMaxCityNetworksToMonitor(v int64) *CreateMonitorInput

SetMaxCityNetworksToMonitor sets the MaxCityNetworksToMonitor field's value.

func (*CreateMonitorInput) SetMonitorName 

func (s *CreateMonitorInput) SetMonitorName(v string) *CreateMonitorInput

SetMonitorName sets the MonitorName field's value.

func (*CreateMonitorInput) SetResources 

func (s *CreateMonitorInput) SetResources(v []*string) *CreateMonitorInput

SetResources sets the Resources field's value.

func (*CreateMonitorInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateMonitorInput) SetTrafficPercentageToMonitor added in v1.44.245 

func (s *CreateMonitorInput) SetTrafficPercentageToMonitor(v int64) *CreateMonitorInput

SetTrafficPercentageToMonitor sets the TrafficPercentageToMonitor field's value.

func (CreateMonitorInput) String 

func (s CreateMonitorInput) 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 (*CreateMonitorInput) Validate 

func (s *CreateMonitorInput) Validate() error

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

type CreateMonitorOutput 

type CreateMonitorOutput struct {

	// The Amazon Resource Name (ARN) of the monitor.
	//
	// Arn is a required field
	Arn *string `min:"20" type:"string" required:"true"`

	// The status of a monitor.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"MonitorConfigState"`
	// contains filtered or unexported fields
}

func (CreateMonitorOutput) GoString 

func (s CreateMonitorOutput) 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 (*CreateMonitorOutput) SetArn 

func (s *CreateMonitorOutput) SetArn(v string) *CreateMonitorOutput

SetArn sets the Arn field's value.

func (*CreateMonitorOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (CreateMonitorOutput) String 

func (s CreateMonitorOutput) 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 DeleteMonitorInput 

type DeleteMonitorInput struct {

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

func (DeleteMonitorInput) GoString 

func (s DeleteMonitorInput) 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 (*DeleteMonitorInput) SetMonitorName 

func (s *DeleteMonitorInput) SetMonitorName(v string) *DeleteMonitorInput

SetMonitorName sets the MonitorName field's value.

func (DeleteMonitorInput) String 

func (s DeleteMonitorInput) 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 (*DeleteMonitorInput) Validate 

func (s *DeleteMonitorInput) Validate() error

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

type DeleteMonitorOutput 

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

func (DeleteMonitorOutput) GoString 

func (s DeleteMonitorOutput) 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 (DeleteMonitorOutput) String 

func (s DeleteMonitorOutput) 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 GetHealthEventInput 

type GetHealthEventInput struct {

	// The internally generated identifier of a health event. Because EventID contains
	// the forward slash (“/”) character, you must URL-encode the EventID field
	// in the request URL.
	//
	// EventId is a required field
	EventId *string `location:"uri" locationName:"EventId" min:"1" type:"string" required:"true"`

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

func (GetHealthEventInput) GoString 

func (s GetHealthEventInput) 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 (*GetHealthEventInput) SetEventId 

func (s *GetHealthEventInput) SetEventId(v string) *GetHealthEventInput

SetEventId sets the EventId field's value.

func (*GetHealthEventInput) SetMonitorName 

func (s *GetHealthEventInput) SetMonitorName(v string) *GetHealthEventInput

SetMonitorName sets the MonitorName field's value.

func (GetHealthEventInput) String 

func (s GetHealthEventInput) 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 (*GetHealthEventInput) Validate 

func (s *GetHealthEventInput) Validate() error

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

type GetHealthEventOutput 

type GetHealthEventOutput struct {

	// The time when a health event was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The time when a health event was resolved. If the health event is still active,
	// the end time is not set.
	EndedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The Amazon Resource Name (ARN) of the event.
	//
	// EventArn is a required field
	EventArn *string `min:"20" type:"string" required:"true"`

	// The internally generated identifier of a health event.
	//
	// EventId is a required field
	EventId *string `min:"1" type:"string" required:"true"`

	// The type of impairment of a specific health event.
	//
	// ImpactType is a required field
	ImpactType *string `type:"string" required:"true" enum:"HealthEventImpactType"`

	// The locations affected by a health event.
	//
	// ImpactedLocations is a required field
	ImpactedLocations []*ImpactedLocation `type:"list" required:"true"`

	// The time when a health event was last updated or recalculated.
	//
	// LastUpdatedAt is a required field
	LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The impact on total traffic that a health event has.
	PercentOfTotalTrafficImpacted *float64 `type:"double"`

	// The time when a health event started.
	//
	// StartedAt is a required field
	StartedAt *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The status of a health event.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"HealthEventStatus"`
	// contains filtered or unexported fields
}

func (GetHealthEventOutput) GoString 

func (s GetHealthEventOutput) 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 (*GetHealthEventOutput) SetCreatedAt 

func (s *GetHealthEventOutput) SetCreatedAt(v time.Time) *GetHealthEventOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetHealthEventOutput) SetEndedAt 

func (s *GetHealthEventOutput) SetEndedAt(v time.Time) *GetHealthEventOutput

SetEndedAt sets the EndedAt field's value.

func (*GetHealthEventOutput) SetEventArn 

func (s *GetHealthEventOutput) SetEventArn(v string) *GetHealthEventOutput

SetEventArn sets the EventArn field's value.

func (*GetHealthEventOutput) SetEventId 

func (s *GetHealthEventOutput) SetEventId(v string) *GetHealthEventOutput

SetEventId sets the EventId field's value.

func (*GetHealthEventOutput) SetImpactType 

func (s *GetHealthEventOutput) SetImpactType(v string) *GetHealthEventOutput

SetImpactType sets the ImpactType field's value.

func (*GetHealthEventOutput) SetImpactedLocations 

func (s *GetHealthEventOutput) SetImpactedLocations(v []*ImpactedLocation) *GetHealthEventOutput

SetImpactedLocations sets the ImpactedLocations field's value.

func (*GetHealthEventOutput) SetLastUpdatedAt 

func (s *GetHealthEventOutput) SetLastUpdatedAt(v time.Time) *GetHealthEventOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*GetHealthEventOutput) SetPercentOfTotalTrafficImpacted 

func (s *GetHealthEventOutput) SetPercentOfTotalTrafficImpacted(v float64) *GetHealthEventOutput

SetPercentOfTotalTrafficImpacted sets the PercentOfTotalTrafficImpacted field's value.

func (*GetHealthEventOutput) SetStartedAt 

func (s *GetHealthEventOutput) SetStartedAt(v time.Time) *GetHealthEventOutput

SetStartedAt sets the StartedAt field's value.

func (*GetHealthEventOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (GetHealthEventOutput) String 

func (s GetHealthEventOutput) 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 GetMonitorInput 

type GetMonitorInput struct {

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

func (GetMonitorInput) GoString 

func (s GetMonitorInput) 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 (*GetMonitorInput) SetMonitorName 

func (s *GetMonitorInput) SetMonitorName(v string) *GetMonitorInput

SetMonitorName sets the MonitorName field's value.

func (GetMonitorInput) String 

func (s GetMonitorInput) 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 (*GetMonitorInput) Validate 

func (s *GetMonitorInput) Validate() error

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

type GetMonitorOutput 

type GetMonitorOutput struct {

	// The time when the monitor was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Publish internet measurements for Internet Monitor to another location, such
	// as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch
	// Logs.
	InternetMeasurementsLogDelivery *InternetMeasurementsLogDelivery `type:"structure"`

	// The maximum number of city-networks to monitor for your resources. A city-network
	// is the location (city) where clients access your application resources from
	// and the network or ASN, such as an internet service provider (ISP), that
	// clients access the resources through. This limit helps control billing costs.
	//
	// To learn more, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	MaxCityNetworksToMonitor *int64 `min:"1" type:"integer"`

	// The last time that the monitor was modified.
	//
	// ModifiedAt is a required field
	ModifiedAt *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The Amazon Resource Name (ARN) of the monitor.
	//
	// MonitorArn is a required field
	MonitorArn *string `min:"20" type:"string" required:"true"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `min:"1" type:"string" required:"true"`

	// The health of the data processing for the monitor.
	ProcessingStatus *string `type:"string" enum:"MonitorProcessingStatusCode"`

	// Additional information about the health of the data processing for the monitor.
	ProcessingStatusInfo *string `type:"string"`

	// The resources that have been added for the monitor. Resources are listed
	// by their Amazon Resource Names (ARNs).
	//
	// Resources is a required field
	Resources []*string `type:"list" required:"true"`

	// The status of the monitor.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"MonitorConfigState"`

	// The tags that have been added to monitor.
	Tags map[string]*string `type:"map"`

	// The percentage of the internet-facing traffic for your application that you
	// want to monitor with this monitor.
	TrafficPercentageToMonitor *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (GetMonitorOutput) GoString 

func (s GetMonitorOutput) 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 (*GetMonitorOutput) SetCreatedAt 

func (s *GetMonitorOutput) SetCreatedAt(v time.Time) *GetMonitorOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetMonitorOutput) SetInternetMeasurementsLogDelivery added in v1.44.234 

func (s *GetMonitorOutput) SetInternetMeasurementsLogDelivery(v *InternetMeasurementsLogDelivery) *GetMonitorOutput

SetInternetMeasurementsLogDelivery sets the InternetMeasurementsLogDelivery field's value.

func (*GetMonitorOutput) SetMaxCityNetworksToMonitor 

func (s *GetMonitorOutput) SetMaxCityNetworksToMonitor(v int64) *GetMonitorOutput

SetMaxCityNetworksToMonitor sets the MaxCityNetworksToMonitor field's value.

func (*GetMonitorOutput) SetModifiedAt 

func (s *GetMonitorOutput) SetModifiedAt(v time.Time) *GetMonitorOutput

SetModifiedAt sets the ModifiedAt field's value.

func (*GetMonitorOutput) SetMonitorArn 

func (s *GetMonitorOutput) SetMonitorArn(v string) *GetMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (*GetMonitorOutput) SetMonitorName 

func (s *GetMonitorOutput) SetMonitorName(v string) *GetMonitorOutput

SetMonitorName sets the MonitorName field's value.

func (*GetMonitorOutput) SetProcessingStatus 

func (s *GetMonitorOutput) SetProcessingStatus(v string) *GetMonitorOutput

SetProcessingStatus sets the ProcessingStatus field's value.

func (*GetMonitorOutput) SetProcessingStatusInfo 

func (s *GetMonitorOutput) SetProcessingStatusInfo(v string) *GetMonitorOutput

SetProcessingStatusInfo sets the ProcessingStatusInfo field's value.

func (*GetMonitorOutput) SetResources 

func (s *GetMonitorOutput) SetResources(v []*string) *GetMonitorOutput

SetResources sets the Resources field's value.

func (*GetMonitorOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetMonitorOutput) SetTags 

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

SetTags sets the Tags field's value.

func (*GetMonitorOutput) SetTrafficPercentageToMonitor added in v1.44.245 

func (s *GetMonitorOutput) SetTrafficPercentageToMonitor(v int64) *GetMonitorOutput

SetTrafficPercentageToMonitor sets the TrafficPercentageToMonitor field's value.

func (GetMonitorOutput) String 

func (s GetMonitorOutput) 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 HealthEvent 

type HealthEvent struct {

	// When the health event was created.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The time when a health event ended. If the health event is still active,
	// then the end time is not set.
	EndedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The Amazon Resource Name (ARN) of the event.
	//
	// EventArn is a required field
	EventArn *string `min:"20" type:"string" required:"true"`

	// The internally generated identifier of a specific network traffic impairment
	// health event.
	//
	// EventId is a required field
	EventId *string `min:"1" type:"string" required:"true"`

	// The type of impairment for a health event.
	//
	// ImpactType is a required field
	ImpactType *string `type:"string" required:"true" enum:"HealthEventImpactType"`

	// The locations impacted by the health event.
	//
	// ImpactedLocations is a required field
	ImpactedLocations []*ImpactedLocation `type:"list" required:"true"`

	// When the health event was last updated.
	//
	// LastUpdatedAt is a required field
	LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The impact on global traffic monitored by this monitor for this health event.
	PercentOfTotalTrafficImpacted *float64 `type:"double"`

	// When a health event started.
	//
	// StartedAt is a required field
	StartedAt *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Health event list member.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"HealthEventStatus"`
	// contains filtered or unexported fields
}

Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.

func (HealthEvent) GoString 

func (s HealthEvent) 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 (*HealthEvent) SetCreatedAt 

func (s *HealthEvent) SetCreatedAt(v time.Time) *HealthEvent

SetCreatedAt sets the CreatedAt field's value.

func (*HealthEvent) SetEndedAt 

func (s *HealthEvent) SetEndedAt(v time.Time) *HealthEvent

SetEndedAt sets the EndedAt field's value.

func (*HealthEvent) SetEventArn 

func (s *HealthEvent) SetEventArn(v string) *HealthEvent

SetEventArn sets the EventArn field's value.

func (*HealthEvent) SetEventId 

func (s *HealthEvent) SetEventId(v string) *HealthEvent

SetEventId sets the EventId field's value.

func (*HealthEvent) SetImpactType 

func (s *HealthEvent) SetImpactType(v string) *HealthEvent

SetImpactType sets the ImpactType field's value.

func (*HealthEvent) SetImpactedLocations 

func (s *HealthEvent) SetImpactedLocations(v []*ImpactedLocation) *HealthEvent

SetImpactedLocations sets the ImpactedLocations field's value.

func (*HealthEvent) SetLastUpdatedAt 

func (s *HealthEvent) SetLastUpdatedAt(v time.Time) *HealthEvent

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*HealthEvent) SetPercentOfTotalTrafficImpacted 

func (s *HealthEvent) SetPercentOfTotalTrafficImpacted(v float64) *HealthEvent

SetPercentOfTotalTrafficImpacted sets the PercentOfTotalTrafficImpacted field's value.

func (*HealthEvent) SetStartedAt 

func (s *HealthEvent) SetStartedAt(v time.Time) *HealthEvent

SetStartedAt sets the StartedAt field's value.

func (*HealthEvent) SetStatus 

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

SetStatus sets the Status field's value.

func (HealthEvent) String 

func (s HealthEvent) 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 ImpactedLocation 

type ImpactedLocation struct {

	// The name of the network at an impacted location.
	//
	// ASName is a required field
	ASName *string `type:"string" required:"true"`

	// The Autonomous System Number (ASN) of the network at an impacted location.
	//
	// ASNumber is a required field
	ASNumber *int64 `type:"long" required:"true"`

	// The cause of the impairment. There are two types of network impairments:
	// Amazon Web Services network issues or internet issues. Internet issues are
	// typically a problem with a network provider, like an internet service provider
	// (ISP).
	CausedBy *NetworkImpairment `type:"structure"`

	// The name of the city where the health event is located.
	City *string `type:"string"`

	// The name of the country where the health event is located.
	//
	// Country is a required field
	Country *string `type:"string" required:"true"`

	// The country code where the health event is located. The ISO 3166-2 codes
	// for the country is provided, when available.
	CountryCode *string `type:"string"`

	// The calculated health at a specific location.
	InternetHealth *InternetHealth `type:"structure"`

	// The latitude where the health event is located.
	Latitude *float64 `type:"double"`

	// The longitude where the health event is located.
	Longitude *float64 `type:"double"`

	// The metro area where the health event is located.
	//
	// Metro indicates a metropolitan region in the United States, such as the region
	// around New York City. In non-US countries, this is a second-level subdivision.
	// For example, in the United Kingdom, it could be a county, a London borough,
	// a unitary authority, council area, and so on.
	Metro *string `type:"string"`

	// The service location where the health event is located.
	ServiceLocation *string `type:"string"`

	// The status of the health event at an impacted location.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"HealthEventStatus"`

	// The subdivision location where the health event is located. The subdivision
	// usually maps to states in most countries (including the United States). For
	// United Kingdom, it maps to a country (England, Scotland, Wales) or province
	// (Northern Ireland).
	Subdivision *string `type:"string"`

	// The subdivision code where the health event is located. The ISO 3166-2 codes
	// for country subdivisions is provided, when available.
	SubdivisionCode *string `type:"string"`
	// contains filtered or unexported fields
}

Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.

Geographic regions are hierarchically categorized into country, subdivision, metro and city geographic granularities. The geographic region is identified based on the IP address used at the client locations.

func (ImpactedLocation) GoString 

func (s ImpactedLocation) 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 (*ImpactedLocation) SetASName 

func (s *ImpactedLocation) SetASName(v string) *ImpactedLocation

SetASName sets the ASName field's value.

func (*ImpactedLocation) SetASNumber 

func (s *ImpactedLocation) SetASNumber(v int64) *ImpactedLocation

SetASNumber sets the ASNumber field's value.

func (*ImpactedLocation) SetCausedBy 

func (s *ImpactedLocation) SetCausedBy(v *NetworkImpairment) *ImpactedLocation

SetCausedBy sets the CausedBy field's value.

func (*ImpactedLocation) SetCity 

func (s *ImpactedLocation) SetCity(v string) *ImpactedLocation

SetCity sets the City field's value.

func (*ImpactedLocation) SetCountry 

func (s *ImpactedLocation) SetCountry(v string) *ImpactedLocation

SetCountry sets the Country field's value.

func (*ImpactedLocation) SetCountryCode 

func (s *ImpactedLocation) SetCountryCode(v string) *ImpactedLocation

SetCountryCode sets the CountryCode field's value.

func (*ImpactedLocation) SetInternetHealth 

func (s *ImpactedLocation) SetInternetHealth(v *InternetHealth) *ImpactedLocation

SetInternetHealth sets the InternetHealth field's value.

func (*ImpactedLocation) SetLatitude 

func (s *ImpactedLocation) SetLatitude(v float64) *ImpactedLocation

SetLatitude sets the Latitude field's value.

func (*ImpactedLocation) SetLongitude 

func (s *ImpactedLocation) SetLongitude(v float64) *ImpactedLocation

SetLongitude sets the Longitude field's value.

func (*ImpactedLocation) SetMetro 

func (s *ImpactedLocation) SetMetro(v string) *ImpactedLocation

SetMetro sets the Metro field's value.

func (*ImpactedLocation) SetServiceLocation 

func (s *ImpactedLocation) SetServiceLocation(v string) *ImpactedLocation

SetServiceLocation sets the ServiceLocation field's value.

func (*ImpactedLocation) SetStatus 

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

SetStatus sets the Status field's value.

func (*ImpactedLocation) SetSubdivision 

func (s *ImpactedLocation) SetSubdivision(v string) *ImpactedLocation

SetSubdivision sets the Subdivision field's value.

func (*ImpactedLocation) SetSubdivisionCode 

func (s *ImpactedLocation) SetSubdivisionCode(v string) *ImpactedLocation

SetSubdivisionCode sets the SubdivisionCode field's value.

func (ImpactedLocation) String 

func (s ImpactedLocation) 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 InternalServerErrorException 

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

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

There was an internal server error.

func (*InternalServerErrorException) Code 

func (s *InternalServerErrorException) Code() string

Code returns the exception type name.

func (*InternalServerErrorException) Error 

func (s *InternalServerErrorException) Error() string

func (InternalServerErrorException) GoString 

func (s InternalServerErrorException) 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 (*InternalServerErrorException) Message 

func (s *InternalServerErrorException) Message() string

Message returns the exception's message.

func (*InternalServerErrorException) OrigErr 

func (s *InternalServerErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerErrorException) RequestID 

func (s *InternalServerErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerErrorException) StatusCode 

func (s *InternalServerErrorException) StatusCode() int

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

func (InternalServerErrorException) String 

func (s InternalServerErrorException) 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"`
	// contains filtered or unexported fields
}

An internal error occurred.

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 InternetHealth 

type InternetHealth struct {

	// Availability in Internet Monitor represents the estimated percentage of traffic
	// that is not seeing an availability drop. For example, an availability score
	// of 99% for an end user and service location pair is equivalent to 1% of the
	// traffic experiencing an availability drop for that pair.
	//
	// For more information, see How Internet Monitor calculates performance and
	// availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	Availability *AvailabilityMeasurement `type:"structure"`

	// Performance in Internet Monitor represents the estimated percentage of traffic
	// that is not seeing a performance drop. For example, a performance score of
	// 99% for an end user and service location pair is equivalent to 1% of the
	// traffic experiencing a performance drop for that pair.
	//
	// For more information, see How Internet Monitor calculates performance and
	// availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	Performance *PerformanceMeasurement `type:"structure"`
	// contains filtered or unexported fields
}

Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

func (InternetHealth) GoString 

func (s InternetHealth) 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 (*InternetHealth) SetAvailability 

func (s *InternetHealth) SetAvailability(v *AvailabilityMeasurement) *InternetHealth

SetAvailability sets the Availability field's value.

func (*InternetHealth) SetPerformance 

func (s *InternetHealth) SetPerformance(v *PerformanceMeasurement) *InternetHealth

SetPerformance sets the Performance field's value.

func (InternetHealth) String 

func (s InternetHealth) 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 InternetMeasurementsLogDelivery added in v1.44.234 

type InternetMeasurementsLogDelivery struct {

	// The configuration information for publishing Internet Monitor internet measurements
	// to Amazon S3. The configuration includes the bucket name and (optionally)
	// prefix for the S3 bucket to store the measurements, and the delivery status.
	// The delivery status is ENABLED or DISABLED, depending on whether you choose
	// to deliver internet measurements to S3 logs.
	S3Config *S3Config `type:"structure"`
	// contains filtered or unexported fields
}

Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.

func (InternetMeasurementsLogDelivery) GoString added in v1.44.234 

func (s InternetMeasurementsLogDelivery) 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 (*InternetMeasurementsLogDelivery) SetS3Config added in v1.44.234 

func (s *InternetMeasurementsLogDelivery) SetS3Config(v *S3Config) *InternetMeasurementsLogDelivery

SetS3Config sets the S3Config field's value.

func (InternetMeasurementsLogDelivery) String added in v1.44.234 

func (s InternetMeasurementsLogDelivery) 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 (*InternetMeasurementsLogDelivery) Validate added in v1.44.234 

func (s *InternetMeasurementsLogDelivery) Validate() error

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

type InternetMonitor 

type InternetMonitor struct {
	*client.Client
}

InternetMonitor provides the API operation methods for making requests to Amazon CloudWatch Internet Monitor. See this package's package overview docs for details on the service.

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

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

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

func (*InternetMonitor) CreateMonitor 

func (c *InternetMonitor) CreateMonitor(input *CreateMonitorInput) (*CreateMonitorOutput, error)

CreateMonitor API operation for Amazon CloudWatch Internet Monitor.

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks, that is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-InternetMonitor.html) in the Amazon CloudWatch User Guide.

When you create a monitor, you set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time by updating your monitor. For more information, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) in the Amazon CloudWatch User Guide.

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 Amazon CloudWatch Internet Monitor's API operation CreateMonitor for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

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

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The requested resource is in use.

  • LimitExceededException The request exceeded a service quota.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/CreateMonitor

func (*InternetMonitor) CreateMonitorRequest 

func (c *InternetMonitor) CreateMonitorRequest(input *CreateMonitorInput) (req *request.Request, output *CreateMonitorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/CreateMonitor

func (*InternetMonitor) CreateMonitorWithContext 

func (c *InternetMonitor) CreateMonitorWithContext(ctx aws.Context, input *CreateMonitorInput, opts ...request.Option) (*CreateMonitorOutput, error)

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

See CreateMonitor 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 (*InternetMonitor) DeleteMonitor 

func (c *InternetMonitor) DeleteMonitor(input *DeleteMonitorInput) (*DeleteMonitorOutput, error)

DeleteMonitor API operation for Amazon CloudWatch Internet Monitor.

Deletes a monitor in Amazon CloudWatch Internet 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 Amazon CloudWatch Internet Monitor's API operation DeleteMonitor for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/DeleteMonitor

func (*InternetMonitor) DeleteMonitorRequest 

func (c *InternetMonitor) DeleteMonitorRequest(input *DeleteMonitorInput) (req *request.Request, output *DeleteMonitorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/DeleteMonitor

func (*InternetMonitor) DeleteMonitorWithContext 

func (c *InternetMonitor) DeleteMonitorWithContext(ctx aws.Context, input *DeleteMonitorInput, opts ...request.Option) (*DeleteMonitorOutput, error)

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

See DeleteMonitor 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 (*InternetMonitor) GetHealthEvent 

func (c *InternetMonitor) GetHealthEvent(input *GetHealthEventInput) (*GetHealthEventOutput, error)

GetHealthEvent API operation for Amazon CloudWatch Internet Monitor.

Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all of the information related to the event by location.

The information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type, and so on.

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

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 Amazon CloudWatch Internet Monitor's API operation GetHealthEvent for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetHealthEvent

func (*InternetMonitor) GetHealthEventRequest 

func (c *InternetMonitor) GetHealthEventRequest(input *GetHealthEventInput) (req *request.Request, output *GetHealthEventOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetHealthEvent

func (*InternetMonitor) GetHealthEventWithContext 

func (c *InternetMonitor) GetHealthEventWithContext(ctx aws.Context, input *GetHealthEventInput, opts ...request.Option) (*GetHealthEventOutput, error)

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

See GetHealthEvent 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 (*InternetMonitor) GetMonitor 

func (c *InternetMonitor) GetMonitor(input *GetMonitorInput) (*GetMonitorOutput, error)

GetMonitor API operation for Amazon CloudWatch Internet Monitor.

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

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 Amazon CloudWatch Internet Monitor's API operation GetMonitor for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetMonitor

func (*InternetMonitor) GetMonitorRequest 

func (c *InternetMonitor) GetMonitorRequest(input *GetMonitorInput) (req *request.Request, output *GetMonitorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/GetMonitor

func (*InternetMonitor) GetMonitorWithContext 

func (c *InternetMonitor) GetMonitorWithContext(ctx aws.Context, input *GetMonitorInput, opts ...request.Option) (*GetMonitorOutput, error)

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

See GetMonitor 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 (*InternetMonitor) ListHealthEvents 

func (c *InternetMonitor) ListHealthEvents(input *ListHealthEventsInput) (*ListHealthEventsOutput, error)

ListHealthEvents API operation for Amazon CloudWatch Internet Monitor.

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network cause and status, event start and end time, percentage of total traffic impacted, and status.

Health events that have start times during the time frame that is requested are not included in the list of health events.

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 Amazon CloudWatch Internet Monitor's API operation ListHealthEvents for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListHealthEvents

func (*InternetMonitor) ListHealthEventsPages 

func (c *InternetMonitor) ListHealthEventsPages(input *ListHealthEventsInput, fn func(*ListHealthEventsOutput, bool) bool) error

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

See ListHealthEvents 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 ListHealthEvents operation.
pageNum := 0
err := client.ListHealthEventsPages(params,
    func(page *internetmonitor.ListHealthEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*InternetMonitor) ListHealthEventsPagesWithContext 

func (c *InternetMonitor) ListHealthEventsPagesWithContext(ctx aws.Context, input *ListHealthEventsInput, fn func(*ListHealthEventsOutput, bool) bool, opts ...request.Option) error

ListHealthEventsPagesWithContext same as ListHealthEventsPages 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 (*InternetMonitor) ListHealthEventsRequest 

func (c *InternetMonitor) ListHealthEventsRequest(input *ListHealthEventsInput) (req *request.Request, output *ListHealthEventsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListHealthEvents

func (*InternetMonitor) ListHealthEventsWithContext 

func (c *InternetMonitor) ListHealthEventsWithContext(ctx aws.Context, input *ListHealthEventsInput, opts ...request.Option) (*ListHealthEventsOutput, error)

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

See ListHealthEvents 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 (*InternetMonitor) ListMonitors 

func (c *InternetMonitor) ListMonitors(input *ListMonitorsInput) (*ListMonitorsOutput, error)

ListMonitors API operation for Amazon CloudWatch Internet Monitor.

Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each 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 Amazon CloudWatch Internet Monitor's API operation ListMonitors for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListMonitors

func (*InternetMonitor) ListMonitorsPages 

func (c *InternetMonitor) ListMonitorsPages(input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool) error

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

See ListMonitors 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 ListMonitors operation.
pageNum := 0
err := client.ListMonitorsPages(params,
    func(page *internetmonitor.ListMonitorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*InternetMonitor) ListMonitorsPagesWithContext 

func (c *InternetMonitor) ListMonitorsPagesWithContext(ctx aws.Context, input *ListMonitorsInput, fn func(*ListMonitorsOutput, bool) bool, opts ...request.Option) error

ListMonitorsPagesWithContext same as ListMonitorsPages 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 (*InternetMonitor) ListMonitorsRequest 

func (c *InternetMonitor) ListMonitorsRequest(input *ListMonitorsInput) (req *request.Request, output *ListMonitorsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListMonitors

func (*InternetMonitor) ListMonitorsWithContext 

func (c *InternetMonitor) ListMonitorsWithContext(ctx aws.Context, input *ListMonitorsInput, opts ...request.Option) (*ListMonitorsOutput, error)

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

See ListMonitors 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 (*InternetMonitor) ListTagsForResource 

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

ListTagsForResource API operation for Amazon CloudWatch Internet Monitor.

Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet 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 Amazon CloudWatch Internet Monitor's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • TooManyRequestsException There were too many requests.

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

  • NotFoundException The request specifies something that doesn't exist.

  • BadRequestException A bad request was received.

  • InternalServerErrorException There was an internal server error.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/ListTagsForResource

func (*InternetMonitor) ListTagsForResourceRequest 

func (c *InternetMonitor) 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/internetmonitor-2021-06-03/ListTagsForResource

func (*InternetMonitor) ListTagsForResourceWithContext 

func (c *InternetMonitor) 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 (*InternetMonitor) TagResource 

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

TagResource API operation for Amazon CloudWatch Internet Monitor.

Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.

A minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.

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

Returned Error Types:

  • TooManyRequestsException There were too many requests.

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

  • NotFoundException The request specifies something that doesn't exist.

  • BadRequestException A bad request was received.

  • InternalServerErrorException There was an internal server error.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/TagResource

func (*InternetMonitor) TagResourceRequest 

func (c *InternetMonitor) 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/internetmonitor-2021-06-03/TagResource

func (*InternetMonitor) TagResourceWithContext 

func (c *InternetMonitor) 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 (*InternetMonitor) UntagResource 

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

UntagResource API operation for Amazon CloudWatch Internet Monitor.

Removes a tag from a 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 Amazon CloudWatch Internet Monitor's API operation UntagResource for usage and error information.

Returned Error Types:

  • TooManyRequestsException There were too many requests.

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

  • NotFoundException The request specifies something that doesn't exist.

  • BadRequestException A bad request was received.

  • InternalServerErrorException There was an internal server error.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UntagResource

func (*InternetMonitor) UntagResourceRequest 

func (c *InternetMonitor) 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/internetmonitor-2021-06-03/UntagResource

func (*InternetMonitor) UntagResourceWithContext 

func (c *InternetMonitor) 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 (*InternetMonitor) UpdateMonitor 

func (c *InternetMonitor) UpdateMonitor(input *UpdateMonitorInput) (*UpdateMonitorOutput, error)

UpdateMonitor API operation for Amazon CloudWatch Internet Monitor.

Updates a monitor. You can update a monitor to change the maximum number of city-networks (locations and ASNs or internet service providers), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html) in the Amazon CloudWatch User Guide.

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 Amazon CloudWatch Internet Monitor's API operation UpdateMonitor for usage and error information.

Returned Error Types:

  • InternalServerException An internal error occurred.

  • ResourceNotFoundException The request specifies a resource that doesn't exist.

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

  • ThrottlingException The request was denied due to request throttling.

  • LimitExceededException The request exceeded a service quota.

  • ValidationException Invalid request.

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UpdateMonitor

func (*InternetMonitor) UpdateMonitorRequest 

func (c *InternetMonitor) UpdateMonitorRequest(input *UpdateMonitorInput) (req *request.Request, output *UpdateMonitorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/internetmonitor-2021-06-03/UpdateMonitor

func (*InternetMonitor) UpdateMonitorWithContext 

func (c *InternetMonitor) UpdateMonitorWithContext(ctx aws.Context, input *UpdateMonitorInput, opts ...request.Option) (*UpdateMonitorOutput, error)

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

See UpdateMonitor 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 LimitExceededException 

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

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

The request exceeded a service quota.

func (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) 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 (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String 

func (s LimitExceededException) 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 ListHealthEventsInput 

type ListHealthEventsInput struct {

	// The time when a health event ended. If the health event is still ongoing,
	// then the end time is not set.
	EndTime *time.Time `location:"querystring" locationName:"EndTime" type:"timestamp" timestampFormat:"iso8601"`

	// The status of a health event.
	EventStatus *string `location:"querystring" locationName:"EventStatus" type:"string" enum:"HealthEventStatus"`

	// The number of health event objects that you want to return with this call.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"MonitorName" min:"1" type:"string" required:"true"`

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The time when a health event started.
	StartTime *time.Time `location:"querystring" locationName:"StartTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

func (ListHealthEventsInput) GoString 

func (s ListHealthEventsInput) 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 (*ListHealthEventsInput) SetEndTime 

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

SetEndTime sets the EndTime field's value.

func (*ListHealthEventsInput) SetEventStatus 

func (s *ListHealthEventsInput) SetEventStatus(v string) *ListHealthEventsInput

SetEventStatus sets the EventStatus field's value.

func (*ListHealthEventsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListHealthEventsInput) SetMonitorName 

func (s *ListHealthEventsInput) SetMonitorName(v string) *ListHealthEventsInput

SetMonitorName sets the MonitorName field's value.

func (*ListHealthEventsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListHealthEventsInput) SetStartTime 

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

SetStartTime sets the StartTime field's value.

func (ListHealthEventsInput) String 

func (s ListHealthEventsInput) 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 (*ListHealthEventsInput) Validate 

func (s *ListHealthEventsInput) Validate() error

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

type ListHealthEventsOutput 

type ListHealthEventsOutput struct {

	// A list of health events.
	//
	// HealthEvents is a required field
	HealthEvents []*HealthEvent `type:"list" required:"true"`

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListHealthEventsOutput) GoString 

func (s ListHealthEventsOutput) 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 (*ListHealthEventsOutput) SetHealthEvents 

func (s *ListHealthEventsOutput) SetHealthEvents(v []*HealthEvent) *ListHealthEventsOutput

SetHealthEvents sets the HealthEvents field's value.

func (*ListHealthEventsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListHealthEventsOutput) String 

func (s ListHealthEventsOutput) 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 ListMonitorsInput 

type ListMonitorsInput struct {

	// The number of monitor objects that you want to return with this call.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The status of a monitor. This includes the status of the data processing
	// for the monitor and the status of the monitor itself.
	//
	// For information about the statuses for a monitor, see Monitor (https://docs.aws.amazon.com/internet-monitor/latest/api/API_Monitor.html).
	MonitorStatus *string `location:"querystring" locationName:"MonitorStatus" type:"string"`

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListMonitorsInput) GoString 

func (s ListMonitorsInput) 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 (*ListMonitorsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMonitorsInput) SetMonitorStatus 

func (s *ListMonitorsInput) SetMonitorStatus(v string) *ListMonitorsInput

SetMonitorStatus sets the MonitorStatus field's value.

func (*ListMonitorsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListMonitorsInput) String 

func (s ListMonitorsInput) 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 (*ListMonitorsInput) Validate 

func (s *ListMonitorsInput) Validate() error

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

type ListMonitorsOutput 

type ListMonitorsOutput struct {

	// A list of monitors.
	//
	// Monitors is a required field
	Monitors []*Monitor `type:"list" required:"true"`

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListMonitorsOutput) GoString 

func (s ListMonitorsOutput) 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 (*ListMonitorsOutput) SetMonitors 

func (s *ListMonitorsOutput) SetMonitors(v []*Monitor) *ListMonitorsOutput

SetMonitors sets the Monitors field's value.

func (*ListMonitorsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListMonitorsOutput) String 

func (s ListMonitorsOutput) 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 Amazon Resource Name (ARN) for a resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"20" 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 {

	// Tags for a resource.
	Tags map[string]*string `type:"map"`
	// 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) 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 Monitor 

type Monitor struct {

	// The Amazon Resource Name (ARN) of the monitor.
	//
	// MonitorArn is a required field
	MonitorArn *string `min:"20" type:"string" required:"true"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `min:"1" type:"string" required:"true"`

	// The health of data processing for the monitor.
	ProcessingStatus *string `type:"string" enum:"MonitorProcessingStatusCode"`

	// The status of a monitor.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"MonitorConfigState"`
	// contains filtered or unexported fields
}

The description of and information about a monitor in Amazon CloudWatch Internet Monitor.

func (Monitor) GoString 

func (s Monitor) 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 (*Monitor) SetMonitorArn 

func (s *Monitor) SetMonitorArn(v string) *Monitor

SetMonitorArn sets the MonitorArn field's value.

func (*Monitor) SetMonitorName 

func (s *Monitor) SetMonitorName(v string) *Monitor

SetMonitorName sets the MonitorName field's value.

func (*Monitor) SetProcessingStatus 

func (s *Monitor) SetProcessingStatus(v string) *Monitor

SetProcessingStatus sets the ProcessingStatus field's value.

func (*Monitor) SetStatus 

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

SetStatus sets the Status field's value.

func (Monitor) String 

func (s Monitor) 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 Network 

type Network struct {

	// The internet provider name or network name.
	//
	// ASName is a required field
	ASName *string `type:"string" required:"true"`

	// The Autonomous System Number (ASN) of the internet provider or network.
	//
	// ASNumber is a required field
	ASNumber *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

An internet service provider (ISP) or network in Amazon CloudWatch Internet Monitor.

func (Network) GoString 

func (s Network) 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 (*Network) SetASName 

func (s *Network) SetASName(v string) *Network

SetASName sets the ASName field's value.

func (*Network) SetASNumber 

func (s *Network) SetASNumber(v int64) *Network

SetASNumber sets the ASNumber field's value.

func (Network) String 

func (s Network) 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 NetworkImpairment 

type NetworkImpairment struct {

	// The combination of the Autonomous System Number (ASN) of the network and
	// the name of the network.
	//
	// AsPath is a required field
	AsPath []*Network `type:"list" required:"true"`

	// Type of network impairment.
	//
	// NetworkEventType is a required field
	NetworkEventType *string `type:"string" required:"true" enum:"TriangulationEventType"`

	// The networks that could be impacted by a network impairment event.
	//
	// Networks is a required field
	Networks []*Network `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.

func (NetworkImpairment) GoString 

func (s NetworkImpairment) 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 (*NetworkImpairment) SetAsPath 

func (s *NetworkImpairment) SetAsPath(v []*Network) *NetworkImpairment

SetAsPath sets the AsPath field's value.

func (*NetworkImpairment) SetNetworkEventType 

func (s *NetworkImpairment) SetNetworkEventType(v string) *NetworkImpairment

SetNetworkEventType sets the NetworkEventType field's value.

func (*NetworkImpairment) SetNetworks 

func (s *NetworkImpairment) SetNetworks(v []*Network) *NetworkImpairment

SetNetworks sets the Networks field's value.

func (NetworkImpairment) String 

func (s NetworkImpairment) 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 NotFoundException 

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

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

The request specifies something that doesn't exist.

func (*NotFoundException) Code 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString 

func (s NotFoundException) 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 (*NotFoundException) Message 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode 

func (s *NotFoundException) StatusCode() int

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

func (NotFoundException) String 

func (s NotFoundException) 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 PerformanceMeasurement 

type PerformanceMeasurement struct {

	// Experience scores, or health scores, are calculated for different geographic
	// and network provider combinations (that is, different granularities) and
	// also totaled into global scores. If you view performance or availability
	// scores without filtering for any specific geography or service provider,
	// Amazon CloudWatch Internet Monitor provides global health scores.
	//
	// The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide
	// includes detailed information about how Internet Monitor calculates health
	// scores, including performance and availability scores, and when it creates
	// and resolves health events. For more information, see How Amazon Web Services
	// calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	ExperienceScore *float64 `type:"double"`

	// How much performance impact was caused by a health event at a client location.
	// For performance, this is the percentage of how much latency increased during
	// the event compared to typical performance for traffic, from this client location
	// to an Amazon Web Services location, using a specific client network.
	//
	// For more information, see When Amazon Web Services creates and resolves health
	// events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	PercentOfClientLocationImpacted *float64 `type:"double"`

	// How much performance impact was caused by a health event for total traffic
	// globally. For performance, this is the percentage of how much latency increased
	// during the event compared to typical performance for your application traffic
	// globally.
	//
	// For more information, see When Amazon Web Services creates and resolves health
	// events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	PercentOfTotalTrafficImpacted *float64 `type:"double"`

	// This is the percentage of how much round-trip time increased during the event
	// compared to typical round-trip time for your application for traffic.
	//
	// For more information, see When Amazon Web Services creates and resolves health
	// events (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMHealthEventStartStop)
	// in the Amazon CloudWatch Internet Monitor section of the CloudWatch User
	// Guide.
	RoundTripTime *RoundTripTime `type:"structure"`
	// contains filtered or unexported fields
}

Measurements about the performance for your application on the internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.

Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.

For more information, see How Internet Monitor calculates performance and availability scores (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-inside-internet-monitor.html#IMExperienceScores) in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

func (PerformanceMeasurement) GoString 

func (s PerformanceMeasurement) 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 (*PerformanceMeasurement) SetExperienceScore 

func (s *PerformanceMeasurement) SetExperienceScore(v float64) *PerformanceMeasurement

SetExperienceScore sets the ExperienceScore field's value.

func (*PerformanceMeasurement) SetPercentOfClientLocationImpacted 

func (s *PerformanceMeasurement) SetPercentOfClientLocationImpacted(v float64) *PerformanceMeasurement

SetPercentOfClientLocationImpacted sets the PercentOfClientLocationImpacted field's value.

func (*PerformanceMeasurement) SetPercentOfTotalTrafficImpacted 

func (s *PerformanceMeasurement) SetPercentOfTotalTrafficImpacted(v float64) *PerformanceMeasurement

SetPercentOfTotalTrafficImpacted sets the PercentOfTotalTrafficImpacted field's value.

func (*PerformanceMeasurement) SetRoundTripTime 

func (s *PerformanceMeasurement) SetRoundTripTime(v *RoundTripTime) *PerformanceMeasurement

SetRoundTripTime sets the RoundTripTime field's value.

func (PerformanceMeasurement) String 

func (s PerformanceMeasurement) 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"`
	// contains filtered or unexported fields
}

The request specifies a resource that doesn't exist.

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 RoundTripTime 

type RoundTripTime struct {

	// RTT at the 50th percentile (p50).
	P50 *float64 `type:"double"`

	// RTT at the 90th percentile (p90).
	P90 *float64 `type:"double"`

	// RTT at the 95th percentile (p95).
	P95 *float64 `type:"double"`
	// contains filtered or unexported fields
}

Round-trip time (RTT) is how long it takes for a request from the user to return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at different percentiles: p50, p90, and p95.

func (RoundTripTime) GoString 

func (s RoundTripTime) 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 (*RoundTripTime) SetP50 

func (s *RoundTripTime) SetP50(v float64) *RoundTripTime

SetP50 sets the P50 field's value.

func (*RoundTripTime) SetP90 

func (s *RoundTripTime) SetP90(v float64) *RoundTripTime

SetP90 sets the P90 field's value.

func (*RoundTripTime) SetP95 

func (s *RoundTripTime) SetP95(v float64) *RoundTripTime

SetP95 sets the P95 field's value.

func (RoundTripTime) String 

func (s RoundTripTime) 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 S3Config added in v1.44.234 

type S3Config struct {

	// The Amazon S3 bucket name.
	BucketName *string `min:"3" type:"string"`

	// The Amazon S3 bucket prefix.
	BucketPrefix *string `type:"string"`

	// The status of publishing Internet Monitor internet measurements to an Amazon
	// S3 bucket.
	LogDeliveryStatus *string `type:"string" enum:"LogDeliveryStatus"`
	// contains filtered or unexported fields
}

The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED, depending on whether you choose to deliver internet measurements to S3 logs.

func (S3Config) GoString added in v1.44.234 

func (s S3Config) 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 (*S3Config) SetBucketName added in v1.44.234 

func (s *S3Config) SetBucketName(v string) *S3Config

SetBucketName sets the BucketName field's value.

func (*S3Config) SetBucketPrefix added in v1.44.234 

func (s *S3Config) SetBucketPrefix(v string) *S3Config

SetBucketPrefix sets the BucketPrefix field's value.

func (*S3Config) SetLogDeliveryStatus added in v1.44.234 

func (s *S3Config) SetLogDeliveryStatus(v string) *S3Config

SetLogDeliveryStatus sets the LogDeliveryStatus field's value.

func (S3Config) String added in v1.44.234 

func (s S3Config) 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 (*S3Config) Validate added in v1.44.234 

func (s *S3Config) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags
	// are supported only for monitors in Amazon CloudWatch Internet Monitor.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"20" type:"string" required:"true"`

	// Tags that you add to a resource. You can add a maximum of 50 tags in Internet
	// Monitor.
	//
	// 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"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

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 TooManyRequestsException 

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

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

There were too many requests.

func (*TooManyRequestsException) Code 

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error 

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString 

func (s TooManyRequestsException) 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 (*TooManyRequestsException) Message 

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr 

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID 

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode 

func (s *TooManyRequestsException) StatusCode() int

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

func (TooManyRequestsException) String 

func (s TooManyRequestsException) 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 UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) for a tag you remove a resource from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"20" type:"string" required:"true"`

	// Tag keys that you remove from a 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 UpdateMonitorInput 

type UpdateMonitorInput struct {

	// A unique, case-sensitive string of up to 64 ASCII characters that you specify
	// to make an idempotent API request. You should not reuse the same client token
	// for other API requests.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// Publish internet measurements for Internet Monitor to another location, such
	// as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch
	// Logs.
	InternetMeasurementsLogDelivery *InternetMeasurementsLogDelivery `type:"structure"`

	// The maximum number of city-networks to monitor for your resources. A city-network
	// is the location (city) where clients access your application resources from
	// and the network or ASN, such as an internet service provider, that clients
	// access the resources through.
	MaxCityNetworksToMonitor *int64 `min:"1" type:"integer"`

	// The name of the monitor.
	//
	// MonitorName is a required field
	MonitorName *string `location:"uri" locationName:"MonitorName" min:"1" type:"string" required:"true"`

	// The resources to include in a monitor, which you provide as a set of Amazon
	// Resource Names (ARNs).
	//
	// You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon
	// CloudFront distributions, or you can add Amazon WorkSpaces directories. You
	// can't add all three types of resources.
	//
	// If you add only VPC resources, at least one VPC must have an Internet Gateway
	// attached to it, to make sure that it has internet connectivity.
	ResourcesToAdd []*string `type:"list"`

	// The resources to remove from a monitor, which you provide as a set of Amazon
	// Resource Names (ARNs).
	ResourcesToRemove []*string `type:"list"`

	// The status for a monitor. The accepted values for Status with the UpdateMonitor
	// API call are the following: ACTIVE and INACTIVE. The following values are
	// not accepted: PENDING, and ERROR.
	Status *string `type:"string" enum:"MonitorConfigState"`

	// The percentage of the internet-facing traffic for your application that you
	// want to monitor with this monitor.
	TrafficPercentageToMonitor *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateMonitorInput) GoString 

func (s UpdateMonitorInput) 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 (*UpdateMonitorInput) SetClientToken 

func (s *UpdateMonitorInput) SetClientToken(v string) *UpdateMonitorInput

SetClientToken sets the ClientToken field's value.

func (*UpdateMonitorInput) SetInternetMeasurementsLogDelivery added in v1.44.234 

func (s *UpdateMonitorInput) SetInternetMeasurementsLogDelivery(v *InternetMeasurementsLogDelivery) *UpdateMonitorInput

SetInternetMeasurementsLogDelivery sets the InternetMeasurementsLogDelivery field's value.

func (*UpdateMonitorInput) SetMaxCityNetworksToMonitor 

func (s *UpdateMonitorInput) SetMaxCityNetworksToMonitor(v int64) *UpdateMonitorInput

SetMaxCityNetworksToMonitor sets the MaxCityNetworksToMonitor field's value.

func (*UpdateMonitorInput) SetMonitorName 

func (s *UpdateMonitorInput) SetMonitorName(v string) *UpdateMonitorInput

SetMonitorName sets the MonitorName field's value.

func (*UpdateMonitorInput) SetResourcesToAdd 

func (s *UpdateMonitorInput) SetResourcesToAdd(v []*string) *UpdateMonitorInput

SetResourcesToAdd sets the ResourcesToAdd field's value.

func (*UpdateMonitorInput) SetResourcesToRemove 

func (s *UpdateMonitorInput) SetResourcesToRemove(v []*string) *UpdateMonitorInput

SetResourcesToRemove sets the ResourcesToRemove field's value.

func (*UpdateMonitorInput) SetStatus 

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

SetStatus sets the Status field's value.

func (*UpdateMonitorInput) SetTrafficPercentageToMonitor added in v1.44.245 

func (s *UpdateMonitorInput) SetTrafficPercentageToMonitor(v int64) *UpdateMonitorInput

SetTrafficPercentageToMonitor sets the TrafficPercentageToMonitor field's value.

func (UpdateMonitorInput) String 

func (s UpdateMonitorInput) 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 (*UpdateMonitorInput) Validate 

func (s *UpdateMonitorInput) Validate() error

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

type UpdateMonitorOutput 

type UpdateMonitorOutput struct {

	// The Amazon Resource Name (ARN) of the monitor.
	//
	// MonitorArn is a required field
	MonitorArn *string `min:"20" type:"string" required:"true"`

	// The status of a monitor.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"MonitorConfigState"`
	// contains filtered or unexported fields
}

func (UpdateMonitorOutput) GoString 

func (s UpdateMonitorOutput) 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 (*UpdateMonitorOutput) SetMonitorArn 

func (s *UpdateMonitorOutput) SetMonitorArn(v string) *UpdateMonitorOutput

SetMonitorArn sets the MonitorArn field's value.

func (*UpdateMonitorOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (UpdateMonitorOutput) String 

func (s UpdateMonitorOutput) 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
}

Invalid request.

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 internetmonitoriface provides an interface to enable mocking the Amazon CloudWatch Internet Monitor service client for testing your code.
 Package internetmonitoriface provides an interface to enable mocking the Amazon CloudWatch Internet Monitor 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.