StepRetryPolicy: StepRetryPolicy class

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

StepRetryPolicy class

Description

RetryPolicy for a retryable step. The pipeline service will retry

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::RetryPolicy -> StepRetryPolicy

Public fields

exception_types

(List[StepExceptionTypeEnum]): the exception types to match for this policy

Methods

Public methods

• StepRetryPolicy$new()

• StepRetryPolicy$to_request()

• StepRetryPolicy$clone()

Inherited methods

• sagemaker.workflow::RetryPolicy$format()

• sagemaker.workflow::RetryPolicy$validate_backoff_rate()

• sagemaker.workflow::RetryPolicy$validate_expire_after_mins()

• sagemaker.workflow::RetryPolicy$validate_interval_seconds()

• sagemaker.workflow::RetryPolicy$validate_max_attempts()

---

Method new()

Initialize StepRetryPolicy class

Usage

StepRetryPolicy$new(
  exception_types,
  backoff_rate = 2,
  interval_seconds = 1,
  max_attempts = NULL,
  expire_after_mins = NULL
)

Arguments

exception_types

(List[StepExceptionTypeEnum]): the exception types to match for this policy

backoff_rate

(float): The multiplier by which the retry interval increases during each attempt (default: 2.0)

interval_seconds

(int): An integer that represents the number of seconds before the first retry attempt (default: 1)

max_attempts

(int): A positive integer that represents the maximum number of retry attempts. (default: None)

expire_after_mins

(int): A positive integer that represents the maximum minute to expire any further retry attempt (default: None)

---

Method to_request()

Gets the request structure for retry policy.

Usage

StepRetryPolicy$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StepRetryPolicy$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.