Documentation
¶
Index ¶
- type AccessDeniedException
- type BurnRateConfiguration
- type CalendarInterval
- type ConflictException
- type Dimension
- type DurationUnit
- type EvaluationType
- type Goal
- type Interval
- type IntervalMemberCalendarInterval
- type IntervalMemberRollingInterval
- type Metric
- type MetricDataQuery
- type MetricReference
- type MetricStat
- type MonitoredRequestCountMetricDataQueries
- type MonitoredRequestCountMetricDataQueriesMemberBadCountMetric
- type MonitoredRequestCountMetricDataQueriesMemberGoodCountMetric
- type RequestBasedServiceLevelIndicator
- type RequestBasedServiceLevelIndicatorConfig
- type RequestBasedServiceLevelIndicatorMetric
- type RequestBasedServiceLevelIndicatorMetricConfig
- type ResourceNotFoundException
- type RollingInterval
- type Service
- type ServiceDependency
- type ServiceDependent
- type ServiceLevelIndicator
- type ServiceLevelIndicatorComparisonOperator
- type ServiceLevelIndicatorConfig
- type ServiceLevelIndicatorMetric
- type ServiceLevelIndicatorMetricConfig
- type ServiceLevelIndicatorMetricType
- type ServiceLevelObjective
- type ServiceLevelObjectiveBudgetReport
- type ServiceLevelObjectiveBudgetReportError
- type ServiceLevelObjectiveBudgetStatus
- type ServiceLevelObjectiveSummary
- type ServiceOperation
- type ServiceQuotaExceededException
- type ServiceSummary
- type StandardUnit
- type Tag
- type ThrottlingException
- type UnknownUnionMember
- type ValidationException
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
You don't have sufficient permissions to perform this action.
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 BurnRateConfiguration ¶ added in v1.7.0
type BurnRateConfiguration struct { // The number of minutes to use as the look-back window. // // This member is required. LookBackWindowMinutes *int32 // contains filtered or unexported fields }
This object defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.
For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:
burn rate = error rate over the look-back window / (1 - attainment goal percentage)
For more information about burn rates, see Calculate burn rates.
type CalendarInterval ¶
type CalendarInterval struct { // Specifies the duration of each calendar interval. For example, if Duration is 1 // and DurationUnit is MONTH , each interval is one month, aligned with the // calendar. // // This member is required. Duration *int32 // Specifies the calendar interval unit. // // This member is required. DurationUnit DurationUnit // The date and time when you want the first interval to start. Be sure to choose // a time that configures the intervals the way that you want. For example, if you // want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start // time that is a Monday at 6 a.m. // // When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. // For example: 1698778057 // // As soon as one calendar interval ends, another automatically begins. // // This member is required. StartTime *time.Time // contains filtered or unexported fields }
If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This operation attempted to create a resource that already exists.
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 Dimension ¶
type Dimension struct { // The name of the dimension. Dimension names must contain only ASCII characters, // must include at least one non-whitespace character, and cannot start with a // colon ( : ). ASCII control characters are not supported as part of dimension // names. // // This member is required. Name *string // The value of the dimension. Dimension values must contain only ASCII characters // and must include at least one non-whitespace character. ASCII control characters // are not supported as part of dimension values. // // This member is required. Value *string // contains filtered or unexported fields }
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
type DurationUnit ¶
type DurationUnit string
const ( DurationUnitMinute DurationUnit = "MINUTE" DurationUnitHour DurationUnit = "HOUR" DurationUnitDay DurationUnit = "DAY" DurationUnitMonth DurationUnit = "MONTH" )
Enum values for DurationUnit
func (DurationUnit) Values ¶
func (DurationUnit) Values() []DurationUnit
Values returns all known values for DurationUnit. 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 EvaluationType ¶ added in v1.4.0
type EvaluationType string
const ( EvaluationTypePeriodBased EvaluationType = "PeriodBased" EvaluationTypeRequestBased EvaluationType = "RequestBased" )
Enum values for EvaluationType
func (EvaluationType) Values ¶ added in v1.4.0
func (EvaluationType) Values() []EvaluationType
Values returns all known values for EvaluationType. 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 Goal ¶
type Goal struct { // The threshold that determines if the goal is being met. // // If this is a period-based SLO, the attainment goal is the percentage of good // periods that meet the threshold requirements to the total periods within the // interval. For example, an attainment goal of 99.9% means that within your // interval, you are targeting 99.9% of the periods to be in healthy state. // // If this is a request-based SLO, the attainment goal is the percentage of // requests that must be successful to meet the attainment goal. // // If you omit this parameter, 99 is used to represent 99% as the attainment goal. AttainmentGoal *float64 // The time period used to evaluate the SLO. It can be either a calendar interval // or rolling interval. // // If you omit this parameter, a rolling interval of 7 days is used. Interval Interval // The percentage of remaining budget over total budget that you want to get // warnings for. If you omit this parameter, the default of 50.0 is used. WarningThreshold *float64 // contains filtered or unexported fields }
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
type Interval ¶
type Interval interface {
// contains filtered or unexported methods
}
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
The following types satisfy this interface:
IntervalMemberCalendarInterval IntervalMemberRollingInterval
Example (OutputUsage) ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/applicationsignals/types" ) func main() { var union types.Interval // type switches can be used to check the union value switch v := union.(type) { case *types.IntervalMemberCalendarInterval: _ = v.Value // Value is types.CalendarInterval case *types.IntervalMemberRollingInterval: _ = v.Value // Value is types.RollingInterval case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type IntervalMemberCalendarInterval ¶
type IntervalMemberCalendarInterval struct { Value CalendarInterval // contains filtered or unexported fields }
If the interval is a calendar interval, this structure contains the interval specifications.
type IntervalMemberRollingInterval ¶
type IntervalMemberRollingInterval struct { Value RollingInterval // contains filtered or unexported fields }
If the interval is a rolling interval, this structure contains the interval specifications.
type Metric ¶
type Metric struct { // An array of one or more dimensions to use to define the metric that you want to // use. For more information, see [Dimensions]. // // [Dimensions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension Dimensions []Dimension // The name of the metric to use. MetricName *string // The namespace of the metric. For more information, see [Namespaces]. // // [Namespaces]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace Namespace *string // contains filtered or unexported fields }
This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions
type MetricDataQuery ¶
type MetricDataQuery struct { // A short name used to tie this object to the results in the response. This Id // must be unique within a MetricDataQueries array. If you are performing math // expressions on this set of data, this name represents that data and can serve as // a variable in the metric math expression. The valid characters are letters, // numbers, and underscore. The first character must be a lowercase letter. // // This member is required. Id *string // The ID of the account where this metric is located. If you are performing this // operation in a monitoring account, use this to specify which source account to // retrieve this metric from. AccountId *string // This field can contain a metric math expression to be performed on the other // metrics that you are retrieving within this MetricDataQueries structure. // // A math expression can use the Id of the other metrics or queries to refer to // those metrics, and can also use the Id of other expressions to use the result // of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions] // in the Amazon CloudWatch User Guide. // // Within each MetricDataQuery object, you must specify either Expression or // MetricStat but not both. // // [Metric Math Syntax and Functions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax Expression *string // A human-readable label for this metric or expression. This is especially useful // if this is an expression, so that you know what the value represents. If the // metric or expression is shown in a CloudWatch dashboard widget, the label is // shown. If Label is omitted, CloudWatch generates a default. // // You can put dynamic expressions into a label, so that it is more descriptive. // For more information, see [Using Dynamic Labels]. // // [Using Dynamic Labels]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html Label *string // A metric to be used directly for the SLO, or to be used in the math expression // that will be used for the SLO. // // Within one MetricDataQuery object, you must specify either Expression or // MetricStat but not both. MetricStat *MetricStat // The granularity, in seconds, of the returned data points for this metric. For // metrics with regular resolution, a period can be as short as one minute (60 // seconds) and must be a multiple of 60. For high-resolution metrics that are // collected at intervals of less than one minute, the period can be 1, 5, 10, 30, // 60, or any multiple of 60. High-resolution metrics are those metrics stored by a // PutMetricData call that includes a StorageResolution of 1 second. // // If the StartTime parameter specifies a time stamp that is greater than 3 hours // ago, you must specify the period as follows or no data points in that time range // is returned: // // - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds // (1 minute). // // - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 // minutes). // // - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 // hour). Period *int32 // Use this only if you are using a metric math expression for the SLO. Specify // true for ReturnData for only the one expression result to use as the alarm. For // all other metrics and expressions in the same CreateServiceLevelObjective // operation, specify ReturnData as false . ReturnData *bool // contains filtered or unexported fields }
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery in the MetricDataQueries array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries array can include as many as 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, exactly one must have true as the value for ReturnData . The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
type MetricReference ¶
type MetricReference struct { // The name of the metric. // // This member is required. MetricName *string // Used to display the appropriate statistics in the CloudWatch console. // // This member is required. MetricType *string // The namespace of the metric. For more information, see [CloudWatchNamespaces]. // // [CloudWatchNamespaces]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace // // This member is required. Namespace *string // An array of one or more dimensions that further define the metric. For more // information, see [CloudWatchDimensions]. // // [CloudWatchDimensions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension Dimensions []Dimension // contains filtered or unexported fields }
This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.
type MetricStat ¶
type MetricStat struct { // The metric to use as the service level indicator, including the metric name, // namespace, and dimensions. // // This member is required. Metric *Metric // The granularity, in seconds, to be used for the metric. For metrics with // regular resolution, a period can be as short as one minute (60 seconds) and must // be a multiple of 60. For high-resolution metrics that are collected at intervals // of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of // 60. High-resolution metrics are those metrics stored by a PutMetricData call // that includes a StorageResolution of 1 second. // // This member is required. Period *int32 // The statistic to use for comparison to the threshold. It can be any CloudWatch // statistic or extended statistic. For more information about statistics, see [CloudWatch statistics definitions]. // // [CloudWatch statistics definitions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html // // This member is required. Stat *string // If you omit Unit then all data that was collected with any unit is returned, // along with the corresponding units that were specified when the data was // reported to CloudWatch. If you specify a unit, the operation returns only data // that was collected with that unit specified. If you specify a unit that does not // match the data collected, the results of the operation are null. CloudWatch does // not perform unit conversions. Unit StandardUnit // contains filtered or unexported fields }
This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.
type MonitoredRequestCountMetricDataQueries ¶ added in v1.4.0
type MonitoredRequestCountMetricDataQueries interface {
// contains filtered or unexported methods
}
This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
The following types satisfy this interface:
MonitoredRequestCountMetricDataQueriesMemberBadCountMetric MonitoredRequestCountMetricDataQueriesMemberGoodCountMetric
Example (OutputUsage) ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go-v2/service/applicationsignals/types" ) func main() { var union types.MonitoredRequestCountMetricDataQueries // type switches can be used to check the union value switch v := union.(type) { case *types.MonitoredRequestCountMetricDataQueriesMemberBadCountMetric: _ = v.Value // Value is []types.MetricDataQuery case *types.MonitoredRequestCountMetricDataQueriesMemberGoodCountMetric: _ = v.Value // Value is []types.MetricDataQuery case *types.UnknownUnionMember: fmt.Println("unknown tag:", v.Tag) default: fmt.Println("union is nil or unknown type") } }
Output:
type MonitoredRequestCountMetricDataQueriesMemberBadCountMetric ¶ added in v1.4.0
type MonitoredRequestCountMetricDataQueriesMemberBadCountMetric struct { Value []MetricDataQuery // contains filtered or unexported fields }
If you want to count "bad requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "bad requests" in this structure.
type MonitoredRequestCountMetricDataQueriesMemberGoodCountMetric ¶ added in v1.4.0
type MonitoredRequestCountMetricDataQueriesMemberGoodCountMetric struct { Value []MetricDataQuery // contains filtered or unexported fields }
If you want to count "good requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "good requests" in this structure.
type RequestBasedServiceLevelIndicator ¶ added in v1.4.0
type RequestBasedServiceLevelIndicator struct { // A structure that contains information about the metric that the SLO monitors. // // This member is required. RequestBasedSliMetric *RequestBasedServiceLevelIndicatorMetric // The arithmetic operation used when comparing the specified metric to the // threshold. ComparisonOperator ServiceLevelIndicatorComparisonOperator // This value is the threshold that the observed metric values of the SLI metric // are compared to. MetricThreshold *float64 // contains filtered or unexported fields }
This structure contains information about the performance metric that a request-based SLO monitors.
type RequestBasedServiceLevelIndicatorConfig ¶ added in v1.4.0
type RequestBasedServiceLevelIndicatorConfig struct { // Use this structure to specify the metric to be used for the SLO. // // This member is required. RequestBasedSliMetricConfig *RequestBasedServiceLevelIndicatorMetricConfig // The arithmetic operation to use when comparing the specified metric to the // threshold. This parameter is required if this SLO is tracking the Latency // metric. ComparisonOperator ServiceLevelIndicatorComparisonOperator // The value that the SLI metric is compared to. This parameter is required if // this SLO is tracking the Latency metric. MetricThreshold *float64 // contains filtered or unexported fields }
This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor.
type RequestBasedServiceLevelIndicatorMetric ¶ added in v1.4.0
type RequestBasedServiceLevelIndicatorMetric struct { // This structure defines the metric that is used as the "good request" or "bad // request" value for a request-based SLO. This value observed for the metric // defined in TotalRequestCountMetric is divided by the number found for // MonitoredRequestCountMetric to determine the percentage of successful requests // that this SLO tracks. // // This member is required. MonitoredRequestCountMetric MonitoredRequestCountMetricDataQueries // This structure defines the metric that is used as the "total requests" number // for a request-based SLO. The number observed for this metric is divided by the // number of "good requests" or "bad requests" that is observed for the metric // defined in MonitoredRequestCountMetric . // // This member is required. TotalRequestCountMetric []MetricDataQuery // This is a string-to-string map that contains information about the type of // object that this SLO is related to. It can include the following fields. // // - Type designates the type of object that this SLO is related to. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. KeyAttributes map[string]string // If the SLO monitors either the LATENCY or AVAILABILITY metric that Application // Signals collects, this field displays which of those metrics is used. MetricType ServiceLevelIndicatorMetricType // If the SLO monitors a specific operation of the service, this field displays // that operation name. OperationName *string // contains filtered or unexported fields }
This structure contains the information about the metric that is used for a request-based SLO.
type RequestBasedServiceLevelIndicatorMetricConfig ¶ added in v1.4.0
type RequestBasedServiceLevelIndicatorMetricConfig struct { // If this SLO is related to a metric collected by Application Signals, you must // use this field to specify which service the SLO metric is related to. To do so, // you must specify at least the Type , Name , and Environment attributes. // // This is a string-to-string map. It can include the following fields. // // - Type designates the type of object this is. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. KeyAttributes map[string]string // If the SLO is to monitor either the LATENCY or AVAILABILITY metric that // Application Signals collects, use this field to specify which of those metrics // is used. MetricType ServiceLevelIndicatorMetricType // Use this structure to define the metric that you want to use as the "good // request" or "bad request" value for a request-based SLO. This value observed for // the metric defined in TotalRequestCountMetric will be divided by the number // found for MonitoredRequestCountMetric to determine the percentage of successful // requests that this SLO tracks. MonitoredRequestCountMetric MonitoredRequestCountMetricDataQueries // If the SLO is to monitor a specific operation of the service, use this field to // specify the name of that operation. OperationName *string // Use this structure to define the metric that you want to use as the "total // requests" number for a request-based SLO. This result will be divided by the // "good request" or "bad request" value defined in MonitoredRequestCountMetric . TotalRequestCountMetric []MetricDataQuery // contains filtered or unexported fields }
Use this structure to specify the information for the metric that a period-based SLO will monitor.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string ResourceType *string ResourceId *string // contains filtered or unexported fields }
Resource not found.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type RollingInterval ¶
type RollingInterval struct { // Specifies the duration of each rolling interval. For example, if Duration is 7 // and DurationUnit is DAY , each rolling interval is seven days. // // This member is required. Duration *int32 // Specifies the rolling interval unit. // // This member is required. DurationUnit DurationUnit // contains filtered or unexported fields }
If the interval for this SLO is a rolling interval, this structure contains the interval specifications.
type Service ¶
type Service struct { // This is a string-to-string map. It can include the following fields. // // - Type designates the type of object this is. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. // // This member is required. KeyAttributes map[string]string // An array of structures that each contain information about one metric // associated with this service. // // This member is required. MetricReferences []MetricReference // This structure contains one or more string-to-string maps that help identify // this service. It can include platform attributes, application attributes, and // telemetry attributes. // // Platform attributes contain information the service's platform. // // - PlatformType defines the hosted-in platform. // // - EKS.Cluster is the name of the Amazon EKS cluster. // // - K8s.Cluster is the name of the self-hosted Kubernetes cluster. // // - K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS // or Kubernetes clusters. // // - K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or // Kubernetes clusters. // // - K8s.Node is the name of the Kubernetes node in either Amazon EKS or // Kubernetes clusters. // // - K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes // clusters. // // - EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group. // // - EC2.InstanceId is the ID of the Amazon EC2 instance. // // - Host is the name of the host, for all platform types. // // Application attributes contain information about the application. // // - AWS.Application is the application's name in Amazon Web Services Service // Catalog AppRegistry. // // - AWS.Application.ARN is the application's ARN in Amazon Web Services Service // Catalog AppRegistry. // // Telemetry attributes contain telemetry information. // // - Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for // instrumented services. // // - Telemetry.Agent is the fingerprint of the agent used to collect and send // telemetry data. // // - Telemetry.Source Specifies the point of application where the telemetry was // collected or specifies what was used for the source of telemetry data. AttributeMaps []map[string]string // An array of string-to-string maps that each contain information about one log // group associated with this service. Each string-to-string map includes the // following fields: // // - "Type": "AWS::Resource" // // - "ResourceType": "AWS::Logs::LogGroup" // // - "Identifier": "name-of-log-group" LogGroupReferences []map[string]string // contains filtered or unexported fields }
This structure contains information about one of your services that was discovered by Application Signals.
type ServiceDependency ¶
type ServiceDependency struct { // This is a string-to-string map. It can include the following fields. // // - Type designates the type of object this is. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. // // This member is required. DependencyKeyAttributes map[string]string // The name of the called operation in the dependency. // // This member is required. DependencyOperationName *string // An array of structures that each contain information about one metric // associated with this service dependency that was discovered by Application // Signals. // // This member is required. MetricReferences []MetricReference // The name of the operation in this service that calls the dependency. // // This member is required. OperationName *string // contains filtered or unexported fields }
This structure contains information about one dependency of this service.
type ServiceDependent ¶
type ServiceDependent struct { // This is a string-to-string map. It can include the following fields. // // - Type designates the type of object this is. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. // // This member is required. DependentKeyAttributes map[string]string // An array of structures that each contain information about one metric // associated with this service dependent that was discovered by Application // Signals. // // This member is required. MetricReferences []MetricReference // If the dependent invoker was a service that invoked it from an operation, the // name of that dependent operation is displayed here. DependentOperationName *string // If the invoked entity is an operation on an entity, the name of that dependent // operation is displayed here. OperationName *string // contains filtered or unexported fields }
This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
type ServiceLevelIndicator ¶
type ServiceLevelIndicator struct { // The arithmetic operation used when comparing the specified metric to the // threshold. // // This member is required. ComparisonOperator ServiceLevelIndicatorComparisonOperator // The value that the SLI metric is compared to. // // This member is required. MetricThreshold *float64 // A structure that contains information about the metric that the SLO monitors. // // This member is required. SliMetric *ServiceLevelIndicatorMetric // contains filtered or unexported fields }
This structure contains information about the performance metric that a period-based SLO monitors.
type ServiceLevelIndicatorComparisonOperator ¶
type ServiceLevelIndicatorComparisonOperator string
const ( ServiceLevelIndicatorComparisonOperatorGreaterThanOrEqualTo ServiceLevelIndicatorComparisonOperator = "GreaterThanOrEqualTo" ServiceLevelIndicatorComparisonOperatorGreaterThan ServiceLevelIndicatorComparisonOperator = "GreaterThan" ServiceLevelIndicatorComparisonOperatorLessThan ServiceLevelIndicatorComparisonOperator = "LessThan" ServiceLevelIndicatorComparisonOperatorLessThanOrEqualTo ServiceLevelIndicatorComparisonOperator = "LessThanOrEqualTo" )
Enum values for ServiceLevelIndicatorComparisonOperator
type ServiceLevelIndicatorConfig ¶
type ServiceLevelIndicatorConfig struct { // The arithmetic operation to use when comparing the specified metric to the // threshold. // // This member is required. ComparisonOperator ServiceLevelIndicatorComparisonOperator // This parameter is used only when a request-based SLO tracks the Latency metric. // Specify the threshold value that the observed Latency metric values are to be // compared to. // // This member is required. MetricThreshold *float64 // Use this structure to specify the metric to be used for the SLO. // // This member is required. SliMetricConfig *ServiceLevelIndicatorMetricConfig // contains filtered or unexported fields }
This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor.
type ServiceLevelIndicatorMetric ¶
type ServiceLevelIndicatorMetric struct { // If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric // math expression, this structure includes the information about that metric or // expression. // // This member is required. MetricDataQueries []MetricDataQuery // This is a string-to-string map that contains information about the type of // object that this SLO is related to. It can include the following fields. // // - Type designates the type of object that this SLO is related to. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. KeyAttributes map[string]string // If the SLO monitors either the LATENCY or AVAILABILITY metric that Application // Signals collects, this field displays which of those metrics is used. MetricType ServiceLevelIndicatorMetricType // If the SLO monitors a specific operation of the service, this field displays // that operation name. OperationName *string // contains filtered or unexported fields }
This structure contains the information about the metric that is used for a period-based SLO.
type ServiceLevelIndicatorMetricConfig ¶
type ServiceLevelIndicatorMetricConfig struct { // If this SLO is related to a metric collected by Application Signals, you must // use this field to specify which service the SLO metric is related to. To do so, // you must specify at least the Type , Name , and Environment attributes. // // This is a string-to-string map. It can include the following fields. // // - Type designates the type of object this is. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. KeyAttributes map[string]string // If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric // math expression, use this structure to specify that metric or expression. MetricDataQueries []MetricDataQuery // If the SLO is to monitor either the LATENCY or AVAILABILITY metric that // Application Signals collects, use this field to specify which of those metrics // is used. MetricType ServiceLevelIndicatorMetricType // If the SLO is to monitor a specific operation of the service, use this field to // specify the name of that operation. OperationName *string // The number of seconds to use as the period for SLO evaluation. Your // application's performance is compared to the SLI during each period. For each // period, the application is determined to have either achieved or not achieved // the necessary performance. PeriodSeconds *int32 // The statistic to use for comparison to the threshold. It can be any CloudWatch // statistic or extended statistic. For more information about statistics, see [CloudWatch statistics definitions]. // // [CloudWatch statistics definitions]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html Statistic *string // contains filtered or unexported fields }
Use this structure to specify the information for the metric that a period-based SLO will monitor.
type ServiceLevelIndicatorMetricType ¶
type ServiceLevelIndicatorMetricType string
const ( ServiceLevelIndicatorMetricTypeLatency ServiceLevelIndicatorMetricType = "LATENCY" ServiceLevelIndicatorMetricTypeAvailability ServiceLevelIndicatorMetricType = "AVAILABILITY" )
Enum values for ServiceLevelIndicatorMetricType
func (ServiceLevelIndicatorMetricType) Values ¶
func (ServiceLevelIndicatorMetricType) Values() []ServiceLevelIndicatorMetricType
Values returns all known values for ServiceLevelIndicatorMetricType. 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 ServiceLevelObjective ¶
type ServiceLevelObjective struct { // The ARN of this SLO. // // This member is required. Arn *string // The date and time that this SLO was created. When used in a raw HTTP Query API, // it is formatted as yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 . // // This member is required. CreatedTime *time.Time // This structure contains the attributes that determine the goal of an SLO. This // includes the time period for evaluation and the attainment threshold. // // This member is required. Goal *Goal // The time that this SLO was most recently updated. When used in a raw HTTP Query // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59 // . // // This member is required. LastUpdatedTime *time.Time // The name of this SLO. // // This member is required. Name *string // Each object in this array defines the length of the look-back window used to // calculate one burn rate metric for this SLO. The burn rate measures how fast the // service is consuming the error budget, relative to the attainment goal of the // SLO. BurnRateConfigurations []BurnRateConfiguration // The description that you created for this SLO. Description *string // Displays whether this is a period-based SLO or a request-based SLO. EvaluationType EvaluationType // A structure containing information about the performance metric that this SLO // monitors, if this is a request-based SLO. RequestBasedSli *RequestBasedServiceLevelIndicator // A structure containing information about the performance metric that this SLO // monitors, if this is a period-based SLO. Sli *ServiceLevelIndicator // contains filtered or unexported fields }
A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.
type ServiceLevelObjectiveBudgetReport ¶
type ServiceLevelObjectiveBudgetReport struct { // The ARN of the SLO that this report is for. // // This member is required. Arn *string // The status of this SLO, as it relates to the error budget for the entire time // interval. // // - OK means that the SLO had remaining budget above the warning threshold, as // of the time that you specified in TimeStamp . // // - WARNING means that the SLO's remaining budget was below the warning // threshold, as of the time that you specified in TimeStamp . // // - BREACHED means that the SLO's budget was exhausted, as of the time that you // specified in TimeStamp . // // - INSUFFICIENT_DATA means that the specified start and end times were before // the SLO was created, or that attainment data is missing. // // This member is required. BudgetStatus ServiceLevelObjectiveBudgetStatus // The name of the SLO that this report is for. // // This member is required. Name *string // A number between 0 and 100 that represents the success percentage of your // application compared to the goal set by the SLO. // // If this is a period-based SLO, the number is the percentage of time periods // that the service has attained the SLO's attainment goal, as of the time of the // request. // // If this is a request-based SLO, the number is the number of successful requests // divided by the number of total requests, multiplied by 100, during the time // range that you specified in your request. Attainment *float64 // This field is displayed only for request-based SLOs. It displays the number of // failed requests that can be tolerated before any more successful requests occur, // and still have the application meet its SLO goal. // // This number can go up and down between different reports, based on both how // many successful requests and how many failed requests occur in that time. BudgetRequestsRemaining *int32 // The budget amount remaining before the SLO status becomes BREACHING , at the // time specified in the Timestemp parameter of the request. If this value is // negative, then the SLO is already in BREACHING status. // // This field is included only if the SLO is a period-based SLO. BudgetSecondsRemaining *int32 // Displays whether this budget report is for a period-based SLO or a // request-based SLO. EvaluationType EvaluationType // This structure contains the attributes that determine the goal of an SLO. This // includes the time period for evaluation and the attainment threshold. Goal *Goal // This structure contains information about the performance metric that a // request-based SLO monitors. RequestBasedSli *RequestBasedServiceLevelIndicator // A structure that contains information about the performance metric that this // SLO monitors. Sli *ServiceLevelIndicator // This field is displayed only for request-based SLOs. It displays the total // number of failed requests that can be tolerated during the time range between // the start of the interval and the time stamp supplied in the budget report // request. It is based on the total number of requests that occurred, and the // percentage specified in the attainment goal. If the number of failed requests // matches this number or is higher, then this SLO is currently breaching. // // This number can go up and down between reports with different time stamps, // based on both how many total requests occur. TotalBudgetRequests *int32 // The total number of seconds in the error budget for the interval. This field is // included only if the SLO is a period-based SLO. TotalBudgetSeconds *int32 // contains filtered or unexported fields }
A structure containing an SLO budget report that you have requested.
type ServiceLevelObjectiveBudgetReportError ¶
type ServiceLevelObjectiveBudgetReportError struct { // The ARN of the SLO that this error is related to. // // This member is required. Arn *string // The error code for this error. // // This member is required. ErrorCode *string // The message for this error. // // This member is required. ErrorMessage *string // The name of the SLO that this error is related to. // // This member is required. Name *string // contains filtered or unexported fields }
A structure containing information about one error that occurred during a BatchGetServiceLevelObjectiveBudgetReport operation.
type ServiceLevelObjectiveBudgetStatus ¶
type ServiceLevelObjectiveBudgetStatus string
const ( ServiceLevelObjectiveBudgetStatusOk ServiceLevelObjectiveBudgetStatus = "OK" ServiceLevelObjectiveBudgetStatusWarning ServiceLevelObjectiveBudgetStatus = "WARNING" ServiceLevelObjectiveBudgetStatusBreached ServiceLevelObjectiveBudgetStatus = "BREACHED" ServiceLevelObjectiveBudgetStatusInsufficientData ServiceLevelObjectiveBudgetStatus = "INSUFFICIENT_DATA" )
Enum values for ServiceLevelObjectiveBudgetStatus
func (ServiceLevelObjectiveBudgetStatus) Values ¶
func (ServiceLevelObjectiveBudgetStatus) Values() []ServiceLevelObjectiveBudgetStatus
Values returns all known values for ServiceLevelObjectiveBudgetStatus. 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 ServiceLevelObjectiveSummary ¶
type ServiceLevelObjectiveSummary struct { // The ARN of this service level objective. // // This member is required. Arn *string // The name of the service level objective. // // This member is required. Name *string // The date and time that this service level objective was created. It is // expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. CreatedTime *time.Time // This is a string-to-string map. It can include the following fields. // // - Type designates the type of object this service level objective is for. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. KeyAttributes map[string]string // If this service level objective is specific to a single operation, this field // displays the name of that operation. OperationName *string // contains filtered or unexported fields }
A structure that contains information about one service level objective (SLO) created in Application Signals.
type ServiceOperation ¶
type ServiceOperation struct { // An array of structures that each contain information about one metric // associated with this service operation that was discovered by Application // Signals. // // This member is required. MetricReferences []MetricReference // The name of the operation, discovered by Application Signals. // // This member is required. Name *string // contains filtered or unexported fields }
This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent.
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
This request exceeds a service quota.
func (*ServiceQuotaExceededException) Error ¶
func (e *ServiceQuotaExceededException) Error() string
func (*ServiceQuotaExceededException) ErrorCode ¶
func (e *ServiceQuotaExceededException) ErrorCode() string
func (*ServiceQuotaExceededException) ErrorFault ¶
func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault
func (*ServiceQuotaExceededException) ErrorMessage ¶
func (e *ServiceQuotaExceededException) ErrorMessage() string
type ServiceSummary ¶
type ServiceSummary struct { // This is a string-to-string map that help identify the objects discovered by // Application Signals. It can include the following fields. // // - Type designates the type of object this is. // // - ResourceType specifies the type of the resource. This field is used only // when the value of the Type field is Resource or AWS::Resource . // // - Name specifies the name of the object. This is used only if the value of the // Type field is Service , RemoteService , or AWS::Service . // // - Identifier identifies the resource objects of this resource. This is used // only if the value of the Type field is Resource or AWS::Resource . // // - Environment specifies the location where this object is hosted, or what it // belongs to. // // This member is required. KeyAttributes map[string]string // An array of structures that each contain information about one metric // associated with this service. // // This member is required. MetricReferences []MetricReference // This structure contains one or more string-to-string maps that help identify // this service. It can include platform attributes, application attributes, and // telemetry attributes. // // Platform attributes contain information the service's platform. // // - PlatformType defines the hosted-in platform. // // - EKS.Cluster is the name of the Amazon EKS cluster. // // - K8s.Cluster is the name of the self-hosted Kubernetes cluster. // // - K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS // or Kubernetes clusters. // // - K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or // Kubernetes clusters. // // - K8s.Node is the name of the Kubernetes node in either Amazon EKS or // Kubernetes clusters. // // - K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes // clusters. // // - EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group. // // - EC2.InstanceId is the ID of the Amazon EC2 instance. // // - Host is the name of the host, for all platform types. // // Application attributes contain information about the application. // // - AWS.Application is the application's name in Amazon Web Services Service // Catalog AppRegistry. // // - AWS.Application.ARN is the application's ARN in Amazon Web Services Service // Catalog AppRegistry. // // Telemetry attributes contain telemetry information. // // - Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for // instrumented services. // // - Telemetry.Agent is the fingerprint of the agent used to collect and send // telemetry data. // // - Telemetry.Source Specifies the point of application where the telemetry was // collected or specifies what was used for the source of telemetry data. AttributeMaps []map[string]string // contains filtered or unexported fields }
This structure contains information about one of your services that was discovered by Application Signals
type StandardUnit ¶
type StandardUnit string
const ( StandardUnitMicroseconds StandardUnit = "Microseconds" StandardUnitMilliseconds StandardUnit = "Milliseconds" StandardUnitSeconds StandardUnit = "Seconds" StandardUnitBytes StandardUnit = "Bytes" StandardUnitKilobytes StandardUnit = "Kilobytes" StandardUnitMegabytes StandardUnit = "Megabytes" StandardUnitGigabytes StandardUnit = "Gigabytes" StandardUnitTerabytes StandardUnit = "Terabytes" StandardUnitBits StandardUnit = "Bits" StandardUnitKilobits StandardUnit = "Kilobits" StandardUnitMegabits StandardUnit = "Megabits" StandardUnitGigabits StandardUnit = "Gigabits" StandardUnitTerabits StandardUnit = "Terabits" StandardUnitPercent StandardUnit = "Percent" StandardUnitCount StandardUnit = "Count" StandardUnitBytesSecond StandardUnit = "Bytes/Second" StandardUnitKilobytesSecond StandardUnit = "Kilobytes/Second" StandardUnitMegabytesSecond StandardUnit = "Megabytes/Second" StandardUnitGigabytesSecond StandardUnit = "Gigabytes/Second" StandardUnitTerabytesSecond StandardUnit = "Terabytes/Second" StandardUnitBitsSecond StandardUnit = "Bits/Second" StandardUnitKilobitsSecond StandardUnit = "Kilobits/Second" StandardUnitMegabitsSecond StandardUnit = "Megabits/Second" StandardUnitGigabitsSecond StandardUnit = "Gigabits/Second" StandardUnitTerabitsSecond StandardUnit = "Terabits/Second" StandardUnitCountSecond StandardUnit = "Count/Second" StandardUnitNone StandardUnit = "None" )
Enum values for StandardUnit
func (StandardUnit) Values ¶
func (StandardUnit) Values() []StandardUnit
Values returns all known values for StandardUnit. 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 Tag ¶
type Tag struct { // A string that you can use to assign a value. The combination of tag keys and // values can help you organize and categorize your resources. // // This member is required. Key *string // The value for the specified tag key. // // This member is required. Value *string // contains filtered or unexported fields }
A key-value pair associated with a resource. Tags can help you organize and categorize your resources.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was throttled because of quota limits.
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 UnknownUnionMember ¶
type UnknownUnionMember struct { Tag string Value []byte // contains filtered or unexported fields }
UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The resource 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