@aws-sdk/client-sagemaker 3.606.0 → 3.613.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/README.md +40 -0
  2. package/dist-cjs/index.js +4869 -4441
  3. package/dist-es/SageMaker.js +10 -0
  4. package/dist-es/commands/CreateOptimizationJobCommand.js +24 -0
  5. package/dist-es/commands/DeleteOptimizationJobCommand.js +24 -0
  6. package/dist-es/commands/DescribeModelPackageCommand.js +1 -1
  7. package/dist-es/commands/DescribeOptimizationJobCommand.js +24 -0
  8. package/dist-es/commands/ListOptimizationJobsCommand.js +24 -0
  9. package/dist-es/commands/StopOptimizationJobCommand.js +24 -0
  10. package/dist-es/commands/index.js +5 -0
  11. package/dist-es/models/models_0.js +4 -4
  12. package/dist-es/models/models_1.js +38 -0
  13. package/dist-es/models/models_2.js +0 -19
  14. package/dist-es/models/models_3.js +27 -17
  15. package/dist-es/models/models_4.js +22 -0
  16. package/dist-es/pagination/ListOptimizationJobsPaginator.js +4 -0
  17. package/dist-es/pagination/index.js +1 -0
  18. package/dist-es/protocols/Aws_json1_1.js +278 -0
  19. package/dist-types/SageMaker.d.ts +36 -0
  20. package/dist-types/SageMakerClient.d.ts +7 -2
  21. package/dist-types/commands/CreateAppCommand.d.ts +3 -2
  22. package/dist-types/commands/CreateClusterCommand.d.ts +2 -1
  23. package/dist-types/commands/CreateCodeRepositoryCommand.d.ts +1 -2
  24. package/dist-types/commands/CreateDomainCommand.d.ts +22 -18
  25. package/dist-types/commands/CreateModelCommand.d.ts +22 -0
  26. package/dist-types/commands/CreateOptimizationJobCommand.d.ts +124 -0
  27. package/dist-types/commands/CreatePresignedDomainUrlCommand.d.ts +15 -15
  28. package/dist-types/commands/CreateProcessingJobCommand.d.ts +1 -1
  29. package/dist-types/commands/CreateUserProfileCommand.d.ts +6 -6
  30. package/dist-types/commands/DeleteOptimizationJobCommand.d.ts +61 -0
  31. package/dist-types/commands/DeleteStudioLifecycleConfigCommand.d.ts +4 -1
  32. package/dist-types/commands/DeleteUserProfileCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeDomainCommand.d.ts +4 -0
  34. package/dist-types/commands/DescribeModelCardExportJobCommand.d.ts +2 -1
  35. package/dist-types/commands/DescribeModelCommand.d.ts +22 -0
  36. package/dist-types/commands/DescribeModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  37. package/dist-types/commands/DescribeModelPackageCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeModelPackageGroupCommand.d.ts +1 -1
  39. package/dist-types/commands/DescribeModelQualityJobDefinitionCommand.d.ts +1 -1
  40. package/dist-types/commands/DescribeMonitoringScheduleCommand.d.ts +1 -2
  41. package/dist-types/commands/DescribeOptimizationJobCommand.d.ts +119 -0
  42. package/dist-types/commands/ListModelMetadataCommand.d.ts +1 -1
  43. package/dist-types/commands/ListModelPackageGroupsCommand.d.ts +1 -1
  44. package/dist-types/commands/ListModelPackagesCommand.d.ts +1 -1
  45. package/dist-types/commands/ListModelQualityJobDefinitionsCommand.d.ts +1 -1
  46. package/dist-types/commands/ListModelsCommand.d.ts +1 -2
  47. package/dist-types/commands/ListOptimizationJobsCommand.d.ts +85 -0
  48. package/dist-types/commands/ListStudioLifecycleConfigsCommand.d.ts +2 -1
  49. package/dist-types/commands/SearchCommand.d.ts +32 -0
  50. package/dist-types/commands/StopOptimizationJobCommand.d.ts +61 -0
  51. package/dist-types/commands/UpdateDomainCommand.d.ts +4 -0
  52. package/dist-types/commands/index.d.ts +5 -0
  53. package/dist-types/models/models_0.d.ts +69 -61
  54. package/dist-types/models/models_1.d.ts +421 -442
  55. package/dist-types/models/models_2.d.ts +436 -556
  56. package/dist-types/models/models_3.d.ts +5535 -5371
  57. package/dist-types/models/models_4.d.ts +740 -38
  58. package/dist-types/pagination/ListOptimizationJobsPaginator.d.ts +7 -0
  59. package/dist-types/pagination/index.d.ts +1 -0
  60. package/dist-types/protocols/Aws_json1_1.d.ts +45 -0
  61. package/dist-types/ts3.4/SageMaker.d.ts +86 -0
  62. package/dist-types/ts3.4/SageMakerClient.d.ts +30 -0
  63. package/dist-types/ts3.4/commands/CreateClusterCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/CreateCodeRepositoryCommand.d.ts +4 -2
  65. package/dist-types/ts3.4/commands/CreateOptimizationJobCommand.d.ts +40 -0
  66. package/dist-types/ts3.4/commands/CreateProcessingJobCommand.d.ts +1 -1
  67. package/dist-types/ts3.4/commands/DeleteOptimizationJobCommand.d.ts +35 -0
  68. package/dist-types/ts3.4/commands/DescribeModelCardExportJobCommand.d.ts +2 -4
  69. package/dist-types/ts3.4/commands/DescribeModelExplainabilityJobDefinitionCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/DescribeModelPackageCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/DescribeModelPackageGroupCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/DescribeModelQualityJobDefinitionCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/DescribeMonitoringScheduleCommand.d.ts +4 -2
  74. package/dist-types/ts3.4/commands/DescribeOptimizationJobCommand.d.ts +40 -0
  75. package/dist-types/ts3.4/commands/ListModelMetadataCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListModelPackageGroupsCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/ListModelPackagesCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/ListModelQualityJobDefinitionsCommand.d.ts +1 -1
  79. package/dist-types/ts3.4/commands/ListModelsCommand.d.ts +1 -2
  80. package/dist-types/ts3.4/commands/ListOptimizationJobsCommand.d.ts +40 -0
  81. package/dist-types/ts3.4/commands/StopOptimizationJobCommand.d.ts +35 -0
  82. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  83. package/dist-types/ts3.4/models/models_0.d.ts +14 -13
  84. package/dist-types/ts3.4/models/models_1.d.ts +109 -71
  85. package/dist-types/ts3.4/models/models_2.d.ts +81 -142
  86. package/dist-types/ts3.4/models/models_3.d.ts +192 -125
  87. package/dist-types/ts3.4/models/models_4.d.ts +170 -9
  88. package/dist-types/ts3.4/pagination/ListOptimizationJobsPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  90. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +60 -0
  91. package/package.json +36 -36
@@ -1,5 +1,39 @@
1
1
  import { LazyJsonString as __LazyJsonString } from "@smithy/smithy-client";
2
- import { AdditionalInferenceSpecificationDefinition, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppSpecification, AppType, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, CustomImage, FeatureStatus, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDataSource, OutputDataConfig, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TargetDevice, TargetPlatformAccelerator, TargetPlatformArch, TargetPlatformOs, TrainingInputMode, TrainingInstanceType, TransformJobDefinition, VpcConfig } from "./models_0";
2
+ import { AdditionalInferenceSpecificationDefinition, AmazonQSettings, AnnotationConsolidationConfig, AppNetworkAccessType, AppSecurityGroupManagement, AppType, AsyncInferenceConfig, AthenaDatasetDefinition, AuthMode, AutoParameter, AutoRollbackConfig, Autotune, AwsManagedHumanLoopRequestSource, BatchTransformInput, BestObjectiveNotImproving, Bias, BlueGreenUpdatePolicy, CanvasAppSettings, CapacitySize, CaptureContentTypeHeader, CaptureOption, CategoricalParameter, CategoricalParameterRange, Channel, CheckpointConfig, ClarifyExplainerConfig, CodeEditorAppSettings, CodeRepository, CollectionConfig, CollectionType, ContainerDefinition, ContentClassifier, ContextSource, ContinuousParameterRange, ConvergenceDetected, CustomImage, FeatureStatus, GitConfig, HyperParameterScalingType, HyperParameterTuningJobObjective, InferenceSpecification, MetadataProperties, MetricDefinition, MetricsSource, ModelApprovalStatus, ModelDataSource, OutputDataConfig, ProcessingS3DataDistributionType, ProcessingS3InputMode, ProductionVariantInstanceType, ResourceConfig, ResourceSpec, StoppingCondition, Tag, TargetDevice, TargetPlatformAccelerator, TargetPlatformArch, TargetPlatformOs, TrainingInputMode, TrainingInstanceType, TransformJobDefinition, VpcConfig } from "./models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface CreateClusterResponse {
7
+ /**
8
+ * <p>The Amazon Resource Name (ARN) of the cluster.</p>
9
+ * @public
10
+ */
11
+ ClusterArn: string | undefined;
12
+ }
13
+ /**
14
+ * @public
15
+ */
16
+ export interface CreateCodeRepositoryInput {
17
+ /**
18
+ * <p>The name of the Git repository. The name must have 1 to 63 characters. Valid
19
+ * characters are a-z, A-Z, 0-9, and - (hyphen).</p>
20
+ * @public
21
+ */
22
+ CodeRepositoryName: string | undefined;
23
+ /**
24
+ * <p>Specifies details about the repository, including the URL where the repository is
25
+ * located, the default branch, and credentials to use to access the repository.</p>
26
+ * @public
27
+ */
28
+ GitConfig: GitConfig | undefined;
29
+ /**
30
+ * <p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services
31
+ * resources in different ways, for example, by purpose, owner, or environment. For more
32
+ * information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>
33
+ * @public
34
+ */
35
+ Tags?: Tag[];
36
+ }
3
37
  /**
4
38
  * @public
5
39
  */
@@ -1578,20 +1612,25 @@ export interface JupyterLabAppSettings {
1578
1612
  */
1579
1613
  export interface JupyterServerAppSettings {
1580
1614
  /**
1581
- * <p>The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the <code>LifecycleConfigArns</code> parameter, then this parameter is also required.</p>
1615
+ * <p>The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the
1616
+ * <code>LifecycleConfigArns</code> parameter, then this parameter is also required.</p>
1582
1617
  * @public
1583
1618
  */
1584
1619
  DefaultResourceSpec?: ResourceSpec;
1585
1620
  /**
1586
- * <p> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the <code>DefaultResourceSpec</code> parameter is also required.</p>
1621
+ * <p> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the
1622
+ * JupyterServerApp. If you use this parameter, the <code>DefaultResourceSpec</code> parameter is
1623
+ * also required.</p>
1587
1624
  * <note>
1588
- * <p>To remove a Lifecycle Config, you must set <code>LifecycleConfigArns</code> to an empty list.</p>
1625
+ * <p>To remove a Lifecycle Config, you must set <code>LifecycleConfigArns</code> to an empty
1626
+ * list.</p>
1589
1627
  * </note>
1590
1628
  * @public
1591
1629
  */
1592
1630
  LifecycleConfigArns?: string[];
1593
1631
  /**
1594
- * <p>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.</p>
1632
+ * <p>A list of Git repositories that SageMaker automatically displays to users for
1633
+ * cloning in the JupyterServer application.</p>
1595
1634
  * @public
1596
1635
  */
1597
1636
  CodeRepositories?: CodeRepository[];
@@ -1604,22 +1643,25 @@ export interface KernelGatewayAppSettings {
1604
1643
  /**
1605
1644
  * <p>The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.</p>
1606
1645
  * <note>
1607
- * <p>The Amazon SageMaker Studio UI does not use the default instance type value set here. The
1608
- * default instance type set here is used when Apps are created using the CLI or
1609
- * CloudFormation and the instance type parameter value is not passed.</p>
1646
+ * <p>The Amazon SageMaker Studio UI does not use the default instance type value set
1647
+ * here. The default instance type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is not
1648
+ * passed.</p>
1610
1649
  * </note>
1611
1650
  * @public
1612
1651
  */
1613
1652
  DefaultResourceSpec?: ResourceSpec;
1614
1653
  /**
1615
- * <p>A list of custom SageMaker images that are configured to run as a KernelGateway app.</p>
1654
+ * <p>A list of custom SageMaker images that are configured to run as a KernelGateway
1655
+ * app.</p>
1616
1656
  * @public
1617
1657
  */
1618
1658
  CustomImages?: CustomImage[];
1619
1659
  /**
1620
- * <p> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.</p>
1660
+ * <p> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user
1661
+ * profile or domain.</p>
1621
1662
  * <note>
1622
- * <p>To remove a Lifecycle Config, you must set <code>LifecycleConfigArns</code> to an empty list.</p>
1663
+ * <p>To remove a Lifecycle Config, you must set <code>LifecycleConfigArns</code> to an empty
1664
+ * list.</p>
1623
1665
  * </note>
1624
1666
  * @public
1625
1667
  */
@@ -1663,7 +1705,8 @@ export interface DefaultSpaceSettings {
1663
1705
  */
1664
1706
  ExecutionRole?: string;
1665
1707
  /**
1666
- * <p>The security group IDs for the Amazon VPC that the space uses for communication.</p>
1708
+ * <p>The security group IDs for the Amazon VPC that the space uses for
1709
+ * communication.</p>
1667
1710
  * @public
1668
1711
  */
1669
1712
  SecurityGroups?: string[];
@@ -1693,7 +1736,8 @@ export interface DefaultSpaceSettings {
1693
1736
  */
1694
1737
  CustomPosixUserConfig?: CustomPosixUserConfig;
1695
1738
  /**
1696
- * <p>The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.</p>
1739
+ * <p>The settings for assigning a custom file system to a domain. Permitted users can access
1740
+ * this file system in Amazon SageMaker Studio.</p>
1697
1741
  * @public
1698
1742
  */
1699
1743
  CustomFileSystemConfigs?: CustomFileSystemConfig[];
@@ -1710,7 +1754,8 @@ export interface RSessionAppSettings {
1710
1754
  */
1711
1755
  DefaultResourceSpec?: ResourceSpec;
1712
1756
  /**
1713
- * <p>A list of custom SageMaker images that are configured to run as a RSession app.</p>
1757
+ * <p>A list of custom SageMaker images that are configured to run as a RSession
1758
+ * app.</p>
1714
1759
  * @public
1715
1760
  */
1716
1761
  CustomImages?: CustomImage[];
@@ -1741,7 +1786,7 @@ export declare const RStudioServerProUserGroup: {
1741
1786
  export type RStudioServerProUserGroup = (typeof RStudioServerProUserGroup)[keyof typeof RStudioServerProUserGroup];
1742
1787
  /**
1743
1788
  * <p>A collection of settings that configure user interaction with the
1744
- * <code>RStudioServerPro</code> app.</p>
1789
+ * <code>RStudioServerPro</code> app.</p>
1745
1790
  * @public
1746
1791
  */
1747
1792
  export interface RStudioServerProAppSettings {
@@ -1752,9 +1797,9 @@ export interface RStudioServerProAppSettings {
1752
1797
  */
1753
1798
  AccessStatus?: RStudioServerProAccessStatus;
1754
1799
  /**
1755
- * <p>The level of permissions that the user has within the <code>RStudioServerPro</code>
1756
- * app. This value defaults to `User`. The `Admin` value allows the user access to the
1757
- * RStudio Administrative Dashboard.</p>
1800
+ * <p>The level of permissions that the user has within the <code>RStudioServerPro</code> app.
1801
+ * This value defaults to `User`. The `Admin` value allows the user access to the RStudio
1802
+ * Administrative Dashboard.</p>
1758
1803
  * @public
1759
1804
  */
1760
1805
  UserGroup?: RStudioServerProUserGroup;
@@ -1773,28 +1818,29 @@ export declare const NotebookOutputOption: {
1773
1818
  export type NotebookOutputOption = (typeof NotebookOutputOption)[keyof typeof NotebookOutputOption];
1774
1819
  /**
1775
1820
  * <p>Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are
1776
- * specified as part of <code>DefaultUserSettings</code> when the <code>CreateDomain</code>
1777
- * API is called, and as part of <code>UserSettings</code> when the <code>CreateUserProfile</code>
1778
- * API is called. When <code>SharingSettings</code> is not specified, notebook sharing
1779
- * isn't allowed.</p>
1821
+ * specified as part of <code>DefaultUserSettings</code> when the <code>CreateDomain</code> API
1822
+ * is called, and as part of <code>UserSettings</code> when the <code>CreateUserProfile</code>
1823
+ * API is called. When <code>SharingSettings</code> is not specified, notebook sharing isn't
1824
+ * allowed.</p>
1780
1825
  * @public
1781
1826
  */
1782
1827
  export interface SharingSettings {
1783
1828
  /**
1784
- * <p>Whether to include the notebook cell output when sharing the notebook. The default
1785
- * is <code>Disabled</code>.</p>
1829
+ * <p>Whether to include the notebook cell output when sharing the notebook. The default is
1830
+ * <code>Disabled</code>.</p>
1786
1831
  * @public
1787
1832
  */
1788
1833
  NotebookOutputOption?: NotebookOutputOption;
1789
1834
  /**
1790
- * <p>When <code>NotebookOutputOption</code> is <code>Allowed</code>, the Amazon S3 bucket used
1791
- * to store the shared notebook snapshots.</p>
1835
+ * <p>When <code>NotebookOutputOption</code> is <code>Allowed</code>, the Amazon S3
1836
+ * bucket used to store the shared notebook snapshots.</p>
1792
1837
  * @public
1793
1838
  */
1794
1839
  S3OutputPath?: string;
1795
1840
  /**
1796
- * <p>When <code>NotebookOutputOption</code> is <code>Allowed</code>, the Amazon Web Services Key Management Service (KMS)
1797
- * encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.</p>
1841
+ * <p>When <code>NotebookOutputOption</code> is <code>Allowed</code>, the Amazon Web Services Key
1842
+ * Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the
1843
+ * Amazon S3 bucket.</p>
1798
1844
  * @public
1799
1845
  */
1800
1846
  S3KmsKeyId?: string;
@@ -1835,7 +1881,8 @@ export declare const MlTools: {
1835
1881
  */
1836
1882
  export type MlTools = (typeof MlTools)[keyof typeof MlTools];
1837
1883
  /**
1838
- * <p>Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.</p>
1884
+ * <p>Studio settings. If these settings are applied on a user level, they take priority over
1885
+ * the settings applied on a domain level.</p>
1839
1886
  * @public
1840
1887
  */
1841
1888
  export interface StudioWebPortalSettings {
@@ -1845,7 +1892,8 @@ export interface StudioWebPortalSettings {
1845
1892
  */
1846
1893
  HiddenMlTools?: MlTools[];
1847
1894
  /**
1848
- * <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html">Applications supported in Studio</a> that are hidden from the Studio left navigation pane.</p>
1895
+ * <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-apps.html">Applications supported in Studio</a> that are hidden from the Studio left navigation
1896
+ * pane.</p>
1849
1897
  * @public
1850
1898
  */
1851
1899
  HiddenAppTypes?: AppType[];
@@ -1856,14 +1904,15 @@ export interface StudioWebPortalSettings {
1856
1904
  */
1857
1905
  export interface TensorBoardAppSettings {
1858
1906
  /**
1859
- * <p>The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.</p>
1907
+ * <p>The default instance type and the Amazon Resource Name (ARN) of the SageMaker
1908
+ * image created on the instance.</p>
1860
1909
  * @public
1861
1910
  */
1862
1911
  DefaultResourceSpec?: ResourceSpec;
1863
1912
  }
1864
1913
  /**
1865
- * <p>A collection of settings that apply to users in a domain. These settings are
1866
- * specified when the <code>CreateUserProfile</code> API is called, and as <code>DefaultUserSettings</code>
1914
+ * <p>A collection of settings that apply to users in a domain. These settings are specified
1915
+ * when the <code>CreateUserProfile</code> API is called, and as <code>DefaultUserSettings</code>
1867
1916
  * when the <code>CreateDomain</code> API is called.</p>
1868
1917
  * <p>
1869
1918
  * <code>SecurityGroups</code> is aggregated when specified in both calls. For all other
@@ -1878,13 +1927,15 @@ export interface UserSettings {
1878
1927
  */
1879
1928
  ExecutionRole?: string;
1880
1929
  /**
1881
- * <p>The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</p>
1930
+ * <p>The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for
1931
+ * communication.</p>
1882
1932
  * <p>Optional when the <code>CreateDomain.AppNetworkAccessType</code> parameter is set to
1883
- * <code>PublicInternetOnly</code>.</p>
1933
+ * <code>PublicInternetOnly</code>.</p>
1884
1934
  * <p>Required when the <code>CreateDomain.AppNetworkAccessType</code> parameter is set to
1885
- * <code>VpcOnly</code>, unless specified as part of the <code>DefaultUserSettings</code> for the domain.</p>
1886
- * <p>Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the
1887
- * number of security groups that you can specify is one less than the maximum number shown.</p>
1935
+ * <code>VpcOnly</code>, unless specified as part of the <code>DefaultUserSettings</code> for
1936
+ * the domain.</p>
1937
+ * <p>Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the
1938
+ * maximum number shown.</p>
1888
1939
  * @public
1889
1940
  */
1890
1941
  SecurityGroups?: string[];
@@ -1910,7 +1961,7 @@ export interface UserSettings {
1910
1961
  TensorBoardAppSettings?: TensorBoardAppSettings;
1911
1962
  /**
1912
1963
  * <p>A collection of settings that configure user interaction with the
1913
- * <code>RStudioServerPro</code> app.</p>
1964
+ * <code>RStudioServerPro</code> app.</p>
1914
1965
  * @public
1915
1966
  */
1916
1967
  RStudioServerProAppSettings?: RStudioServerProAppSettings;
@@ -1940,22 +1991,26 @@ export interface UserSettings {
1940
1991
  */
1941
1992
  SpaceStorageSettings?: DefaultSpaceStorageSettings;
1942
1993
  /**
1943
- * <p>The default experience that the user is directed to when accessing the domain. The supported values are:</p>
1994
+ * <p>The default experience that the user is directed to when accessing the domain. The
1995
+ * supported values are:</p>
1944
1996
  * <ul>
1945
1997
  * <li>
1946
1998
  * <p>
1947
- * <code>studio::</code>: Indicates that Studio is the default experience. This value can only be passed if <code>StudioWebPortal</code> is set to <code>ENABLED</code>.</p>
1999
+ * <code>studio::</code>: Indicates that Studio is the default experience. This value can
2000
+ * only be passed if <code>StudioWebPortal</code> is set to <code>ENABLED</code>.</p>
1948
2001
  * </li>
1949
2002
  * <li>
1950
2003
  * <p>
1951
- * <code>app:JupyterServer:</code>: Indicates that Studio Classic is the default experience.</p>
2004
+ * <code>app:JupyterServer:</code>: Indicates that Studio Classic is the default
2005
+ * experience.</p>
1952
2006
  * </li>
1953
2007
  * </ul>
1954
2008
  * @public
1955
2009
  */
1956
2010
  DefaultLandingUri?: string;
1957
2011
  /**
1958
- * <p>Whether the user can access Studio. If this value is set to <code>DISABLED</code>, the user cannot access Studio, even if that is the default experience for the domain.</p>
2012
+ * <p>Whether the user can access Studio. If this value is set to <code>DISABLED</code>, the
2013
+ * user cannot access Studio, even if that is the default experience for the domain.</p>
1959
2014
  * @public
1960
2015
  */
1961
2016
  StudioWebPortal?: StudioWebPortal;
@@ -1971,7 +2026,8 @@ export interface UserSettings {
1971
2026
  */
1972
2027
  CustomFileSystemConfigs?: CustomFileSystemConfig[];
1973
2028
  /**
1974
- * <p>Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.</p>
2029
+ * <p>Studio settings. If these settings are applied on a user level, they take priority over
2030
+ * the settings applied on a domain level.</p>
1975
2031
  * @public
1976
2032
  */
1977
2033
  StudioWebPortalSettings?: StudioWebPortalSettings;
@@ -1987,7 +2043,8 @@ export interface DockerSettings {
1987
2043
  */
1988
2044
  EnableDockerAccess?: FeatureStatus;
1989
2045
  /**
1990
- * <p>The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.</p>
2046
+ * <p>The list of Amazon Web Services accounts that are trusted when the domain is created in
2047
+ * VPC-only mode.</p>
1991
2048
  * @public
1992
2049
  */
1993
2050
  VpcOnlyTrustedAccounts?: string[];
@@ -2040,8 +2097,8 @@ export interface RStudioServerProDomainSettings {
2040
2097
  */
2041
2098
  export interface DomainSettings {
2042
2099
  /**
2043
- * <p>The security groups for the Amazon Virtual Private Cloud that the <code>Domain</code> uses for communication
2044
- * between Domain-level apps and user apps.</p>
2100
+ * <p>The security groups for the Amazon Virtual Private Cloud that the <code>Domain</code> uses for
2101
+ * communication between Domain-level apps and user apps.</p>
2045
2102
  * @public
2046
2103
  */
2047
2104
  SecurityGroupIds?: string[];
@@ -2052,7 +2109,8 @@ export interface DomainSettings {
2052
2109
  */
2053
2110
  RStudioServerProDomainSettings?: RStudioServerProDomainSettings;
2054
2111
  /**
2055
- * <p>The configuration for attaching a SageMaker user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>.</p>
2112
+ * <p>The configuration for attaching a SageMaker user profile name to the execution
2113
+ * role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>.</p>
2056
2114
  * @public
2057
2115
  */
2058
2116
  ExecutionRoleIdentityConfig?: ExecutionRoleIdentityConfig;
@@ -2061,6 +2119,12 @@ export interface DomainSettings {
2061
2119
  * @public
2062
2120
  */
2063
2121
  DockerSettings?: DockerSettings;
2122
+ /**
2123
+ * <p>A collection of settings that configure the Amazon Q experience within the domain. The
2124
+ * <code>AuthMode</code> that you use to create the domain must be <code>SSO</code>.</p>
2125
+ * @public
2126
+ */
2127
+ AmazonQSettings?: AmazonQSettings;
2064
2128
  }
2065
2129
  /**
2066
2130
  * @public
@@ -2116,8 +2180,7 @@ export interface CreateDomainRequest {
2116
2180
  * <ul>
2117
2181
  * <li>
2118
2182
  * <p>
2119
- * <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by
2120
- * Amazon SageMaker, which allows direct internet access</p>
2183
+ * <code>PublicInternetOnly</code> - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access</p>
2121
2184
  * </li>
2122
2185
  * <li>
2123
2186
  * <p>
@@ -10840,6 +10903,298 @@ export interface CreateNotebookInstanceLifecycleConfigOutput {
10840
10903
  */
10841
10904
  NotebookInstanceLifecycleConfigArn?: string;
10842
10905
  }
10906
+ /**
10907
+ * @public
10908
+ * @enum
10909
+ */
10910
+ export declare const OptimizationJobDeploymentInstanceType: {
10911
+ readonly ML_G5_12XLARGE: "ml.g5.12xlarge";
10912
+ readonly ML_G5_16XLARGE: "ml.g5.16xlarge";
10913
+ readonly ML_G5_24XLARGE: "ml.g5.24xlarge";
10914
+ readonly ML_G5_2XLARGE: "ml.g5.2xlarge";
10915
+ readonly ML_G5_48XLARGE: "ml.g5.48xlarge";
10916
+ readonly ML_G5_4XLARGE: "ml.g5.4xlarge";
10917
+ readonly ML_G5_8XLARGE: "ml.g5.8xlarge";
10918
+ readonly ML_G5_XLARGE: "ml.g5.xlarge";
10919
+ readonly ML_G6_12XLARGE: "ml.g6.12xlarge";
10920
+ readonly ML_G6_16XLARGE: "ml.g6.16xlarge";
10921
+ readonly ML_G6_24XLARGE: "ml.g6.24xlarge";
10922
+ readonly ML_G6_2XLARGE: "ml.g6.2xlarge";
10923
+ readonly ML_G6_48XLARGE: "ml.g6.48xlarge";
10924
+ readonly ML_G6_4XLARGE: "ml.g6.4xlarge";
10925
+ readonly ML_G6_8XLARGE: "ml.g6.8xlarge";
10926
+ readonly ML_G6_XLARGE: "ml.g6.xlarge";
10927
+ readonly ML_INF2_24XLARGE: "ml.inf2.24xlarge";
10928
+ readonly ML_INF2_48XLARGE: "ml.inf2.48xlarge";
10929
+ readonly ML_INF2_8XLARGE: "ml.inf2.8xlarge";
10930
+ readonly ML_INF2_XLARGE: "ml.inf2.xlarge";
10931
+ readonly ML_P4DE_24XLARGE: "ml.p4de.24xlarge";
10932
+ readonly ML_P4D_24XLARGE: "ml.p4d.24xlarge";
10933
+ readonly ML_P5_48XLARGE: "ml.p5.48xlarge";
10934
+ readonly ML_TRN1N_32XLARGE: "ml.trn1n.32xlarge";
10935
+ readonly ML_TRN1_2XLARGE: "ml.trn1.2xlarge";
10936
+ readonly ML_TRN1_32XLARGE: "ml.trn1.32xlarge";
10937
+ };
10938
+ /**
10939
+ * @public
10940
+ */
10941
+ export type OptimizationJobDeploymentInstanceType = (typeof OptimizationJobDeploymentInstanceType)[keyof typeof OptimizationJobDeploymentInstanceType];
10942
+ /**
10943
+ * <p>The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).</p>
10944
+ * @public
10945
+ */
10946
+ export interface OptimizationModelAccessConfig {
10947
+ /**
10948
+ * <p>Specifies agreement to the model end-user license agreement (EULA). The
10949
+ * <code>AcceptEula</code> value must be explicitly defined as <code>True</code> in order
10950
+ * to accept the EULA that this model requires. You are responsible for reviewing and
10951
+ * complying with any applicable license terms and making sure they are acceptable for your
10952
+ * use case before downloading or using a model.</p>
10953
+ * @public
10954
+ */
10955
+ AcceptEula: boolean | undefined;
10956
+ }
10957
+ /**
10958
+ * <p>The Amazon S3 location of a source model to optimize with an optimization job.</p>
10959
+ * @public
10960
+ */
10961
+ export interface OptimizationJobModelSourceS3 {
10962
+ /**
10963
+ * <p>An Amazon S3 URI that locates a source model to optimize with an optimization job.</p>
10964
+ * @public
10965
+ */
10966
+ S3Uri?: string;
10967
+ /**
10968
+ * <p>The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).</p>
10969
+ * @public
10970
+ */
10971
+ ModelAccessConfig?: OptimizationModelAccessConfig;
10972
+ }
10973
+ /**
10974
+ * <p>The location of the source model to optimize with an optimization job.</p>
10975
+ * @public
10976
+ */
10977
+ export interface OptimizationJobModelSource {
10978
+ /**
10979
+ * <p>The Amazon S3 location of a source model to optimize with an optimization job.</p>
10980
+ * @public
10981
+ */
10982
+ S3?: OptimizationJobModelSourceS3;
10983
+ }
10984
+ /**
10985
+ * <p>Settings for the model compilation technique that's applied by a model optimization job.</p>
10986
+ * @public
10987
+ */
10988
+ export interface ModelCompilationConfig {
10989
+ /**
10990
+ * <p>The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.</p>
10991
+ * @public
10992
+ */
10993
+ Image?: string;
10994
+ /**
10995
+ * <p>Environment variables that override the default ones in the model container.</p>
10996
+ * @public
10997
+ */
10998
+ OverrideEnvironment?: Record<string, string>;
10999
+ }
11000
+ /**
11001
+ * <p>Settings for the model quantization technique that's applied by a model optimization job.</p>
11002
+ * @public
11003
+ */
11004
+ export interface ModelQuantizationConfig {
11005
+ /**
11006
+ * <p>The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.</p>
11007
+ * @public
11008
+ */
11009
+ Image?: string;
11010
+ /**
11011
+ * <p>Environment variables that override the default ones in the model container.</p>
11012
+ * @public
11013
+ */
11014
+ OverrideEnvironment?: Record<string, string>;
11015
+ }
11016
+ /**
11017
+ * <p>Settings for an optimization technique that you apply with a model optimization
11018
+ * job.</p>
11019
+ * @public
11020
+ */
11021
+ export type OptimizationConfig = OptimizationConfig.ModelCompilationConfigMember | OptimizationConfig.ModelQuantizationConfigMember | OptimizationConfig.$UnknownMember;
11022
+ /**
11023
+ * @public
11024
+ */
11025
+ export declare namespace OptimizationConfig {
11026
+ /**
11027
+ * <p>Settings for the model quantization technique that's applied by a model optimization job.</p>
11028
+ * @public
11029
+ */
11030
+ interface ModelQuantizationConfigMember {
11031
+ ModelQuantizationConfig: ModelQuantizationConfig;
11032
+ ModelCompilationConfig?: never;
11033
+ $unknown?: never;
11034
+ }
11035
+ /**
11036
+ * <p>Settings for the model compilation technique that's applied by a model optimization job.</p>
11037
+ * @public
11038
+ */
11039
+ interface ModelCompilationConfigMember {
11040
+ ModelQuantizationConfig?: never;
11041
+ ModelCompilationConfig: ModelCompilationConfig;
11042
+ $unknown?: never;
11043
+ }
11044
+ /**
11045
+ * @public
11046
+ */
11047
+ interface $UnknownMember {
11048
+ ModelQuantizationConfig?: never;
11049
+ ModelCompilationConfig?: never;
11050
+ $unknown: [string, any];
11051
+ }
11052
+ interface Visitor<T> {
11053
+ ModelQuantizationConfig: (value: ModelQuantizationConfig) => T;
11054
+ ModelCompilationConfig: (value: ModelCompilationConfig) => T;
11055
+ _: (name: string, value: any) => T;
11056
+ }
11057
+ const visit: <T>(value: OptimizationConfig, visitor: Visitor<T>) => T;
11058
+ }
11059
+ /**
11060
+ * <p>Details for where to store the optimized model that you create with the optimization job.</p>
11061
+ * @public
11062
+ */
11063
+ export interface OptimizationJobOutputConfig {
11064
+ /**
11065
+ * <p>The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the
11066
+ * optimized model when SageMaker uploads the model to Amazon S3.</p>
11067
+ * @public
11068
+ */
11069
+ KmsKeyId?: string;
11070
+ /**
11071
+ * <p>The Amazon S3 URI for where to store the optimized model that you create with an optimization
11072
+ * job.</p>
11073
+ * @public
11074
+ */
11075
+ S3OutputLocation: string | undefined;
11076
+ }
11077
+ /**
11078
+ * <p>A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization
11079
+ * job. You can control access to and from your resources by configuring a VPC. For more
11080
+ * information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>. </p>
11081
+ * @public
11082
+ */
11083
+ export interface OptimizationVpcConfig {
11084
+ /**
11085
+ * <p>The VPC security group IDs, in the form <code>sg-xxxxxxxx</code>. Specify the security
11086
+ * groups for the VPC that is specified in the <code>Subnets</code> field.</p>
11087
+ * @public
11088
+ */
11089
+ SecurityGroupIds: string[] | undefined;
11090
+ /**
11091
+ * <p>The ID of the subnets in the VPC to which you want to connect your optimized
11092
+ * model.</p>
11093
+ * @public
11094
+ */
11095
+ Subnets: string[] | undefined;
11096
+ }
11097
+ /**
11098
+ * @public
11099
+ */
11100
+ export interface CreateOptimizationJobRequest {
11101
+ /**
11102
+ * <p>A custom name for the new optimization job.</p>
11103
+ * @public
11104
+ */
11105
+ OptimizationJobName: string | undefined;
11106
+ /**
11107
+ * <p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. </p>
11108
+ * <p>During model optimization, Amazon SageMaker needs your permission to:</p>
11109
+ * <ul>
11110
+ * <li>
11111
+ * <p>Read input data from an S3 bucket</p>
11112
+ * </li>
11113
+ * <li>
11114
+ * <p>Write model artifacts to an S3 bucket</p>
11115
+ * </li>
11116
+ * <li>
11117
+ * <p>Write logs to Amazon CloudWatch Logs</p>
11118
+ * </li>
11119
+ * <li>
11120
+ * <p>Publish metrics to Amazon CloudWatch</p>
11121
+ * </li>
11122
+ * </ul>
11123
+ * <p>You grant permissions for all of these tasks to an IAM role. To pass this
11124
+ * role to Amazon SageMaker, the caller of this API must have the
11125
+ * <code>iam:PassRole</code> permission. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles.</a>
11126
+ * </p>
11127
+ * @public
11128
+ */
11129
+ RoleArn: string | undefined;
11130
+ /**
11131
+ * <p>The location of the source model to optimize with an optimization job.</p>
11132
+ * @public
11133
+ */
11134
+ ModelSource: OptimizationJobModelSource | undefined;
11135
+ /**
11136
+ * <p>The type of instance that hosts the optimized model that you create with the optimization job.</p>
11137
+ * @public
11138
+ */
11139
+ DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined;
11140
+ /**
11141
+ * <p>The environment variables to set in the model container.</p>
11142
+ * @public
11143
+ */
11144
+ OptimizationEnvironment?: Record<string, string>;
11145
+ /**
11146
+ * <p>Settings for each of the optimization techniques that the job applies.</p>
11147
+ * @public
11148
+ */
11149
+ OptimizationConfigs: OptimizationConfig[] | undefined;
11150
+ /**
11151
+ * <p>Details for where to store the optimized model that you create with the optimization job.</p>
11152
+ * @public
11153
+ */
11154
+ OutputConfig: OptimizationJobOutputConfig | undefined;
11155
+ /**
11156
+ * <p>Specifies a limit to how long a job can run. When the job reaches the time limit, SageMaker
11157
+ * ends the job. Use this API to cap costs.</p>
11158
+ * <p>To stop a training job, SageMaker sends the algorithm the <code>SIGTERM</code> signal,
11159
+ * which delays job termination for 120 seconds. Algorithms can use this 120-second window
11160
+ * to save the model artifacts, so the results of training are not lost. </p>
11161
+ * <p>The training algorithms provided by SageMaker automatically save the intermediate results
11162
+ * of a model training job when possible. This attempt to save artifacts is only a best
11163
+ * effort case as model might not be in a state from which it can be saved. For example, if
11164
+ * training has just started, the model might not be ready to save. When saved, this
11165
+ * intermediate data is a valid model artifact. You can use it to create a model with
11166
+ * <code>CreateModel</code>.</p>
11167
+ * <note>
11168
+ * <p>The Neural Topic Model (NTM) currently does not support saving intermediate model
11169
+ * artifacts. When training NTMs, make sure that the maximum runtime is sufficient for
11170
+ * the training job to complete.</p>
11171
+ * </note>
11172
+ * @public
11173
+ */
11174
+ StoppingCondition: StoppingCondition | undefined;
11175
+ /**
11176
+ * <p>A list of key-value pairs associated with the optimization job. For more information,
11177
+ * see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference
11178
+ * Guide</i>.</p>
11179
+ * @public
11180
+ */
11181
+ Tags?: Tag[];
11182
+ /**
11183
+ * <p>A VPC in Amazon VPC that your optimized model has access to.</p>
11184
+ * @public
11185
+ */
11186
+ VpcConfig?: OptimizationVpcConfig;
11187
+ }
11188
+ /**
11189
+ * @public
11190
+ */
11191
+ export interface CreateOptimizationJobResponse {
11192
+ /**
11193
+ * <p>The Amazon Resource Name (ARN) of the optimization job.</p>
11194
+ * @public
11195
+ */
11196
+ OptimizationJobArn: string | undefined;
11197
+ }
10843
11198
  /**
10844
11199
  * <p>Configuration that controls the parallelism of the pipeline.
10845
11200
  * By default, the parallelism configuration specified applies to all
@@ -10960,8 +11315,7 @@ export interface CreatePresignedDomainUrlRequest {
10960
11315
  */
10961
11316
  SessionExpirationDurationInSeconds?: number;
10962
11317
  /**
10963
- * <p>The number of seconds until the pre-signed URL expires. This value defaults to
10964
- * 300.</p>
11318
+ * <p>The number of seconds until the pre-signed URL expires. This value defaults to 300.</p>
10965
11319
  * @public
10966
11320
  */
10967
11321
  ExpiresInSeconds?: number;
@@ -10971,31 +11325,39 @@ export interface CreatePresignedDomainUrlRequest {
10971
11325
  */
10972
11326
  SpaceName?: string;
10973
11327
  /**
10974
- * <p>The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:</p>
11328
+ * <p>The landing page that the user is directed to when accessing the presigned URL. Using this
11329
+ * value, users can access Studio or Studio Classic, even if it is not the default experience for
11330
+ * the domain. The supported values are:</p>
10975
11331
  * <ul>
10976
11332
  * <li>
10977
11333
  * <p>
10978
- * <code>studio::relative/path</code>: Directs users to the relative path in Studio.</p>
11334
+ * <code>studio::relative/path</code>: Directs users to the relative path in
11335
+ * Studio.</p>
10979
11336
  * </li>
10980
11337
  * <li>
10981
11338
  * <p>
10982
- * <code>app:JupyterServer:relative/path</code>: Directs users to the relative path in the Studio Classic application.</p>
11339
+ * <code>app:JupyterServer:relative/path</code>: Directs users to the relative path in
11340
+ * the Studio Classic application.</p>
10983
11341
  * </li>
10984
11342
  * <li>
10985
11343
  * <p>
10986
- * <code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the JupyterLab application.</p>
11344
+ * <code>app:JupyterLab:relative/path</code>: Directs users to the relative path in the
11345
+ * JupyterLab application.</p>
10987
11346
  * </li>
10988
11347
  * <li>
10989
11348
  * <p>
10990
- * <code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in the RStudio application.</p>
11349
+ * <code>app:RStudioServerPro:relative/path</code>: Directs users to the relative path in
11350
+ * the RStudio application.</p>
10991
11351
  * </li>
10992
11352
  * <li>
10993
11353
  * <p>
10994
- * <code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p>
11354
+ * <code>app:CodeEditor:relative/path</code>: Directs users to the relative path in the
11355
+ * Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</p>
10995
11356
  * </li>
10996
11357
  * <li>
10997
11358
  * <p>
10998
- * <code>app:Canvas:relative/path</code>: Directs users to the relative path in the Canvas application.</p>
11359
+ * <code>app:Canvas:relative/path</code>: Directs users to the relative path in the
11360
+ * Canvas application.</p>
10999
11361
  * </li>
11000
11362
  * </ul>
11001
11363
  * @public
@@ -11281,389 +11643,6 @@ export declare const ProcessingS3DataType: {
11281
11643
  * @public
11282
11644
  */
11283
11645
  export type ProcessingS3DataType = (typeof ProcessingS3DataType)[keyof typeof ProcessingS3DataType];
11284
- /**
11285
- * <p>Configuration for downloading input data from Amazon S3 into the processing container.</p>
11286
- * @public
11287
- */
11288
- export interface ProcessingS3Input {
11289
- /**
11290
- * <p>The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.</p>
11291
- * @public
11292
- */
11293
- S3Uri: string | undefined;
11294
- /**
11295
- * <p>The local path in your container where you want Amazon SageMaker to write input data to.
11296
- * <code>LocalPath</code> is an absolute path to the input data and must begin with
11297
- * <code>/opt/ml/processing/</code>. <code>LocalPath</code> is a required
11298
- * parameter when <code>AppManaged</code> is <code>False</code> (default).</p>
11299
- * @public
11300
- */
11301
- LocalPath?: string;
11302
- /**
11303
- * <p>Whether you use an <code>S3Prefix</code> or a <code>ManifestFile</code> for
11304
- * the data type. If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key
11305
- * name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing
11306
- * job. If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object
11307
- * that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for
11308
- * the processing job.</p>
11309
- * @public
11310
- */
11311
- S3DataType: ProcessingS3DataType | undefined;
11312
- /**
11313
- * <p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In File mode, Amazon SageMaker copies the data
11314
- * from the input source onto the local ML storage volume before starting your processing
11315
- * container. This is the most commonly used input mode. In <code>Pipe</code> mode, Amazon SageMaker
11316
- * streams input data from the source directly to your processing container into named
11317
- * pipes without using the ML storage volume.</p>
11318
- * @public
11319
- */
11320
- S3InputMode?: ProcessingS3InputMode;
11321
- /**
11322
- * <p>Whether to distribute the data from Amazon S3 to all processing instances with
11323
- * <code>FullyReplicated</code>, or whether the data from Amazon S3 is shared by Amazon S3 key,
11324
- * downloading one shard of data to each processing instance.</p>
11325
- * @public
11326
- */
11327
- S3DataDistributionType?: ProcessingS3DataDistributionType;
11328
- /**
11329
- * <p>Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing
11330
- * container. <code>Gzip</code> can only be used when <code>Pipe</code> mode is
11331
- * specified as the <code>S3InputMode</code>. In <code>Pipe</code> mode, Amazon SageMaker streams input
11332
- * data from the source directly to your container without using the EBS volume.</p>
11333
- * @public
11334
- */
11335
- S3CompressionType?: ProcessingS3CompressionType;
11336
- }
11337
- /**
11338
- * <p>The inputs for a processing job. The processing input must specify exactly one of either
11339
- * <code>S3Input</code> or <code>DatasetDefinition</code> types.</p>
11340
- * @public
11341
- */
11342
- export interface ProcessingInput {
11343
- /**
11344
- * <p>The name for the processing job input.</p>
11345
- * @public
11346
- */
11347
- InputName: string | undefined;
11348
- /**
11349
- * <p>When <code>True</code>, input operations such as data download are managed natively by the
11350
- * processing job application. When <code>False</code> (default), input operations are managed by Amazon SageMaker.</p>
11351
- * @public
11352
- */
11353
- AppManaged?: boolean;
11354
- /**
11355
- * <p>Configuration for downloading input data from Amazon S3 into the processing container.</p>
11356
- * @public
11357
- */
11358
- S3Input?: ProcessingS3Input;
11359
- /**
11360
- * <p>Configuration for a Dataset Definition input. </p>
11361
- * @public
11362
- */
11363
- DatasetDefinition?: DatasetDefinition;
11364
- }
11365
- /**
11366
- * <p>Configuration for processing job outputs in Amazon SageMaker Feature Store.</p>
11367
- * @public
11368
- */
11369
- export interface ProcessingFeatureStoreOutput {
11370
- /**
11371
- * <p>The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your
11372
- * processing script is responsible for putting records into your Feature Store.</p>
11373
- * @public
11374
- */
11375
- FeatureGroupName: string | undefined;
11376
- }
11377
- /**
11378
- * <p>Configuration for uploading output data to Amazon S3 from the processing container.</p>
11379
- * @public
11380
- */
11381
- export interface ProcessingS3Output {
11382
- /**
11383
- * <p>A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of
11384
- * a processing job.</p>
11385
- * @public
11386
- */
11387
- S3Uri: string | undefined;
11388
- /**
11389
- * <p>The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3.
11390
- * <code>LocalPath</code> is an absolute path to a directory containing output files.
11391
- * This directory will be created by the platform and exist when your container's
11392
- * entrypoint is invoked.</p>
11393
- * @public
11394
- */
11395
- LocalPath: string | undefined;
11396
- /**
11397
- * <p>Whether to upload the results of the processing job continuously or after the job
11398
- * completes.</p>
11399
- * @public
11400
- */
11401
- S3UploadMode: ProcessingS3UploadMode | undefined;
11402
- }
11403
- /**
11404
- * <p>Describes the results of a processing job. The processing output must specify exactly one of
11405
- * either <code>S3Output</code> or <code>FeatureStoreOutput</code> types.</p>
11406
- * @public
11407
- */
11408
- export interface ProcessingOutput {
11409
- /**
11410
- * <p>The name for the processing job output.</p>
11411
- * @public
11412
- */
11413
- OutputName: string | undefined;
11414
- /**
11415
- * <p>Configuration for processing job outputs in Amazon S3.</p>
11416
- * @public
11417
- */
11418
- S3Output?: ProcessingS3Output;
11419
- /**
11420
- * <p>Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output
11421
- * type is only supported when <code>AppManaged</code> is specified. </p>
11422
- * @public
11423
- */
11424
- FeatureStoreOutput?: ProcessingFeatureStoreOutput;
11425
- /**
11426
- * <p>When <code>True</code>, output operations such as data upload are managed natively by the
11427
- * processing job application. When <code>False</code> (default), output operations are managed by
11428
- * Amazon SageMaker.</p>
11429
- * @public
11430
- */
11431
- AppManaged?: boolean;
11432
- }
11433
- /**
11434
- * <p>Configuration for uploading output from the processing container.</p>
11435
- * @public
11436
- */
11437
- export interface ProcessingOutputConfig {
11438
- /**
11439
- * <p>An array of outputs configuring the data to upload from the processing container.</p>
11440
- * @public
11441
- */
11442
- Outputs: ProcessingOutput[] | undefined;
11443
- /**
11444
- * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing
11445
- * job output. <code>KmsKeyId</code> can be an ID of a KMS key, ARN of a KMS key, alias of
11446
- * a KMS key, or alias of a KMS key. The <code>KmsKeyId</code> is applied to all
11447
- * outputs.</p>
11448
- * @public
11449
- */
11450
- KmsKeyId?: string;
11451
- }
11452
- /**
11453
- * <p>Configuration for the cluster used to run a processing job.</p>
11454
- * @public
11455
- */
11456
- export interface ProcessingClusterConfig {
11457
- /**
11458
- * <p>The number of ML compute instances to use in the processing job. For distributed
11459
- * processing jobs, specify a value greater than 1. The default value is 1.</p>
11460
- * @public
11461
- */
11462
- InstanceCount: number | undefined;
11463
- /**
11464
- * <p>The ML compute instance type for the processing job.</p>
11465
- * @public
11466
- */
11467
- InstanceType: ProcessingInstanceType | undefined;
11468
- /**
11469
- * <p>The size of the ML storage volume in gigabytes that you want to provision. You must
11470
- * specify sufficient ML storage for your scenario.</p>
11471
- * <note>
11472
- * <p>Certain Nitro-based instances include local storage with a fixed total size,
11473
- * dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts
11474
- * the local instance storage instead of Amazon EBS gp2 storage. You can't request a
11475
- * <code>VolumeSizeInGB</code> greater than the total size of the local instance
11476
- * storage.</p>
11477
- * <p>For a list of instance types that support local instance storage, including the
11478
- * total size per instance type, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p>
11479
- * </note>
11480
- * @public
11481
- */
11482
- VolumeSizeInGB: number | undefined;
11483
- /**
11484
- * <p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the
11485
- * storage volume attached to the ML compute instance(s) that run the processing job.
11486
- * </p>
11487
- * <note>
11488
- * <p>Certain Nitro-based instances include local storage, dependent on the instance
11489
- * type. Local storage volumes are encrypted using a hardware module on the instance.
11490
- * You can't request a <code>VolumeKmsKeyId</code> when using an instance type with
11491
- * local storage.</p>
11492
- * <p>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</p>
11493
- * <p>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD
11494
- * Instance Store Volumes</a>.</p>
11495
- * </note>
11496
- * @public
11497
- */
11498
- VolumeKmsKeyId?: string;
11499
- }
11500
- /**
11501
- * <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
11502
- * processing job. In distributed training, you specify more than one instance.</p>
11503
- * @public
11504
- */
11505
- export interface ProcessingResources {
11506
- /**
11507
- * <p>The configuration for the resources in a cluster used to run the processing
11508
- * job.</p>
11509
- * @public
11510
- */
11511
- ClusterConfig: ProcessingClusterConfig | undefined;
11512
- }
11513
- /**
11514
- * <p>Configures conditions under which the processing job should be stopped, such as how long
11515
- * the processing job has been running. After the condition is met, the processing job is stopped.</p>
11516
- * @public
11517
- */
11518
- export interface ProcessingStoppingCondition {
11519
- /**
11520
- * <p>Specifies the maximum runtime in seconds.</p>
11521
- * @public
11522
- */
11523
- MaxRuntimeInSeconds: number | undefined;
11524
- }
11525
- /**
11526
- * @public
11527
- */
11528
- export interface CreateProcessingJobRequest {
11529
- /**
11530
- * <p>An array of inputs configuring the data to download into the
11531
- * processing container.</p>
11532
- * @public
11533
- */
11534
- ProcessingInputs?: ProcessingInput[];
11535
- /**
11536
- * <p>Output configuration for the processing job.</p>
11537
- * @public
11538
- */
11539
- ProcessingOutputConfig?: ProcessingOutputConfig;
11540
- /**
11541
- * <p> The name of the processing job. The name must be unique within an Amazon Web Services Region in the
11542
- * Amazon Web Services account.</p>
11543
- * @public
11544
- */
11545
- ProcessingJobName: string | undefined;
11546
- /**
11547
- * <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a
11548
- * processing job. In distributed training, you specify more than one instance.</p>
11549
- * @public
11550
- */
11551
- ProcessingResources: ProcessingResources | undefined;
11552
- /**
11553
- * <p>The time limit for how long the processing job is allowed to run.</p>
11554
- * @public
11555
- */
11556
- StoppingCondition?: ProcessingStoppingCondition;
11557
- /**
11558
- * <p>Configures the processing job to run a specified Docker container image.</p>
11559
- * @public
11560
- */
11561
- AppSpecification: AppSpecification | undefined;
11562
- /**
11563
- * <p>The environment variables to set in the Docker container. Up to
11564
- * 100 key and values entries in the map are supported.</p>
11565
- * @public
11566
- */
11567
- Environment?: Record<string, string>;
11568
- /**
11569
- * <p>Networking options for a processing job, such as whether to allow inbound and
11570
- * outbound network calls to and from processing containers, and the VPC subnets and
11571
- * security groups to use for VPC-enabled processing jobs.</p>
11572
- * @public
11573
- */
11574
- NetworkConfig?: NetworkConfig;
11575
- /**
11576
- * <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on
11577
- * your behalf.</p>
11578
- * @public
11579
- */
11580
- RoleArn: string | undefined;
11581
- /**
11582
- * <p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management
11583
- * User Guide</i>.</p>
11584
- * @public
11585
- */
11586
- Tags?: Tag[];
11587
- /**
11588
- * <p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when
11589
- * you call the following APIs:</p>
11590
- * <ul>
11591
- * <li>
11592
- * <p>
11593
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a>
11594
- * </p>
11595
- * </li>
11596
- * <li>
11597
- * <p>
11598
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a>
11599
- * </p>
11600
- * </li>
11601
- * <li>
11602
- * <p>
11603
- * <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a>
11604
- * </p>
11605
- * </li>
11606
- * </ul>
11607
- * @public
11608
- */
11609
- ExperimentConfig?: ExperimentConfig;
11610
- }
11611
- /**
11612
- * @public
11613
- */
11614
- export interface CreateProcessingJobResponse {
11615
- /**
11616
- * <p>The Amazon Resource Name (ARN) of the processing job.</p>
11617
- * @public
11618
- */
11619
- ProcessingJobArn: string | undefined;
11620
- }
11621
- /**
11622
- * <p>A key value pair used when you provision a project as a service catalog product. For
11623
- * information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
11624
- * Catalog</a>.</p>
11625
- * @public
11626
- */
11627
- export interface ProvisioningParameter {
11628
- /**
11629
- * <p>The key that identifies a provisioning parameter.</p>
11630
- * @public
11631
- */
11632
- Key?: string;
11633
- /**
11634
- * <p>The value of the provisioning parameter.</p>
11635
- * @public
11636
- */
11637
- Value?: string;
11638
- }
11639
- /**
11640
- * <p>Details that you specify to provision a service catalog product. For information about
11641
- * service catalog, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html">What is Amazon Web Services Service
11642
- * Catalog</a>.</p>
11643
- * @public
11644
- */
11645
- export interface ServiceCatalogProvisioningDetails {
11646
- /**
11647
- * <p>The ID of the product to provision.</p>
11648
- * @public
11649
- */
11650
- ProductId: string | undefined;
11651
- /**
11652
- * <p>The ID of the provisioning artifact.</p>
11653
- * @public
11654
- */
11655
- ProvisioningArtifactId?: string;
11656
- /**
11657
- * <p>The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. </p>
11658
- * @public
11659
- */
11660
- PathId?: string;
11661
- /**
11662
- * <p>A list of key value pairs that you specify when you provision a product.</p>
11663
- * @public
11664
- */
11665
- ProvisioningParameters?: ProvisioningParameter[];
11666
- }
11667
11646
  /**
11668
11647
  * @internal
11669
11648
  */