StateTransitionMetric¶

class aws_cdk.aws_stepfunctions.StateTransitionMetric¶

Bases: object

Metrics on the rate limiting performed on state machine execution.

These rate limits are shared across all state machines.

stability :stability: experimental

__init__()¶

Initialize self. See help(type(self)) for accurate signature.

Static Methods

classmethod metric(metric_name, *, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶

Return the given named metric for the service’s state transition metrics.

Parameters

metric_name (str) –
props –
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit for the metric that is associated with the alarm.

default :default: average over 5 minutes

stability :stability: experimental

classmethod metric_consumed_capacity(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶

Metric for the number of available state transitions per second.

Parameters

props –
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit for the metric that is associated with the alarm.

default :default: average over 5 minutes

stability :stability: experimental

classmethod metric_provisioned_bucket_size(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶

Metric for the number of available state transitions.

Parameters

props –
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit for the metric that is associated with the alarm.

default :default: average over 5 minutes

stability :stability: experimental

classmethod metric_provisioned_refill_rate(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶

Metric for the provisioned steady-state execution rate.

Parameters

props –
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit for the metric that is associated with the alarm.

default :default: average over 5 minutes

stability :stability: experimental

classmethod metric_throttled_events(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶

Metric for the number of throttled state transitions.

Parameters

props –
color (Optional[str]) – Color for this metric when added to a Graph in a Dashboard.
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard.
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit for the metric that is associated with the alarm.

default :default: sum over 5 minutes

stability :stability: experimental