_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
slo
A structure containing the information about the SLO. | STRUCT(
"arn" VARCHAR,
"name" VARCHAR,
"description" VARCHAR,
"created_time" TIMESTAMP_S,
"last_updated_time" TIMESTAMP_S,
"sli" STRUCT(
"sli_metric" STRUCT(
"key_attributes" MAP(VARCHAR, VARCHAR),
"operation_name" VARCHAR,
"metric_type" VARCHAR,
"metric_data_queries" STRUCT(
"id" VARCHAR,
"metric_stat" STRUCT(
"metric" STRUCT(
"namespace" VARCHAR,
"metric_name" VARCHAR,
"dimensions" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[]
),
"period" BIGINT,
"stat" VARCHAR,
"unit" VARCHAR
),
"expression" VARCHAR,
"label" VARCHAR,
"return_data" BOOLEAN,
"period" BIGINT,
"account_id" VARCHAR
)[]
),
"metric_threshold" DOUBLE,
"comparison_operator" VARCHAR
),
"goal" STRUCT(
"interval" STRUCT(
"rolling_interval" STRUCT(
"duration_unit" VARCHAR,
"duration" BIGINT
),
"calendar_interval" STRUCT(
"start_time" TIMESTAMP_S,
"duration_unit" VARCHAR,
"duration" BIGINT
)
),
"attainment_goal" DOUBLE,
"warning_threshold" DOUBLE
)
) |
Show child fields- slo.arn
The ARN of this SLO. - slo.created_time
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. - slo.description
The description that you created for this SLO. - slo.goal
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold. Show child fields- slo.goal.attainment_goal
The threshold that determines if the goal is being met. An attainment goal is the ratio 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 you omit this parameter, 99 is used to represent 99% as the attainment goal. - slo.goal.interval
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. Show child fields- slo.goal.interval.calendar_interval
If the interval is a calendar interval, this structure contains the interval specifications. Show child fields- slo.goal.interval.calendar_interval.duration
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. - slo.goal.interval.calendar_interval.duration_unit
Specifies the calendar interval unit. - slo.goal.interval.calendar_interval.start_time
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.
- slo.goal.interval.rolling_interval
If the interval is a rolling interval, this structure contains the interval specifications. Show child fields- slo.goal.interval.rolling_interval.duration
Specifies the duration of each rolling interval. For example, if Duration is 7 and DurationUnit is DAY, each rolling interval is seven days. - slo.goal.interval.rolling_interval.duration_unit
Specifies the rolling interval unit.
- slo.goal.warning_threshold
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.
- slo.last_updated_time
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. - slo.name
The name of this SLO. - slo.sli
A structure containing information about the performance metric that this SLO monitors. Show child fields- slo.sli.comparison_operator
The arithmetic operation used when comparing the specified metric to the threshold. - slo.sli.metric_threshold
The value that the SLI metric is compared to. - slo.sli.sli_metric
A structure that contains information about the metric that the SLO monitors. Show child fields- slo.sli.sli_metric.key_attributes
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. - slo.sli.sli_metric.metric_data_queries[]
Show child fields- slo.sli.sli_metric.metric_data_queries[].account_id
The ID of the account where this metric is located. If you are performing this operatiion in a monitoring account, use this to specify which source account to retrieve this metric from. - slo.sli.sli_metric.metric_data_queries[].expression
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. - slo.sli.sli_metric.metric_data_queries[].id
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. - slo.sli.sli_metric.metric_data_queries[].label
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. - slo.sli.sli_metric.metric_data_queries[].metric_stat
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. Show child fields- slo.sli.sli_metric.metric_data_queries[].metric_stat.metric
The metric to use as the service level indicator, including the metric name, namespace, and dimensions. Show child fields- slo.sli.sli_metric.metric_data_queries[].metric_stat.metric.dimensions[]
Show child fields- slo.sli.sli_metric.metric_data_queries[].metric_stat.metric.dimensions[].name
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. - slo.sli.sli_metric.metric_data_queries[].metric_stat.metric.dimensions[].value
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.
- slo.sli.sli_metric.metric_data_queries[].metric_stat.metric.metric_name
The name of the metric to use. - slo.sli.sli_metric.metric_data_queries[].metric_stat.metric.namespace
The namespace of the metric. For more information, see Namespaces.
- slo.sli.sli_metric.metric_data_queries[].metric_stat.period
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. - slo.sli.sli_metric.metric_data_queries[].metric_stat.stat
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. - slo.sli.sli_metric.metric_data_queries[].metric_stat.unit
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.
- slo.sli.sli_metric.metric_data_queries[].period
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). - slo.sli.sli_metric.metric_data_queries[].return_data
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.
- slo.sli.sli_metric.metric_type
If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used. - slo.sli.sli_metric.operation_name
If the SLO monitors a specific operation of the service, this field displays that operation name.
|