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.

Return type: None

Static Methods

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

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

Parameters

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
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)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
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 used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: average over 5 minutes

stability :stability: experimental

Return type: Metric

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

Metric for the number of available state transitions per second.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
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)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
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 used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: average over 5 minutes

stability :stability: experimental

Return type: Metric

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

Metric for the number of available state transitions.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
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)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
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 used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: average over 5 minutes

stability :stability: experimental

Return type: Metric

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

Metric for the provisioned steady-state execution rate.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
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)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
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 used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: average over 5 minutes

stability :stability: experimental

Return type: Metric

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

Metric for the number of throttled state transitions.

Parameters

account (Optional[str]) – Account which this metric comes from. Default: Deployment account.
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)
region (Optional[str]) – Region which this metric comes from. Default: Deployment region.
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 used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: All metric datums in the given metric stream

default :default: sum over 5 minutes

stability :stability: experimental

Return type: Metric