SageMakerJobStepRetryPolicy: SageMakerJobStepRetryPolicy class

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

SageMakerJobStepRetryPolicy class

Description

RetryPolicy for exception thrown by SageMaker Job.

Super classes

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

Public fields

exception_type_list

Contains exception_types or failure_reason_types

Methods

Public methods

• SageMakerJobStepRetryPolicy$new()

• SageMakerJobStepRetryPolicy$to_request()

• SageMakerJobStepRetryPolicy$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 SageMakerJobStepRetryPolicy

Usage

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

Arguments

exception_types

(List[SageMakerJobExceptionTypeEnum]): The SageMaker exception to match for this policy. The SageMaker exceptions captured here are the exceptions thrown by synchronously creating the job. For instance the resource limit exception.

failure_reason_types

(List[SageMakerJobExceptionTypeEnum]): the SageMaker failure reason types to match for this policy. The failure reason type is presented in FailureReason field of the Describe response, it indicates the runtime failure reason for a job.

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

SageMakerJobStepRetryPolicy$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SageMakerJobStepRetryPolicy$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.