/** * 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 #include namespace Aws { namespace SageMaker { namespace Model { /** */ class CreateEndpointConfigRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API CreateEndpointConfigRequest(); // 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 "CreateEndpointConfig"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline const Aws::String& GetEndpointConfigName() const{ return m_endpointConfigName; } /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline bool EndpointConfigNameHasBeenSet() const { return m_endpointConfigNameHasBeenSet; } /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline void SetEndpointConfigName(const Aws::String& value) { m_endpointConfigNameHasBeenSet = true; m_endpointConfigName = value; } /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline void SetEndpointConfigName(Aws::String&& value) { m_endpointConfigNameHasBeenSet = true; m_endpointConfigName = std::move(value); } /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline void SetEndpointConfigName(const char* value) { m_endpointConfigNameHasBeenSet = true; m_endpointConfigName.assign(value); } /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline CreateEndpointConfigRequest& WithEndpointConfigName(const Aws::String& value) { SetEndpointConfigName(value); return *this;} /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline CreateEndpointConfigRequest& WithEndpointConfigName(Aws::String&& value) { SetEndpointConfigName(std::move(value)); return *this;} /** *

The name of the endpoint configuration. You specify this name in a CreateEndpoint * request.

*/ inline CreateEndpointConfigRequest& WithEndpointConfigName(const char* value) { SetEndpointConfigName(value); return *this;} /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline const Aws::Vector& GetProductionVariants() const{ return m_productionVariants; } /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline bool ProductionVariantsHasBeenSet() const { return m_productionVariantsHasBeenSet; } /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline void SetProductionVariants(const Aws::Vector& value) { m_productionVariantsHasBeenSet = true; m_productionVariants = value; } /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline void SetProductionVariants(Aws::Vector&& value) { m_productionVariantsHasBeenSet = true; m_productionVariants = std::move(value); } /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline CreateEndpointConfigRequest& WithProductionVariants(const Aws::Vector& value) { SetProductionVariants(value); return *this;} /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline CreateEndpointConfigRequest& WithProductionVariants(Aws::Vector&& value) { SetProductionVariants(std::move(value)); return *this;} /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline CreateEndpointConfigRequest& AddProductionVariants(const ProductionVariant& value) { m_productionVariantsHasBeenSet = true; m_productionVariants.push_back(value); return *this; } /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint.

*/ inline CreateEndpointConfigRequest& AddProductionVariants(ProductionVariant&& value) { m_productionVariantsHasBeenSet = true; m_productionVariants.push_back(std::move(value)); return *this; } inline const DataCaptureConfig& GetDataCaptureConfig() const{ return m_dataCaptureConfig; } inline bool DataCaptureConfigHasBeenSet() const { return m_dataCaptureConfigHasBeenSet; } inline void SetDataCaptureConfig(const DataCaptureConfig& value) { m_dataCaptureConfigHasBeenSet = true; m_dataCaptureConfig = value; } inline void SetDataCaptureConfig(DataCaptureConfig&& value) { m_dataCaptureConfigHasBeenSet = true; m_dataCaptureConfig = std::move(value); } inline CreateEndpointConfigRequest& WithDataCaptureConfig(const DataCaptureConfig& value) { SetDataCaptureConfig(value); return *this;} inline CreateEndpointConfigRequest& WithDataCaptureConfig(DataCaptureConfig&& value) { SetDataCaptureConfig(std::move(value)); return *this;} /** *

An array of key-value pairs. You can use tags to categorize your Amazon Web * Services resources in different ways, for example, by purpose, owner, or * environment. For more information, see Tagging * Amazon Web Services Resources.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

*/ inline CreateEndpointConfigRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

*/ inline CreateEndpointConfigRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

*/ inline CreateEndpointConfigRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

*/ inline CreateEndpointConfigRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management * Service key that SageMaker uses to encrypt data on the storage volume attached * to the ML compute instance that hosts the endpoint.

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you * specify in your CreateEndpoint, UpdateEndpoint * requests. For more information, refer to the Amazon Web Services Key Management * Service section * Using Key Policies in Amazon Web Services KMS

Certain * Nitro-based instances include local storage, dependent on the instance type. * Local storage volumes are encrypted using a hardware module on the instance. You * can't request a KmsKeyId when using an instance type with local * storage. If any of the models that you specify in the * ProductionVariants parameter use nitro-based instances with local * storage, do not specify a value for the KmsKeyId parameter. If you * specify a value for KmsKeyId when using any nitro-based instances * with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; } /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline CreateEndpointConfigRequest& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline CreateEndpointConfigRequest& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

The KmsKeyId can be * any of the following formats:

Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: * arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *
Alias name: alias/ExampleAlias
*
Alias name ARN: * arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

For a list of instance types that support local instance storage, see Instance * Store Volumes.

For more information about local instance storage * encryption, see SSD * Instance Store Volumes.

*/ inline CreateEndpointConfigRequest& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} /** *

Specifies configuration for how an endpoint performs asynchronous inference. * This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

*/ inline const AsyncInferenceConfig& GetAsyncInferenceConfig() const{ return m_asyncInferenceConfig; } /** *

Specifies configuration for how an endpoint performs asynchronous inference. * This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

*/ inline bool AsyncInferenceConfigHasBeenSet() const { return m_asyncInferenceConfigHasBeenSet; } /** *

Specifies configuration for how an endpoint performs asynchronous inference. * This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

*/ inline void SetAsyncInferenceConfig(const AsyncInferenceConfig& value) { m_asyncInferenceConfigHasBeenSet = true; m_asyncInferenceConfig = value; } /** *

Specifies configuration for how an endpoint performs asynchronous inference. * This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

*/ inline void SetAsyncInferenceConfig(AsyncInferenceConfig&& value) { m_asyncInferenceConfigHasBeenSet = true; m_asyncInferenceConfig = std::move(value); } /** *

Specifies configuration for how an endpoint performs asynchronous inference. * This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

*/ inline CreateEndpointConfigRequest& WithAsyncInferenceConfig(const AsyncInferenceConfig& value) { SetAsyncInferenceConfig(value); return *this;} /** *

Specifies configuration for how an endpoint performs asynchronous inference. * This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

*/ inline CreateEndpointConfigRequest& WithAsyncInferenceConfig(AsyncInferenceConfig&& value) { SetAsyncInferenceConfig(std::move(value)); return *this;} /** *

A member of CreateEndpointConfig that enables explainers.

*/ inline const ExplainerConfig& GetExplainerConfig() const{ return m_explainerConfig; } /** *

A member of CreateEndpointConfig that enables explainers.

*/ inline bool ExplainerConfigHasBeenSet() const { return m_explainerConfigHasBeenSet; } /** *

A member of CreateEndpointConfig that enables explainers.

*/ inline void SetExplainerConfig(const ExplainerConfig& value) { m_explainerConfigHasBeenSet = true; m_explainerConfig = value; } /** *

A member of CreateEndpointConfig that enables explainers.

*/ inline void SetExplainerConfig(ExplainerConfig&& value) { m_explainerConfigHasBeenSet = true; m_explainerConfig = std::move(value); } /** *

A member of CreateEndpointConfig that enables explainers.

*/ inline CreateEndpointConfigRequest& WithExplainerConfig(const ExplainerConfig& value) { SetExplainerConfig(value); return *this;} /** *

A member of CreateEndpointConfig that enables explainers.

*/ inline CreateEndpointConfigRequest& WithExplainerConfig(ExplainerConfig&& value) { SetExplainerConfig(std::move(value)); return *this;} /** *

An array of ProductionVariant objects, one for each model that * you want to host at this endpoint in shadow mode with production traffic * replicated from the model specified on ProductionVariants. If you * use this field, you can only specify one variant for * ProductionVariants and one variant for * ShadowProductionVariants.

*/ inline const Aws::Vector& GetShadowProductionVariants() const{ return m_shadowProductionVariants; } /** *

*/ inline bool ShadowProductionVariantsHasBeenSet() const { return m_shadowProductionVariantsHasBeenSet; } /** *

*/ inline void SetShadowProductionVariants(const Aws::Vector& value) { m_shadowProductionVariantsHasBeenSet = true; m_shadowProductionVariants = value; } /** *

*/ inline void SetShadowProductionVariants(Aws::Vector&& value) { m_shadowProductionVariantsHasBeenSet = true; m_shadowProductionVariants = std::move(value); } /** *

*/ inline CreateEndpointConfigRequest& WithShadowProductionVariants(const Aws::Vector& value) { SetShadowProductionVariants(value); return *this;} /** *

*/ inline CreateEndpointConfigRequest& WithShadowProductionVariants(Aws::Vector&& value) { SetShadowProductionVariants(std::move(value)); return *this;} /** *

*/ inline CreateEndpointConfigRequest& AddShadowProductionVariants(const ProductionVariant& value) { m_shadowProductionVariantsHasBeenSet = true; m_shadowProductionVariants.push_back(value); return *this; } /** *

*/ inline CreateEndpointConfigRequest& AddShadowProductionVariants(ProductionVariant&& value) { m_shadowProductionVariantsHasBeenSet = true; m_shadowProductionVariants.push_back(std::move(value)); return *this; } private: Aws::String m_endpointConfigName; bool m_endpointConfigNameHasBeenSet = false; Aws::Vector m_productionVariants; bool m_productionVariantsHasBeenSet = false; DataCaptureConfig m_dataCaptureConfig; bool m_dataCaptureConfigHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; AsyncInferenceConfig m_asyncInferenceConfig; bool m_asyncInferenceConfigHasBeenSet = false; ExplainerConfig m_explainerConfig; bool m_explainerConfigHasBeenSet = false; Aws::Vector m_shadowProductionVariants; bool m_shadowProductionVariantsHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws