types

package
v1.1.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string
}

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) in the IAM User Guide.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AnomalySeverity

type AnomalySeverity string
const (
	AnomalySeverityLow    AnomalySeverity = "LOW"
	AnomalySeverityMedium AnomalySeverity = "MEDIUM"
	AnomalySeverityHigh   AnomalySeverity = "HIGH"
)

Enum values for AnomalySeverity

func (AnomalySeverity) Values

func (AnomalySeverity) Values() []AnomalySeverity

Values returns all known values for AnomalySeverity. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnomalySourceDetails

type AnomalySourceDetails struct {

	// An array of CloudWatchMetricsDetail object that contains information about the
	// analyzed metrics that displayed anomalous behavior.
	CloudWatchMetrics []CloudWatchMetricsDetail
}

Details about the source of the anomalous operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

type AnomalyStatus

type AnomalyStatus string
const (
	AnomalyStatusOngoing AnomalyStatus = "ONGOING"
	AnomalyStatusClosed  AnomalyStatus = "CLOSED"
)

Enum values for AnomalyStatus

func (AnomalyStatus) Values

func (AnomalyStatus) Values() []AnomalyStatus

Values returns all known values for AnomalyStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnomalyTimeRange

type AnomalyTimeRange struct {

	// The time when the anomalous behavior started.
	//
	// This member is required.
	StartTime *time.Time

	// The time when the anomalous behavior ended.
	EndTime *time.Time
}

A time range that specifies when the observed unusual behavior in an anomaly started and ended.

type CloudFormationCollection

type CloudFormationCollection struct {

	// An array of CloudFormation stack names.
	StackNames []string
}

Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the AWS CloudFormation User Guide.

type CloudFormationCollectionFilter

type CloudFormationCollectionFilter struct {

	// An array of CloudFormation stack names.
	StackNames []string
}

Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in the AWS CloudFormation User Guide.

type CloudFormationHealth

type CloudFormationHealth struct {

	// Information about the health of the AWS resources in your account that are
	// specified by an AWS CloudFormation stack, including the number of open
	// proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed
	// insights.
	Insight *InsightHealth

	// The name of the CloudFormation stack.
	StackName *string
}

Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.

type CloudWatchMetricsDetail

type CloudWatchMetricsDetail struct {

	// An array of CloudWatch dimensions associated with
	Dimensions []CloudWatchMetricsDimension

	// The name of the CloudWatch metric.
	MetricName *string

	// The namespace of the CloudWatch metric. A namespace is a container for
	// CloudWatch metrics.
	Namespace *string

	// The length of time associated with the CloudWatch metric in number of seconds.
	Period int32

	// The type of statistic associated with the CloudWatch metric. For more
	// information, see Statistics
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic)
	// in the Amazon CloudWatch User Guide.
	Stat CloudWatchMetricsStat

	// The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds,
	// Count, and Percent.
	Unit *string
}

Information about an Amazon CloudWatch metric.

type CloudWatchMetricsDimension

type CloudWatchMetricsDimension struct {

	// The name of the CloudWatch dimension.
	Name *string

	// The value of the CloudWatch dimension.
	Value *string
}

The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behaviour. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension) in the Amazon CloudWatch User Guide.

type CloudWatchMetricsStat

type CloudWatchMetricsStat string
const (
	CloudWatchMetricsStatSum         CloudWatchMetricsStat = "Sum"
	CloudWatchMetricsStatAverage     CloudWatchMetricsStat = "Average"
	CloudWatchMetricsStatSampleCount CloudWatchMetricsStat = "SampleCount"
	CloudWatchMetricsStatMinimum     CloudWatchMetricsStat = "Minimum"
	CloudWatchMetricsStatMaximum     CloudWatchMetricsStat = "Maximum"
	CloudWatchMetricsStatP99         CloudWatchMetricsStat = "p99"
	CloudWatchMetricsStatP90         CloudWatchMetricsStat = "p90"
	CloudWatchMetricsStatP50         CloudWatchMetricsStat = "p50"
)

Enum values for CloudWatchMetricsStat

func (CloudWatchMetricsStat) Values

Values returns all known values for CloudWatchMetricsStat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException

type ConflictException struct {
	Message *string

	ResourceId   *string
	ResourceType *string
}

An exception that is thrown when a conflict occurs.

func (*ConflictException) Error

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage

func (e *ConflictException) ErrorMessage() string

type EndTimeRange

type EndTimeRange struct {

	// The earliest end time in the time range.
	FromTime *time.Time

	// The latest end time in the time range.
	ToTime *time.Time
}

A range of time that specifies when anomalous behavior in an anomaly or insight ended.

type Event

type Event struct {

	// The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found
	// the event.
	DataSource EventDataSource

	// The class of the event. The class specifies what the event is related to, such
	// as an infrastructure change, a deployment, or a schema change.
	EventClass EventClass

	// The AWS source that emitted the event.
	EventSource *string

	// The ID of the event.
	Id *string

	// The name of the event.
	Name *string

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// An EventResource object that contains information about the resource that
	// emitted the event.
	Resources []EventResource

	// A Timestamp that specifies the time the event occurred.
	Time *time.Time
}

An AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

type EventClass

type EventClass string
const (
	EventClassInfrastructure EventClass = "INFRASTRUCTURE"
	EventClassDeployment     EventClass = "DEPLOYMENT"
	EventClassSecurityChange EventClass = "SECURITY_CHANGE"
	EventClassConfigChange   EventClass = "CONFIG_CHANGE"
	EventClassSchemaChange   EventClass = "SCHEMA_CHANGE"
)

Enum values for EventClass

func (EventClass) Values

func (EventClass) Values() []EventClass

Values returns all known values for EventClass. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EventDataSource

type EventDataSource string
const (
	EventDataSourceAwsCloudTrail EventDataSource = "AWS_CLOUD_TRAIL"
	EventDataSourceAwsCodeDeploy EventDataSource = "AWS_CODE_DEPLOY"
)

Enum values for EventDataSource

func (EventDataSource) Values

func (EventDataSource) Values() []EventDataSource

Values returns all known values for EventDataSource. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EventResource

type EventResource struct {

	// The Amazon Resource Name (ARN) of the resource that emitted an event.
	Arn *string

	// The name of the resource that emitted an event.
	Name *string

	// The type of resource that emitted an event.
	Type *string
}

The AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

type EventTimeRange

type EventTimeRange struct {

	// The time when the event started.
	//
	// This member is required.
	FromTime *time.Time

	// The time when the event ended.
	//
	// This member is required.
	ToTime *time.Time
}

The time range during which an AWS event occurred. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions.

type InsightFeedback

type InsightFeedback struct {

	// The feedback provided by the customer.
	Feedback InsightFeedbackOption

	// The insight feedback ID.
	Id *string
}

Information about insight feedback received from a customer.

type InsightFeedbackOption

type InsightFeedbackOption string
const (
	InsightFeedbackOptionValidCollection      InsightFeedbackOption = "VALID_COLLECTION"
	InsightFeedbackOptionRecommendationUseful InsightFeedbackOption = "RECOMMENDATION_USEFUL"
	InsightFeedbackOptionAlertTooSensitive    InsightFeedbackOption = "ALERT_TOO_SENSITIVE"
	InsightFeedbackOptionDataNoisyAnomaly     InsightFeedbackOption = "DATA_NOISY_ANOMALY"
	InsightFeedbackOptionDataIncorrect        InsightFeedbackOption = "DATA_INCORRECT"
)

Enum values for InsightFeedbackOption

func (InsightFeedbackOption) Values

Values returns all known values for InsightFeedbackOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InsightHealth

type InsightHealth struct {

	// The Meant Time to Recover (MTTR) for the insight.
	MeanTimeToRecoverInMilliseconds *int64

	// The number of open proactive insights.
	OpenProactiveInsights int32

	// The number of open reactive insights.
	OpenReactiveInsights int32
}

Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.

type InsightSeverity

type InsightSeverity string
const (
	InsightSeverityLow    InsightSeverity = "LOW"
	InsightSeverityMedium InsightSeverity = "MEDIUM"
	InsightSeverityHigh   InsightSeverity = "HIGH"
)

Enum values for InsightSeverity

func (InsightSeverity) Values

func (InsightSeverity) Values() []InsightSeverity

Values returns all known values for InsightSeverity. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InsightStatus

type InsightStatus string
const (
	InsightStatusOngoing InsightStatus = "ONGOING"
	InsightStatusClosed  InsightStatus = "CLOSED"
)

Enum values for InsightStatus

func (InsightStatus) Values

func (InsightStatus) Values() []InsightStatus

Values returns all known values for InsightStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InsightTimeRange

type InsightTimeRange struct {

	// The time when the behavior described in an insight started.
	//
	// This member is required.
	StartTime *time.Time

	// The time when the behavior described in an insight ended.
	EndTime *time.Time
}

A time ranged that specifies when the observed behavior in an insight started and ended.

type InsightType

type InsightType string
const (
	InsightTypeReactive  InsightType = "REACTIVE"
	InsightTypeProactive InsightType = "PROACTIVE"
)

Enum values for InsightType

func (InsightType) Values

func (InsightType) Values() []InsightType

Values returns all known values for InsightType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException

type InternalServerException struct {
	Message *string

	RetryAfterSeconds int32
}

An internal failure in an Amazon service occurred.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type ListEventsFilters

type ListEventsFilters struct {

	// The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.
	DataSource EventDataSource

	// The class of the events you want to filter for, such as an infrastructure
	// change, a deployment, or a schema change.
	EventClass EventClass

	// The AWS source that emitted the events you want to filter for.
	EventSource *string

	// A time range during which you want the filtered events to have occurred.
	EventTimeRange *EventTimeRange

	// An ID of an insight that is related to the events you want to filter for.
	InsightId *string

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection
}

Filters you can use to specify which events are returned when ListEvents is called.

type ListInsightsAnyStatusFilter

type ListInsightsAnyStatusFilter struct {

	// A time range used to specify when the behavior of the filtered insights started.
	//
	// This member is required.
	StartTimeRange *StartTimeRange

	// Use to filter for either REACTIVE or PROACTIVE insights.
	//
	// This member is required.
	Type InsightType
}

Used to filter for insights that have any status.

type ListInsightsClosedStatusFilter

type ListInsightsClosedStatusFilter struct {

	// A time range used to specify when the behavior of the filtered insights ended.
	//
	// This member is required.
	EndTimeRange *EndTimeRange

	// Use to filter for either REACTIVE or PROACTIVE insights.
	//
	// This member is required.
	Type InsightType
}

Used to filter for insights that have the status CLOSED.

type ListInsightsOngoingStatusFilter

type ListInsightsOngoingStatusFilter struct {

	// Use to filter for either REACTIVE or PROACTIVE insights.
	//
	// This member is required.
	Type InsightType
}

Used to filter for insights that have the status ONGOING.

type ListInsightsStatusFilter

type ListInsightsStatusFilter struct {

	// A ListInsightsAnyStatusFilter that specifies insights of any status that are
	// either REACTIVE or PROACTIVE.
	Any *ListInsightsAnyStatusFilter

	// A ListInsightsClosedStatusFilter that specifies closed insights that are either
	// REACTIVE or PROACTIVE.
	Closed *ListInsightsClosedStatusFilter

	// A ListInsightsAnyStatusFilter that specifies ongoing insights that are either
	// REACTIVE or PROACTIVE.
	Ongoing *ListInsightsOngoingStatusFilter
}

A filter used by ListInsights to specify which insights to return.

type NotificationChannel

type NotificationChannel struct {

	// A NotificationChannelConfig object that contains information about configured
	// notification channels.
	Config *NotificationChannelConfig

	// The ID of a notification channel.
	Id *string
}

Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).

type NotificationChannelConfig

type NotificationChannelConfig struct {

	// Information about a notification channel configured in DevOps Guru to send
	// notifications when insights are created. If you use an Amazon SNS topic in
	// another account, you must attach a policy to it that grants DevOps Guru
	// permission to it notifications. DevOps Guru adds the required policy on your
	// behalf to send notifications using Amazon SNS in your account. For more
	// information, see Permissions for cross account Amazon SNS topics
	// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html).
	// If you use an Amazon SNS topic that is encrypted by an AWS Key Management
	// Service customer-managed key (CMK), then you must add permissions to the CMK.
	// For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics
	// (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).
	//
	// This member is required.
	Sns *SnsChannelConfig
}

Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

type OpsCenterIntegration

type OpsCenterIntegration struct {

	// Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for
	// each created insight.
	OptInStatus OptInStatus
}

Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

type OpsCenterIntegrationConfig

type OpsCenterIntegrationConfig struct {

	// Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for
	// each created insight.
	OptInStatus OptInStatus
}

Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

type OptInStatus

type OptInStatus string
const (
	OptInStatusEnabled  OptInStatus = "ENABLED"
	OptInStatusDisabled OptInStatus = "DISABLED"
)

Enum values for OptInStatus

func (OptInStatus) Values

func (OptInStatus) Values() []OptInStatus

Values returns all known values for OptInStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PredictionTimeRange

type PredictionTimeRange struct {

	// The time range during which a metric limit is expected to be exceeded. This
	// applies to proactive insights only.
	//
	// This member is required.
	StartTime *time.Time

	// The time when the behavior in a proactive insight is expected to end.
	EndTime *time.Time
}

The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

type ProactiveAnomaly

type ProactiveAnomaly struct {

	// A time range that specifies when the observed unusual behavior in an anomaly
	// started and ended.
	AnomalyTimeRange *AnomalyTimeRange

	// The ID of the insight that contains this anomaly. An insight is composed of
	// related anomalies.
	AssociatedInsightId *string

	// The ID of a proactive anomaly.
	Id *string

	// A threshold that was exceeded by behavior in analyzed resources. Exceeding this
	// threshold is related to the anomalous behavior that generated this anomaly.
	Limit *float64

	// The time range during which anomalous behavior in a proactive anomaly or an
	// insight is expected to occur.
	PredictionTimeRange *PredictionTimeRange

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of a proactive anomaly.
	Severity AnomalySeverity

	// Details about the source of the analyzed operational data that triggered the
	// anomaly. The one supported source is Amazon CloudWatch metrics.
	SourceDetails *AnomalySourceDetails

	// The status of a proactive anomaly.
	Status AnomalyStatus

	// The time of the anomaly's most recent update.
	UpdateTime *time.Time
}

Information about an anomaly. This object is returned by ListAnomalies.

type ProactiveAnomalySummary

type ProactiveAnomalySummary struct {

	// A time range that specifies when the observed unusual behavior in an anomaly
	// started and ended.
	AnomalyTimeRange *AnomalyTimeRange

	// The ID of the insight that contains this anomaly. An insight is composed of
	// related anomalies.
	AssociatedInsightId *string

	// The ID of the anomaly.
	Id *string

	// A threshold that was exceeded by behavior in analyzed resources. Exceeding this
	// threshold is related to the anomalous behavior that generated this anomaly.
	Limit *float64

	// The time range during which anomalous behavior in a proactive anomaly or an
	// insight is expected to occur.
	PredictionTimeRange *PredictionTimeRange

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of the anomaly.
	Severity AnomalySeverity

	// Details about the source of the analyzed operational data that triggered the
	// anomaly. The one supported source is Amazon CloudWatch metrics.
	SourceDetails *AnomalySourceDetails

	// The status of the anomaly.
	Status AnomalyStatus

	// The time of the anomaly's most recent update.
	UpdateTime *time.Time
}

Details about a proactive anomaly. This object is returned by DescribeAnomaly.

type ProactiveInsight

type ProactiveInsight struct {

	// The ID of the proactive insight.
	Id *string

	// A time ranged that specifies when the observed behavior in an insight started
	// and ended.
	InsightTimeRange *InsightTimeRange

	// The name of the proactive insight.
	Name *string

	// The time range during which anomalous behavior in a proactive anomaly or an
	// insight is expected to occur.
	PredictionTimeRange *PredictionTimeRange

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of the proactive insight.
	Severity InsightSeverity

	// The ID of the AWS System Manager OpsItem created for this insight. You must
	// enable the creation of OpstItems insights before they are created for each
	// insight.
	SsmOpsItemId *string

	// The status of the proactive insight.
	Status InsightStatus
}

Details about a proactive insight. This object is returned by ListInsights.

type ProactiveInsightSummary

type ProactiveInsightSummary struct {

	// The ID of the proactive insight.
	Id *string

	// A time ranged that specifies when the observed behavior in an insight started
	// and ended.
	InsightTimeRange *InsightTimeRange

	// The name of the proactive insight.
	Name *string

	// The time range during which anomalous behavior in a proactive anomaly or an
	// insight is expected to occur.
	PredictionTimeRange *PredictionTimeRange

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of the proactive insight.
	Severity InsightSeverity

	// The status of the proactive insight.
	Status InsightStatus
}

Details about a proactive insight. This object is returned by DescribeInsight.

type ReactiveAnomaly

type ReactiveAnomaly struct {

	// A time range that specifies when the observed unusual behavior in an anomaly
	// started and ended.
	AnomalyTimeRange *AnomalyTimeRange

	// The ID of the insight that contains this anomaly. An insight is composed of
	// related anomalies.
	AssociatedInsightId *string

	// The ID of the reactive anomaly.
	Id *string

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of the anomaly.
	Severity AnomalySeverity

	// Details about the source of the analyzed operational data that triggered the
	// anomaly. The one supported source is Amazon CloudWatch metrics.
	SourceDetails *AnomalySourceDetails

	// The status of the anomaly.
	Status AnomalyStatus
}

Details about a reactive anomaly. This object is returned by ListAnomalies.

type ReactiveAnomalySummary

type ReactiveAnomalySummary struct {

	// A time range that specifies when the observed unusual behavior in an anomaly
	// started and ended.
	AnomalyTimeRange *AnomalyTimeRange

	// The ID of the insight that contains this anomaly. An insight is composed of
	// related anomalies.
	AssociatedInsightId *string

	// The ID of the reactive anomaly.
	Id *string

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of the reactive anomaly.
	Severity AnomalySeverity

	// Details about the source of the analyzed operational data that triggered the
	// anomaly. The one supported source is Amazon CloudWatch metrics.
	SourceDetails *AnomalySourceDetails

	// The status of the reactive anomaly.
	Status AnomalyStatus
}

Details about a reactive anomaly. This object is returned by DescribeAnomaly.

type ReactiveInsight

type ReactiveInsight struct {

	// The ID of a reactive insight.
	Id *string

	// A time ranged that specifies when the observed behavior in an insight started
	// and ended.
	InsightTimeRange *InsightTimeRange

	// The name of a reactive insight.
	Name *string

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of a reactive insight.
	Severity InsightSeverity

	// The ID of the AWS System Manager OpsItem created for this insight. You must
	// enable the creation of OpstItems insights before they are created for each
	// insight.
	SsmOpsItemId *string

	// The status of a reactive insight.
	Status InsightStatus
}

Information about a reactive insight. This object is returned by ListInsights.

type ReactiveInsightSummary

type ReactiveInsightSummary struct {

	// The ID of a reactive summary.
	Id *string

	// A time ranged that specifies when the observed behavior in an insight started
	// and ended.
	InsightTimeRange *InsightTimeRange

	// The name of a reactive insight.
	Name *string

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// The severity of a reactive insight.
	Severity InsightSeverity

	// The status of a reactive insight.
	Status InsightStatus
}

Information about a reactive insight. This object is returned by DescribeInsight.

type Recommendation

type Recommendation struct {

	// A description of the problem.
	Description *string

	// A hyperlink to information to help you address the problem.
	Link *string

	// The name of the recommendation.
	Name *string

	// The reason DevOps Guru flagged the anomalous behavior as a problem.
	Reason *string

	// Anomalies that are related to the problem. Use these Anomalies to learn more
	// about what's happening and to help address the issue.
	RelatedAnomalies []RecommendationRelatedAnomaly

	// Events that are related to the problem. Use these events to learn more about
	// what's happening and to help address the issue.
	RelatedEvents []RecommendationRelatedEvent
}

Recommendation information to help you remediate detected anomalous behavior that generated an insight.

type RecommendationRelatedAnomaly

type RecommendationRelatedAnomaly struct {

	// An array of objects that represent resources in which DevOps Guru detected
	// anomalous behavior. Each object contains the name and type of the resource.
	Resources []RecommendationRelatedAnomalyResource

	// Information about where the anomalous behavior related the recommendation was
	// found. For example, details in Amazon CloudWatch metrics.
	SourceDetails []RecommendationRelatedAnomalySourceDetail
}

Information about an anomaly that is related to a recommendation.

type RecommendationRelatedAnomalyResource

type RecommendationRelatedAnomalyResource struct {

	// The name of the resource.
	Name *string

	// The type of the resource.
	Type *string
}

Information about a resource in which DevOps Guru detected anomalous behavior.

type RecommendationRelatedAnomalySourceDetail

type RecommendationRelatedAnomalySourceDetail struct {

	// An array of CloudWatchMetricsDetail objects that contains information about the
	// analyzed metrics that displayed anomalous behavior.
	CloudWatchMetrics []RecommendationRelatedCloudWatchMetricsSourceDetail
}

Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric.

type RecommendationRelatedCloudWatchMetricsSourceDetail

type RecommendationRelatedCloudWatchMetricsSourceDetail struct {

	// The name of the CloudWatch metric.
	MetricName *string

	// The namespace of the CloudWatch metric. A namespace is a container for
	// CloudWatch metrics.
	Namespace *string
}

Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights.

type RecommendationRelatedEvent

type RecommendationRelatedEvent struct {

	// The name of the event. This corresponds to the Name field in an Event object.
	Name *string

	// A ResourceCollection object that contains arrays of the names of AWS
	// CloudFormation stacks.
	Resources []RecommendationRelatedEventResource
}

Information about an event that is related to a recommendation.

type RecommendationRelatedEventResource

type RecommendationRelatedEventResource struct {

	// The name of the resource that emitted the event. This corresponds to the Name
	// field in an EventResource object.
	Name *string

	// The type of the resource that emitted the event. This corresponds to the Type
	// field in an EventResource object.
	Type *string
}

Information about an AWS resource that emitted and event that is related to a recommendation in an insight.

type ResourceCollection

type ResourceCollection struct {

	// An array of the names of AWS CloudFormation stacks. The stacks define AWS
	// resources that DevOps Guru analyzes.
	CloudFormation *CloudFormationCollection
}

A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.

type ResourceCollectionFilter

type ResourceCollectionFilter struct {

	// Information about AWS CloudFormation stacks. You can use stacks to specify which
	// AWS resources in your account to analyze. For more information, see Stacks
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) in
	// the AWS CloudFormation User Guide.
	CloudFormation *CloudFormationCollectionFilter
}

Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.

type ResourceCollectionType

type ResourceCollectionType string
const (
	ResourceCollectionTypeAwsCloudFormation ResourceCollectionType = "AWS_CLOUD_FORMATION"
)

Enum values for ResourceCollectionType

func (ResourceCollectionType) Values

Values returns all known values for ResourceCollectionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ResourceId   *string
	ResourceType *string
}

A requested resource could not be found

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type SearchInsightsFilters

type SearchInsightsFilters struct {

	// A collection of AWS resources supported by DevOps Guru. The one type of AWS
	// resource collection supported is AWS CloudFormation stacks. DevOps Guru can be
	// configured to analyze only the AWS resources that are defined in the stacks.
	ResourceCollection *ResourceCollection

	// An array of severity values used to search for insights.
	Severities []InsightSeverity

	// An array of status values used to search for insights.
	Statuses []InsightStatus
}

Specifies one or more severity values and one or more status values that are used to search for insights.

type ServiceIntegrationConfig

type ServiceIntegrationConfig struct {

	// Information about whether DevOps Guru is configured to create an OpsItem in AWS
	// Systems Manager OpsCenter for each created insight.
	OpsCenter *OpsCenterIntegration
}

Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	Message *string
}

The request contains a value that exceeds a maximum quota.

func (*ServiceQuotaExceededException) Error

func (*ServiceQuotaExceededException) ErrorCode

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SnsChannelConfig

type SnsChannelConfig struct {

	// The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
	TopicArn *string
}

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html). If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics (https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html).

type StartTimeRange

type StartTimeRange struct {

	// The start time of the time range.
	FromTime *time.Time

	// The end time of the time range.
	ToTime *time.Time
}

A time range used to specify when the behavior of an insight or anomaly started.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	QuotaCode         *string
	ServiceCode       *string
	RetryAfterSeconds int32
}

The request was denied due to a request throttling.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type UpdateCloudFormationCollectionFilter

type UpdateCloudFormationCollectionFilter struct {

	// An array of the name of stacks to update.
	StackNames []string
}

Contains the names of AWS CloudFormation stacks used to update a collection of stacks.

type UpdateResourceCollectionAction

type UpdateResourceCollectionAction string
const (
	UpdateResourceCollectionActionAdd    UpdateResourceCollectionAction = "ADD"
	UpdateResourceCollectionActionRemove UpdateResourceCollectionAction = "REMOVE"
)

Enum values for UpdateResourceCollectionAction

func (UpdateResourceCollectionAction) Values

Values returns all known values for UpdateResourceCollectionAction. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UpdateResourceCollectionFilter

type UpdateResourceCollectionFilter struct {

	// An collection of AWS CloudFormation stacks.
	CloudFormation *UpdateCloudFormationCollectionFilter
}

Contains information used to update a collection of AWS resources.

type UpdateServiceIntegrationConfig

type UpdateServiceIntegrationConfig struct {

	// Information about whether DevOps Guru is configured to create an OpsItem in AWS
	// Systems Manager OpsCenter for each created insight.
	OpsCenter *OpsCenterIntegrationConfig
}

Information about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru.

type ValidationException

type ValidationException struct {
	Message *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
}

Contains information about data passed in to a field during a request that is not valid.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField

type ValidationExceptionField struct {

	// The message associated with the validation exception with information to help
	// determine its cause.
	//
	// This member is required.
	Message *string

	// The name of the field.
	//
	// This member is required.
	Name *string
}

The field associated with the validation exception.

type ValidationExceptionReason

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL