@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-sagemaker-endpoint.d.ts

@@ -0,0 +1,175 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type SageMakerEndpoint = ResourceDefinitionWithAttributes<"AWS::SageMaker::Endpoint", SageMakerEndpointProps, SageMakerEndpointAttribs>;
+/**
+ * Use the `AWS::SageMaker::Endpoint` resource to create an endpoint using the specified configuration in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource. For more information, see [Deploy a Model on Amazon SageMaker Hosting Services](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works-hosting.html) in the *Amazon SageMaker Developer Guide* .
+ */
+export type SageMakerEndpointProps = {
+    /**
+     * The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
+     */
+    DeploymentConfig?: DeploymentConfig | undefined;
+    /**
+     * The name of the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource that specifies the configuration for the endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) .
+     */
+    EndpointConfigName: string;
+    /**
+     * When you are updating endpoint resources with [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) whose value is set to `true` , `ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html) to override with the values provided by `EndpointConfig` . If you don't specify a value for `ExcludeAllVariantProperties` , no variant properties are overridden. Don't use this property when creating new endpoint resources or when `RetainAllVariantProperties` is set to `false` .
+     */
+    ExcludeRetainedVariantProperties?: VariantProperty[] | undefined;
+    /**
+     * When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set `RetainAllVariantProperties` to `true` . To use the variant properties specified in a new `EndpointConfig` call when updating an endpoint, set `RetainAllVariantProperties` to `false` . Use this property only when updating endpoint resources, not when creating new endpoint resources.
+     */
+    RetainAllVariantProperties?: boolean | undefined;
+    /**
+     * Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
+     */
+    RetainDeploymentConfig?: boolean | undefined;
+    /**
+     * A list of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide* .
+     */
+    Tags?: Tag[] | undefined;
+};
+export type SageMakerEndpointAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the endpoint.
+     */
+    EndpointArn: string;
+    /**
+     * The name of the endpoint, such as `MyEndpoint` .
+     */
+    EndpointName: string;
+};
+/**
+ * An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
+ */
+export type Alarm = {
+    /**
+     * The name of a CloudWatch alarm in your account.
+     */
+    AlarmName: string;
+};
+/**
+ * Automatic rollback configuration for handling endpoint deployment failures and recovery.
+ */
+export type AutoRollbackConfig = {
+    /**
+     * List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.
+     */
+    Alarms: Alarm[];
+};
+/**
+ * Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
+ */
+export type BlueGreenUpdatePolicy = {
+    /**
+     * Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in `TerminationWaitInSeconds` and `WaitIntervalInSeconds` .
+     */
+    MaximumExecutionTimeoutInSeconds?: number | undefined;
+    /**
+     * Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
+     */
+    TerminationWaitInSeconds?: number | undefined;
+    /**
+     * Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.
+     */
+    TrafficRoutingConfiguration: TrafficRoutingConfig;
+};
+/**
+ * Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy. You can specify your batches as either instance count or the overall percentage or your fleet.
+ *
+ * For a rollback strategy, if you don't specify the fields in this object, or if you set the `Value` to 100%, then SageMaker uses a blue/green rollback strategy and rolls all traffic back to the blue fleet.
+ */
+export type CapacitySize = {
+    /**
+     * Specifies the endpoint capacity type.
+     *
+     * - `INSTANCE_COUNT` : The endpoint activates based on the number of instances.
+     * - `CAPACITY_PERCENT` : The endpoint activates based on the specified percentage of capacity.
+     */
+    Type: string;
+    /**
+     * Defines the capacity size, either as a number of instances or a capacity percentage.
+     */
+    Value: number;
+};
+/**
+ * The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
+ */
+export type DeploymentConfig = {
+    /**
+     * Automatic rollback configuration for handling endpoint deployment failures and recovery.
+     */
+    AutoRollbackConfiguration?: AutoRollbackConfig | undefined;
+    /**
+     * Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.
+     */
+    BlueGreenUpdatePolicy?: BlueGreenUpdatePolicy | undefined;
+    /**
+     * Specifies a rolling deployment strategy for updating a SageMaker endpoint.
+     */
+    RollingUpdatePolicy?: RollingUpdatePolicy | undefined;
+};
+/**
+ * Specifies a rolling deployment strategy for updating a SageMaker endpoint.
+ */
+export type RollingUpdatePolicy = {
+    /**
+     * Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet. Value must be between 5% to 50% of the variant's total instance count.
+     */
+    MaximumBatchSize: CapacitySize;
+    /**
+     * The time limit for the total deployment. Exceeding this limit causes a timeout.
+     */
+    MaximumExecutionTimeoutInSeconds?: number | undefined;
+    /**
+     * Batch size for rollback to the old endpoint fleet. Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.
+     */
+    RollbackMaximumBatchSize?: CapacitySize | undefined;
+    /**
+     * The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
+     */
+    WaitIntervalInSeconds: number;
+};
+/**
+ * Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.
+ */
+export type TrafficRoutingConfig = {
+    /**
+     * Batch size for the first step to turn on traffic on the new endpoint fleet. `Value` must be less than or equal to 50% of the variant's total instance count.
+     */
+    CanarySize?: CapacitySize | undefined;
+    /**
+     * Batch size for each step to turn on traffic on the new endpoint fleet. `Value` must be 10-50% of the variant's total instance count.
+     */
+    LinearStepSize?: CapacitySize | undefined;
+    /**
+     * Traffic routing strategy type.
+     *
+     * - `ALL_AT_ONCE` : Endpoint traffic shifts to the new fleet in a single step.
+     * - `CANARY` : Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
+     * - `LINEAR` : Endpoint traffic shifts to the new fleet in n steps of a configurable size.
+     */
+    Type: string;
+    /**
+     * The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
+     */
+    WaitIntervalInSeconds?: number | undefined;
+};
+/**
+ * Specifies a production variant property type for an Endpoint.
+ *
+ * If you are updating an Endpoint with the [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) option set to `true` , the `VarientProperty` objects listed in [ExcludeRetainedVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-ExcludeRetainedVariantProperties) override the existing variant properties of the Endpoint.
+ */
+export type VariantProperty = {
+    /**
+     * The type of variant property. The supported values are:
+     *
+     * - `DesiredInstanceCount` : Overrides the existing variant instance counts using the [InitialInstanceCount](https://docs.aws.amazon.com/sagemaker/latest/dg/API_ProductionVariant.html#SageMaker-Type-ProductionVariant-InitialInstanceCount) values in the [ProductionVariants](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html#SageMaker-CreateEndpointConfig-request-ProductionVariants) .
+     * - `DesiredWeight` : Overrides the existing variant weights using the [InitialVariantWeight](https://docs.aws.amazon.com/sagemaker/latest/dg/API_ProductionVariant.html#SageMaker-Type-ProductionVariant-InitialVariantWeight) values in the [ProductionVariants](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html#SageMaker-CreateEndpointConfig-request-ProductionVariants) .
+     * - `DataCaptureConfig` : (Not currently supported.)
+     */
+    VariantPropertyType?: string | undefined;
+};
+//# sourceMappingURL=aws-sagemaker-endpoint.d.ts.map

package/out/exports/resources.generated/aws-sagemaker-endpointconfig.d.ts

@@ -0,0 +1,404 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type SageMakerEndpointConfig = ResourceDefinitionWithAttributes<"AWS::SageMaker::EndpointConfig", SageMakerEndpointConfigProps, SageMakerEndpointConfigAttribs>;
+/**
+ * The `AWS::SageMaker::EndpointConfig` resource creates a configuration for an Amazon SageMaker endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) in the *SageMaker Developer Guide* .
+ */
+export type SageMakerEndpointConfigProps = {
+    /**
+     * Specifies configuration for how an endpoint performs asynchronous inference.
+     */
+    AsyncInferenceConfig?: AsyncInferenceConfig | undefined;
+    /**
+     * Specifies how to capture endpoint data for model monitor. The data capture configuration applies to all production variants hosted at the endpoint.
+     */
+    DataCaptureConfig?: DataCaptureConfig | undefined;
+    EnableNetworkIsolation?: boolean | undefined;
+    /**
+     * The name of the endpoint configuration.
+     */
+    EndpointConfigName?: string | undefined;
+    ExecutionRoleArn?: string | undefined;
+    /**
+     * A parameter to activate explainers.
+     */
+    ExplainerConfig?: ExplainerConfig | undefined;
+    /**
+     * The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
+     *
+     * - 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 AWS Key Management Service section [Using Key Policies in AWS KMS](https://docs.aws.amazon.com//kms/latest/developerguide/key-policies.html)
+     *
+     * > 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) .
+     * >
+     * > For more information about local instance storage encryption, see [SSD Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) .
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.
+     */
+    ProductionVariants: ProductionVariant[];
+    /**
+     * Array of `ProductionVariant` objects. There is 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` .
+     */
+    ShadowProductionVariants?: ProductionVariant[] | undefined;
+    /**
+     * A list of key-value pairs to apply to this resource.
+     *
+     * For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) .
+     */
+    Tags?: Tag[] | undefined;
+    VpcConfig?: VpcConfig | undefined;
+};
+export type SageMakerEndpointConfigAttribs = {
+    /**
+     * The name of the endpoint configuration, such as `MyEndpointConfiguration` .
+     */
+    EndpointConfigName: string;
+    Id: string;
+};
+/**
+ * Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
+ */
+export type AsyncInferenceClientConfig = {
+    /**
+     * The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker will choose an optimal value for you.
+     */
+    MaxConcurrentInvocationsPerInstance?: number | undefined;
+};
+/**
+ * Specifies configuration for how an endpoint performs asynchronous inference.
+ */
+export type AsyncInferenceConfig = {
+    /**
+     * Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
+     */
+    ClientConfig?: AsyncInferenceClientConfig | undefined;
+    /**
+     * Specifies the configuration for asynchronous inference invocation outputs.
+     */
+    OutputConfig: AsyncInferenceOutputConfig;
+};
+/**
+ * Specifies the configuration for notifications of inference results for asynchronous inference.
+ */
+export type AsyncInferenceNotificationConfig = {
+    /**
+     * Amazon SNS topic to post a notification to when an inference fails. If no topic is provided, no notification is sent on failure.
+     */
+    ErrorTopic?: string | undefined;
+    /**
+     * The Amazon SNS topics where you want the inference response to be included.
+     *
+     * > The inference response is included only if the response size is less than or equal to 128 KB.
+     */
+    IncludeInferenceResponseIn?: string[] | undefined;
+    /**
+     * Amazon SNS topic to post a notification to when an inference completes successfully. If no topic is provided, no notification is sent on success.
+     */
+    SuccessTopic?: string | undefined;
+};
+/**
+ * Specifies the configuration for asynchronous inference invocation outputs.
+ */
+export type AsyncInferenceOutputConfig = {
+    /**
+     * The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * Specifies the configuration for notifications of inference results for asynchronous inference.
+     */
+    NotificationConfig?: AsyncInferenceNotificationConfig | undefined;
+    /**
+     * The Amazon S3 location to upload failure inference responses to.
+     */
+    S3FailurePath?: string | undefined;
+    /**
+     * The Amazon S3 location to upload inference responses to.
+     */
+    S3OutputPath?: string | undefined;
+};
+/**
+ * Specifies the JSON and CSV content types of the data that the endpoint captures.
+ */
+export type CaptureContentTypeHeader = {
+    /**
+     * A list of the CSV content types of the data that the endpoint captures. For the endpoint to capture the data, you must also specify the content type when you invoke the endpoint.
+     */
+    CsvContentTypes?: string[] | undefined;
+    /**
+     * A list of the JSON content types of the data that the endpoint captures. For the endpoint to capture the data, you must also specify the content type when you invoke the endpoint.
+     */
+    JsonContentTypes?: string[] | undefined;
+};
+/**
+ * Specifies whether the endpoint captures input data or output data.
+ */
+export type CaptureOption = {
+    /**
+     * Specifies whether the endpoint captures input data or output data.
+     */
+    CaptureMode: string;
+};
+/**
+ * The configuration parameters for the SageMaker Clarify explainer.
+ */
+export type ClarifyExplainerConfig = {
+    /**
+     * A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See [`EnableExplanations`](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable) for additional information.
+     */
+    EnableExplanations?: string | undefined;
+    /**
+     * The inference configuration parameter for the model container.
+     */
+    InferenceConfig?: ClarifyInferenceConfig | undefined;
+    /**
+     * The configuration for SHAP analysis.
+     */
+    ShapConfig: ClarifyShapConfig;
+};
+/**
+ * The inference configuration parameter for the model container.
+ */
+export type ClarifyInferenceConfig = {
+    /**
+     * A template string used to format a JSON record into an acceptable model container input. For example, a `ContentTemplate` string `'{"myfeatures":$features}'` will format a list of features `[1,2,3]` into the record string `'{"myfeatures":[1,2,3]}'` . Required only when the model container input is in JSON Lines format.
+     */
+    ContentTemplate?: string | undefined;
+    /**
+     * The names of the features. If provided, these are included in the endpoint response payload to help readability of the `InvokeEndpoint` output. See the [Response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under *Invoke the endpoint* in the Developer Guide for more information.
+     */
+    FeatureHeaders?: Record<string, unknown>[] | undefined;
+    /**
+     * A list of data types of the features (optional). Applicable only to NLP explainability. If provided, `FeatureTypes` must have at least one `'text'` string (for example, `['text']` ). If `FeatureTypes` is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the [response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under *Invoke the endpoint* in the Developer Guide for more information.
+     */
+    FeatureTypes?: Record<string, unknown>[] | undefined;
+    /**
+     * Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if `FeaturesAttribute` is the JMESPath expression `'myfeatures'` , it extracts a list of features `[1,2,3]` from request data `'{"myfeatures":[1,2,3]}'` .
+     */
+    FeaturesAttribute?: string | undefined;
+    /**
+     * A JMESPath expression used to locate the list of label headers in the model container output.
+     *
+     * *Example* : If the model container output of a batch request is `'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}'` , then set `LabelAttribute` to `'labels'` to extract the list of label headers `["cat","dog","fish"]`
+     */
+    LabelAttribute?: string | undefined;
+    /**
+     * For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the `InvokeEndpoint` API. See the [response](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response) section under *Invoke the endpoint* in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.
+     */
+    LabelHeaders?: Record<string, unknown>[] | undefined;
+    /**
+     * A zero-based index used to extract a label header or list of label headers from model container output in CSV format.
+     *
+     * *Example for a multiclass model:* If the model container output consists of label headers followed by probabilities: `'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'` , set `LabelIndex` to `0` to select the label headers `['cat','dog','fish']` .
+     */
+    LabelIndex?: number | undefined;
+    /**
+     * The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to `6` MB.
+     */
+    MaxPayloadInMB?: number | undefined;
+    /**
+     * The maximum number of records in a request that the model container can process when querying the model container for the predictions of a [synthetic dataset](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic) . A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If `MaxRecordCount` is `1` , the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.
+     */
+    MaxRecordCount?: number | undefined;
+    /**
+     * A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.
+     *
+     * *Example* : If the model container output of a single request is `'{"predicted_label":1,"probability":0.6}'` , then set `ProbabilityAttribute` to `'probability'` .
+     */
+    ProbabilityAttribute?: string | undefined;
+    /**
+     * A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.
+     *
+     * *Example for a single class model:* If the model container output consists of a string-formatted prediction label followed by its probability: `'1,0.6'` , set `ProbabilityIndex` to `1` to select the probability value `0.6` .
+     *
+     * *Example for a multiclass model:* If the model container output consists of a string-formatted prediction label followed by its probability: `'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'` , set `ProbabilityIndex` to `1` to select the probability values `[0.1,0.6,0.3]` .
+     */
+    ProbabilityIndex?: number | undefined;
+};
+/**
+ * The configuration for the [SHAP baseline](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-feature-attribute-shap-baselines.html) (also called the background or reference dataset) of the Kernal SHAP algorithm.
+ *
+ * > - The number of records in the baseline data determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the *Synthetic data* of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) .
+ * > - `ShapBaseline` and `ShapBaselineUri` are mutually exclusive parameters. One or the either is required to configure a SHAP baseline.
+ */
+export type ClarifyShapBaselineConfig = {
+    /**
+     * The MIME type of the baseline data. Choose from `'text/csv'` or `'application/jsonlines'` . Defaults to `'text/csv'` .
+     */
+    MimeType?: string | undefined;
+    /**
+     * The inline SHAP baseline data in string format. `ShapBaseline` can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the `Granularity` of the `TextConfig` parameter. The size limit for `ShapBasline` is 4 KB. Use the `ShapBaselineUri` parameter if you want to provide more than 4 KB of baseline data.
+     */
+    ShapBaseline?: string | undefined;
+    /**
+     * The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the `ShapBaselineUri` should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see [Give SageMaker access to Resources in your Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html) .
+     */
+    ShapBaselineUri?: string | undefined;
+};
+/**
+ * The configuration for SHAP analysis using SageMaker Clarify Explainer.
+ */
+export type ClarifyShapConfig = {
+    /**
+     * The number of samples to be used for analysis by the Kernal SHAP algorithm.
+     *
+     * > The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the *Synthetic data* of [Configure and create an endpoint](https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html) .
+     */
+    NumberOfSamples?: number | undefined;
+    /**
+     * The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.
+     */
+    Seed?: number | undefined;
+    /**
+     * The configuration for the SHAP baseline of the Kernal SHAP algorithm.
+     */
+    ShapBaselineConfig: ClarifyShapBaselineConfig;
+    /**
+     * A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.
+     */
+    TextConfig?: ClarifyTextConfig | undefined;
+    /**
+     * A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.
+     */
+    UseLogit?: boolean | undefined;
+};
+/**
+ * A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text. Required only for natural language processing (NLP) explainability.
+ */
+export type ClarifyTextConfig = {
+    /**
+     * The unit of granularity for the analysis of text features. For example, if the unit is `'token'` , then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.
+     */
+    Granularity: string;
+    /**
+     * Specifies the language of the text features in [ISO 639-1](https://docs.aws.amazon.com/ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or [ISO 639-3](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/ISO_639-3) code of a supported language.
+     *
+     * > For a mix of multiple languages, use code `'xx'` .
+     */
+    Language: string;
+};
+/**
+ * Specifies the configuration of your endpoint for model monitor data capture.
+ */
+export type DataCaptureConfig = {
+    /**
+     * A list of the JSON and CSV content type that the endpoint captures.
+     */
+    CaptureContentTypeHeader?: CaptureContentTypeHeader | undefined;
+    /**
+     * Specifies whether the endpoint captures input data to your model, output data from your model, or both.
+     */
+    CaptureOptions: CaptureOption[];
+    /**
+     * The S3 bucket where model monitor stores captured data.
+     */
+    DestinationS3Uri: string;
+    /**
+     * Set to `True` to enable data capture.
+     */
+    EnableCapture?: boolean | undefined;
+    /**
+     * The percentage of data to capture.
+     */
+    InitialSamplingPercentage: number;
+    /**
+     * The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption. 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 If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateModel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) request. For more information, see Using Key Policies in AWS KMS (http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the AWS Key Management Service Developer Guide.
+     */
+    KmsKeyId?: string | undefined;
+};
+/**
+ * A parameter to activate explainers.
+ */
+export type ExplainerConfig = {
+    /**
+     * A member of `ExplainerConfig` that contains configuration parameters for the SageMaker Clarify explainer.
+     */
+    ClarifyExplainerConfig?: ClarifyExplainerConfig | undefined;
+};
+export type ManagedInstanceScaling = {
+    MaxInstanceCount?: number | undefined;
+    MinInstanceCount?: number | undefined;
+    Status?: string | undefined;
+};
+/**
+ * Specifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying the `InitialVariantWeight` objects.
+ */
+export type ProductionVariant = {
+    /**
+     * The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see [How Your Container Should Respond to Health Check (Ping) Requests](https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests) .
+     */
+    ContainerStartupHealthCheckTimeoutInSeconds?: number | undefined;
+    /**
+     * You can use this parameter to turn on native AWS Systems Manager (SSM) access for a production variant behind an endpoint. By default, SSM access is disabled for all production variants behind an endpoint. You can turn on or turn off SSM access for a production variant behind an existing endpoint by creating a new endpoint configuration and calling `UpdateEndpoint` .
+     */
+    EnableSSMAccess?: boolean | undefined;
+    InferenceAmiVersion?: string | undefined;
+    /**
+     * Number of instances to launch initially.
+     */
+    InitialInstanceCount?: number | undefined;
+    /**
+     * Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the `VariantWeight` to the sum of all `VariantWeight` values across all ProductionVariants. If unspecified, it defaults to 1.0.
+     */
+    InitialVariantWeight?: number | undefined;
+    /**
+     * The ML compute instance type.
+     */
+    InstanceType?: string | undefined;
+    ManagedInstanceScaling?: ManagedInstanceScaling | undefined;
+    /**
+     * The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.
+     */
+    ModelDataDownloadTimeoutInSeconds?: number | undefined;
+    /**
+     * The name of the model that you want to host. This is the name that you specified when creating the model.
+     */
+    ModelName?: string | undefined;
+    RoutingConfig?: RoutingConfig | undefined;
+    /**
+     * The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
+     */
+    ServerlessConfig?: ServerlessConfig | undefined;
+    /**
+     * The name of the production variant.
+     */
+    VariantName: string;
+    /**
+     * The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currently only Amazon EBS gp2 storage volumes are supported.
+     */
+    VolumeSizeInGB?: number | undefined;
+};
+export type RoutingConfig = {
+    RoutingStrategy?: string | undefined;
+};
+/**
+ * Specifies the serverless configuration for an endpoint variant.
+ */
+export type ServerlessConfig = {
+    /**
+     * The maximum number of concurrent invocations your serverless endpoint can process.
+     */
+    MaxConcurrency: number;
+    /**
+     * The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.
+     */
+    MemorySizeInMB: number;
+    /**
+     * The amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to `MaxConcurrency` .
+     *
+     * > This field is not supported for serverless endpoint recommendations for Inference Recommender jobs. For more information about creating an Inference Recommender job, see [CreateInferenceRecommendationsJobs](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceRecommendationsJob.html) .
+     */
+    ProvisionedConcurrency?: number | undefined;
+};
+export type VpcConfig = {
+    SecurityGroupIds: string[];
+    Subnets: string[];
+};
+//# sourceMappingURL=aws-sagemaker-endpointconfig.d.ts.map