Class: Aws::ApplicationSignals::Types::ServiceLevelObjectiveBudgetReport

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationSignals::Types::ServiceLevelObjectiveBudgetReport

Defined in:

gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb

Overview

A structure containing an SLO budget report that you have requested.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The ARN of the SLO that this report is for.

• #attainment ⇒ Float

  A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.

• #budget_requests_remaining ⇒ Integer

  This field is displayed only for request-based SLOs.

• #budget_seconds_remaining ⇒ Integer

  The budget amount remaining before the SLO status becomes BREACHING, at the time specified in the Timestemp parameter of the request.

• #budget_status ⇒ String

  The status of this SLO, as it relates to the error budget for the entire time interval.

• #evaluation_type ⇒ String

  Displays whether this budget report is for a period-based SLO or a request-based SLO.

• #goal ⇒ Types::Goal

  This structure contains the attributes that determine the goal of an SLO.

• #name ⇒ String

  The name of the SLO that this report is for.

• #request_based_sli ⇒ Types::RequestBasedServiceLevelIndicator

  This structure contains information about the performance metric that a request-based SLO monitors.

• #sli ⇒ Types::ServiceLevelIndicator

  A structure that contains information about the performance metric that this SLO monitors.

• #total_budget_requests ⇒ Integer

  This field is displayed only for request-based SLOs.

• #total_budget_seconds ⇒ Integer

  The total number of seconds in the error budget for the interval.

Instance Attribute Details

#arn ⇒ String

The ARN of the SLO that this report is for.

Returns:

• (String)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#attainment ⇒ Float

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.

Returns:

• (Float)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#budget_requests_remaining ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#budget_seconds_remaining ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#budget_status ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_type ⇒ String

Displays whether this budget report is for a period-based SLO or a request-based SLO.

Returns:

• (String)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#goal ⇒ Types::Goal

This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.

Returns:

• (Types::Goal)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the SLO that this report is for.

Returns:

• (String)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#request_based_sli ⇒ Types::RequestBasedServiceLevelIndicator

This structure contains information about the performance metric that a request-based SLO monitors.

Returns:

• (Types::RequestBasedServiceLevelIndicator)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#sli ⇒ Types::ServiceLevelIndicator

A structure that contains information about the performance metric that this SLO monitors.

Returns:

• (Types::ServiceLevelIndicator)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#total_budget_requests ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end

#total_budget_seconds ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-applicationsignals/lib/aws-sdk-applicationsignals/types.rb', line 3090

class ServiceLevelObjectiveBudgetReport < Struct.new(
  :arn,
  :name,
  :evaluation_type,
  :budget_status,
  :attainment,
  :total_budget_seconds,
  :budget_seconds_remaining,
  :total_budget_requests,
  :budget_requests_remaining,
  :sli,
  :request_based_sli,
  :goal)
  SENSITIVE = []
  include Aws::Structure
end