/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace SageMaker { namespace Model { /** */ class StopInferenceExperimentRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API StopInferenceExperimentRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "StopInferenceExperiment"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the inference experiment to stop.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the inference experiment to stop.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the inference experiment to stop.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the inference experiment to stop.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the inference experiment to stop.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the inference experiment to stop.

*/ inline StopInferenceExperimentRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the inference experiment to stop.

*/ inline StopInferenceExperimentRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the inference experiment to stop.

*/ inline StopInferenceExperimentRequest& WithName(const char* value) { SetName(value); return *this;} /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline const Aws::Map& GetModelVariantActions() const{ return m_modelVariantActions; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline bool ModelVariantActionsHasBeenSet() const { return m_modelVariantActionsHasBeenSet; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline void SetModelVariantActions(const Aws::Map& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions = value; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline void SetModelVariantActions(Aws::Map&& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions = std::move(value); } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& WithModelVariantActions(const Aws::Map& value) { SetModelVariantActions(value); return *this;} /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& WithModelVariantActions(Aws::Map&& value) { SetModelVariantActions(std::move(value)); return *this;} /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& AddModelVariantActions(const Aws::String& key, const ModelVariantAction& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions.emplace(key, value); return *this; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& AddModelVariantActions(Aws::String&& key, const ModelVariantAction& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions.emplace(std::move(key), value); return *this; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& AddModelVariantActions(const Aws::String& key, ModelVariantAction&& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions.emplace(key, std::move(value)); return *this; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& AddModelVariantActions(Aws::String&& key, ModelVariantAction&& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions.emplace(std::move(key), std::move(value)); return *this; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& AddModelVariantActions(const char* key, ModelVariantAction&& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions.emplace(key, std::move(value)); return *this; } /** *

Array of key-value pairs, with names of variants mapped to actions. The * possible actions are the following:

  • Promote - * Promote the shadow variant to a production variant

  • * Remove - Delete the variant

  • Retain * - Keep the variant as it is

*/ inline StopInferenceExperimentRequest& AddModelVariantActions(const char* key, const ModelVariantAction& value) { m_modelVariantActionsHasBeenSet = true; m_modelVariantActions.emplace(key, value); return *this; } /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline const Aws::Vector& GetDesiredModelVariants() const{ return m_desiredModelVariants; } /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline bool DesiredModelVariantsHasBeenSet() const { return m_desiredModelVariantsHasBeenSet; } /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline void SetDesiredModelVariants(const Aws::Vector& value) { m_desiredModelVariantsHasBeenSet = true; m_desiredModelVariants = value; } /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline void SetDesiredModelVariants(Aws::Vector&& value) { m_desiredModelVariantsHasBeenSet = true; m_desiredModelVariants = std::move(value); } /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline StopInferenceExperimentRequest& WithDesiredModelVariants(const Aws::Vector& value) { SetDesiredModelVariants(value); return *this;} /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline StopInferenceExperimentRequest& WithDesiredModelVariants(Aws::Vector&& value) { SetDesiredModelVariants(std::move(value)); return *this;} /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline StopInferenceExperimentRequest& AddDesiredModelVariants(const ModelVariantConfig& value) { m_desiredModelVariantsHasBeenSet = true; m_desiredModelVariants.push_back(value); return *this; } /** *

An array of ModelVariantConfig objects. There is one for each * variant that you want to deploy after the inference experiment stops. Each * ModelVariantConfig describes the infrastructure configuration for * deploying the corresponding variant.

*/ inline StopInferenceExperimentRequest& AddDesiredModelVariants(ModelVariantConfig&& value) { m_desiredModelVariantsHasBeenSet = true; m_desiredModelVariants.push_back(std::move(value)); return *this; } /** *

The desired state of the experiment after stopping. The possible states are * the following:

  • Completed: The experiment * completed successfully

  • Cancelled: The experiment * was canceled

*/ inline const InferenceExperimentStopDesiredState& GetDesiredState() const{ return m_desiredState; } /** *

The desired state of the experiment after stopping. The possible states are * the following:

  • Completed: The experiment * completed successfully

  • Cancelled: The experiment * was canceled

*/ inline bool DesiredStateHasBeenSet() const { return m_desiredStateHasBeenSet; } /** *

The desired state of the experiment after stopping. The possible states are * the following:

  • Completed: The experiment * completed successfully

  • Cancelled: The experiment * was canceled

*/ inline void SetDesiredState(const InferenceExperimentStopDesiredState& value) { m_desiredStateHasBeenSet = true; m_desiredState = value; } /** *

The desired state of the experiment after stopping. The possible states are * the following:

  • Completed: The experiment * completed successfully

  • Cancelled: The experiment * was canceled

*/ inline void SetDesiredState(InferenceExperimentStopDesiredState&& value) { m_desiredStateHasBeenSet = true; m_desiredState = std::move(value); } /** *

The desired state of the experiment after stopping. The possible states are * the following:

  • Completed: The experiment * completed successfully

  • Cancelled: The experiment * was canceled

*/ inline StopInferenceExperimentRequest& WithDesiredState(const InferenceExperimentStopDesiredState& value) { SetDesiredState(value); return *this;} /** *

The desired state of the experiment after stopping. The possible states are * the following:

  • Completed: The experiment * completed successfully

  • Cancelled: The experiment * was canceled

*/ inline StopInferenceExperimentRequest& WithDesiredState(InferenceExperimentStopDesiredState&& value) { SetDesiredState(std::move(value)); return *this;} /** *

The reason for stopping the experiment.

*/ inline const Aws::String& GetReason() const{ return m_reason; } /** *

The reason for stopping the experiment.

*/ inline bool ReasonHasBeenSet() const { return m_reasonHasBeenSet; } /** *

The reason for stopping the experiment.

*/ inline void SetReason(const Aws::String& value) { m_reasonHasBeenSet = true; m_reason = value; } /** *

The reason for stopping the experiment.

*/ inline void SetReason(Aws::String&& value) { m_reasonHasBeenSet = true; m_reason = std::move(value); } /** *

The reason for stopping the experiment.

*/ inline void SetReason(const char* value) { m_reasonHasBeenSet = true; m_reason.assign(value); } /** *

The reason for stopping the experiment.

*/ inline StopInferenceExperimentRequest& WithReason(const Aws::String& value) { SetReason(value); return *this;} /** *

The reason for stopping the experiment.

*/ inline StopInferenceExperimentRequest& WithReason(Aws::String&& value) { SetReason(std::move(value)); return *this;} /** *

The reason for stopping the experiment.

*/ inline StopInferenceExperimentRequest& WithReason(const char* value) { SetReason(value); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::Map m_modelVariantActions; bool m_modelVariantActionsHasBeenSet = false; Aws::Vector m_desiredModelVariants; bool m_desiredModelVariantsHasBeenSet = false; InferenceExperimentStopDesiredState m_desiredState; bool m_desiredStateHasBeenSet = false; Aws::String m_reason; bool m_reasonHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws