The data product item included in the search results.
" } } diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index 29023e09dd0..76702f73e2b 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -1286,7 +1286,7 @@ "ProgressPercent": { "target": "com.amazonaws.fsx#ProgressPercent", "traits": { - "smithy.api#documentation": "The percentage-complete status of a STORAGE_OPTIMIZATION administrative action. Does not apply to any\n other administrative action type.
The percentage-complete status of a STORAGE_OPTIMIZATION \n or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any\n other administrative action type.
The status of the administrative action, as follows:
\n\n FAILED - Amazon FSx failed to process the administrative action\n successfully.
\n IN_PROGRESS - Amazon FSx is processing the administrative action.
\n PENDING - Amazon FSx is waiting to process the administrative\n action.
\n COMPLETED - Amazon FSx has finished processing the administrative\n task.
\n UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx\n has updated the file system with the new storage capacity, and is now performing\n the storage-optimization process.
The status of the administrative action, as follows:
\n\n FAILED - Amazon FSx failed to process the administrative action\n successfully.
\n IN_PROGRESS - Amazon FSx is processing the administrative action.
\n PENDING - Amazon FSx is waiting to process the administrative\n action.
\n COMPLETED - Amazon FSx has finished processing the administrative\n task.
For a backup restore to a second-generation FSx for ONTAP file system, \n indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.
\n\n UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx\n has updated the file system with the new storage capacity, and is now performing\n the storage-optimization process.
\n PENDING - For a backup restore to a second-generation FSx for ONTAP file system, \n indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.
\n IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, \n indicates that all metadata has been downloaded to the new volume and client can access data with read-only access \n while Amazon FSx downloads the file data to the volume. Track the\n progress of this process with the ProgressPercent element.
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a THROUGHPUT_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n THROUGHPUT_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n throughput capacity in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has been completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a IOPS_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When IOPS_OPTIMIZATION\n has been completed successfully, the parent FILE_SYSTEM_UPDATE\n action status changes to COMPLETED. For more information, see\n Managing\n provisioned SSD IOPS in the Amazon FSx for Windows File\n Server User Guide.
\n STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a STORAGE_TYPE_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_TYPE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume\n initiated from the Amazon FSx console, API (UpdateVolume),\n or CLI (update-volume).
\n VOLUME_RESTORE - An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot) or CLI\n (restore-volume-from-snapshot).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
\n VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from\n a snapshot on a different FSx for OpenZFS file system. You can\n initiate this from the Amazon FSx console, API\n (CreateVolume), or CLI (create-volume) when using\n the using the FULL_COPY strategy.
\n VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a\n snapshot on a different FSx for OpenZFS file system. You can initiate\n this from the Amazon FSx console, API\n (CopySnapshotAndUpdateVolume), or CLI\n (copy-snapshot-and-update-volume).
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE - A file system update administrative action\n initiated from the Amazon FSx console, API\n (UpdateFileSystem), or CLI\n (update-file-system).
\n THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a THROUGHPUT_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n THROUGHPUT_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n throughput capacity in the Amazon FSx for Windows\n File Server User Guide.
\n STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's storage capacity has completed\n successfully, a STORAGE_OPTIMIZATION task starts.
For Windows and ONTAP, storage optimization is the process of migrating the file system data\n to newer larger disks.
\nFor Lustre, storage optimization consists of rebalancing the data across the existing and\n newly added file servers.
\nYou can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED. For more information, see Managing\n storage capacity in the Amazon FSx for Windows\n File Server User Guide, Managing storage\n capacity in the Amazon FSx for\n Lustre User Guide, and\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
\n FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain\n Name System (DNS) alias with the file system. For more information, see \n AssociateFileSystemAliases.
\n FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system.\n For more information, see DisassociateFileSystemAliases.
\n IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a IOPS_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When IOPS_OPTIMIZATION\n has been completed successfully, the parent FILE_SYSTEM_UPDATE\n action status changes to COMPLETED. For more information, see\n Managing\n provisioned SSD IOPS in the Amazon FSx for Windows File\n Server User Guide.
\n STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE\n task to increase a file system's throughput capacity has been completed\n successfully, a STORAGE_TYPE_OPTIMIZATION task starts.
You can track the storage-optimization progress using the\n ProgressPercent property. When\n STORAGE_TYPE_OPTIMIZATION has been completed successfully, the\n parent FILE_SYSTEM_UPDATE action status changes to\n COMPLETED.
\n VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume\n initiated from the Amazon FSx console, API (UpdateVolume),\n or CLI (update-volume).
\n VOLUME_RESTORE - An Amazon FSx for OpenZFS volume\n is returned to the state saved by the specified snapshot, initiated from an\n API (RestoreVolumeFromSnapshot) or CLI\n (restore-volume-from-snapshot).
\n SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for\n OpenZFS volume initiated from the Amazon FSx console, API\n (UpdateSnapshot), or CLI (update-snapshot).
\n RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System\n (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
\n DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is\n being restored to a new volume on a second-generation file system. Once the all the file \n metadata is loaded onto the volume, you can mount the volume with read-only access.\n during this process.
\n VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from\n a snapshot on a different FSx for OpenZFS file system. You can\n initiate this from the Amazon FSx console, API\n (CreateVolume), or CLI (create-volume) when using\n the using the FULL_COPY strategy.
\n VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a\n snapshot on a different FSx for OpenZFS file system. You can initiate\n this from the Amazon FSx console, API\n (CopySnapshotAndUpdateVolume), or CLI\n (copy-snapshot-and-update-volume).
The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.
\nAmazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 6.
The value of Aggregates contains aggregates that are not present.
One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
\nThe list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.
\nAmazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.
The value of Aggregates contains aggregates that are not present.
One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
\nSpecifies the FSx for ONTAP file system deployment type to use in creating\n the file system.
\n\n MULTI_AZ_1 - (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability.
\n SINGLE_AZ_1 - A file system configured for Single-AZ\n redundancy.
\n SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing a file system deployment type.
", + "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type to use in creating\n the file system.
\n\n MULTI_AZ_1 - A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability. This is a first-generation FSx for ONTAP file system.
\n MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate \n temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.
\n SINGLE_AZ_1 - A file system configured for Single-AZ\n redundancy. This is a first-generation FSx for ONTAP file system.
\n SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. \n This is a second-generation FSx for ONTAP file system.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing a file system deployment type.
", "smithy.api#required": {} } }, @@ -3306,7 +3312,7 @@ "PreferredSubnetId": { "target": "com.amazonaws.fsx#SubnetId", "traits": { - "smithy.api#documentation": "Required when DeploymentType is set to MULTI_AZ_1. This\n specifies the subnet in which you want the preferred file server to be located.
Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This\n specifies the subnet in which you want the preferred file server to be located.
Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. \n FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair.\n Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. \n The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support \n (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see \n Using block storage protocols.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nYou can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.
This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nYou can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.
This field and ThroughputCapacity are the same for file systems powered by one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n MULTI_AZ_1- Creates file systems with high availability that are configured\n for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs).\n Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon),\n Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.
\n SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia),\n US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland)\n Amazon Web Services Regions.
For more information, see Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", + "smithy.api#documentation": "Specifies the file system deployment type. Valid values are the following:
\n\n MULTI_AZ_1- Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same Amazon Web Services Region.
\n SINGLE_AZ_HA_2- Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.
\n SINGLE_AZ_HA_1- Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache that automatically recover within a single Availability Zone.
\n SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.
For a list of which Amazon Web Services Regions each deployment type is available in, see Deployment type availability.\n For more information on the differences in performance between deployment types, see File system performance\n in the Amazon FSx for OpenZFS User Guide.
", "smithy.api#required": {} } }, @@ -6737,7 +6743,7 @@ "FailureDetails": { "target": "com.amazonaws.fsx#FileCacheFailureDetails", "traits": { - "smithy.api#documentation": "A structure providing details of any failures that occurred.
" + "smithy.api#documentation": "A structure providing details of any failures that occurred in creating a cache.
" } }, "StorageCapacity": { @@ -8422,6 +8428,12 @@ "traits": { "smithy.api#enumValue": "SINGLE_AZ_2" } + }, + "MULTI_AZ_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_AZ_2" + } } } }, @@ -8449,7 +8461,7 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OntapDeploymentType", "traits": { - "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type in use in the file\n system.
\n\n MULTI_AZ_1 - (Default) A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability.
\n SINGLE_AZ_1 - A file system configured for Single-AZ\n redundancy.
\n SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.
" + "smithy.api#documentation": "Specifies the FSx for ONTAP file system deployment type in use in the file\n system.
\n\n MULTI_AZ_1 - A high availability file system configured\n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ)\n unavailability. This is a first-generation FSx for ONTAP file system.
\n MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate \n temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.
\n SINGLE_AZ_1 - A file system configured for Single-AZ\n redundancy. This is a first-generation FSx for ONTAP file system.
\n SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. \n This is a second-generation FSx for ONTAP file system.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to\n Choosing Multi-AZ or\n Single-AZ file system deployment.
" } }, "EndpointIpAddressRange": { @@ -8494,13 +8506,13 @@ "HAPairs": { "target": "com.amazonaws.fsx#HAPairs", "traits": { - "smithy.api#documentation": "Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.
Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.
This field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 MULTI_AZ_1, SINGLE_AZ_1, and SINGLE_AZ_2.
Specifies the file-system deployment type. Amazon FSx for OpenZFS supports\u2028 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
\nThis field and ThroughputCapacity cannot be defined in the same API call, but one is required.
This field and ThroughputCapacity are the same for file systems with one HA pair.
For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.
For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
\nThe value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.
Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system. \n If you increase the number of HA pairs for your file system, you must specify proportional increases for StorageCapacity, \n Iops, and ThroughputCapacity. For more information, see \n High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support \n (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see \n Using block storage protocols.
Container for parameters required for natural language query generation on the specified domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for parameters required to enable all machine learning features.
" + } + }, + "com.amazonaws.opensearch#AIMLOptionsOutput": { + "type": "structure", + "members": { + "NaturalLanguageQueryGenerationOptions": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput", + "traits": { + "smithy.api#documentation": "Container for parameters required for natural language query generation on the specified domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for parameters representing the state of machine learning features on the specified domain.
" + } + }, + "com.amazonaws.opensearch#AIMLOptionsStatus": { + "type": "structure", + "members": { + "Options": { + "target": "com.amazonaws.opensearch#AIMLOptionsOutput", + "traits": { + "smithy.api#documentation": "Machine learning options on the specified domain.
" + } + }, + "Status": { + "target": "com.amazonaws.opensearch#OptionStatus" + } + }, + "traits": { + "smithy.api#documentation": "The status of machine learning options on the specified domain.
" + } + }, "com.amazonaws.opensearch#ARN": { "type": "string", "traits": { @@ -3318,6 +3363,12 @@ "traits": { "smithy.api#documentation": "Software update options for the domain.
" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsInput", + "traits": { + "smithy.api#documentation": "Options for all machine learning features for the specified domain.
" + } } }, "traits": { @@ -5710,6 +5761,12 @@ "traits": { "smithy.api#documentation": "Information about the domain properties that are currently being modified.
" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsStatus", + "traits": { + "smithy.api#documentation": "Container for parameters required to enable all machine learning features.
" + } } }, "traits": { @@ -6386,6 +6443,12 @@ "traits": { "smithy.api#documentation": "Information about the domain properties that are currently being modified.
" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsOutput", + "traits": { + "smithy.api#documentation": "Container for parameters required to enable all machine learning features.
" + } } }, "traits": { @@ -9036,6 +9099,104 @@ "target": "com.amazonaws.opensearch#ModifyingProperties" } }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState": { + "type": "enum", + "members": { + "NotEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_ENABLED" + } + }, + "EnableComplete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_COMPLETE" + } + }, + "EnableInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_IN_PROGRESS" + } + }, + "EnableFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_FAILED" + } + }, + "DisableComplete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_COMPLETE" + } + }, + "DisableInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_IN_PROGRESS" + } + }, + "DisableFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_FAILED" + } + } + } + }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput": { + "type": "structure", + "members": { + "DesiredState": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", + "traits": { + "smithy.api#documentation": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for parameters required to enable the natural language query generation feature.
" + } + }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput": { + "type": "structure", + "members": { + "DesiredState": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", + "traits": { + "smithy.api#documentation": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" + } + }, + "CurrentState": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState", + "traits": { + "smithy.api#documentation": "The current state of the natural language query generation feature, indicating completion, in progress, or failure.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for parameters representing the state of the natural language query generation feature on the specified domain.
" + } + }, "com.amazonaws.opensearch#NextToken": { "type": "string", "traits": { @@ -12221,6 +12382,12 @@ "traits": { "smithy.api#documentation": "Service software update options for the domain.
" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsInput", + "traits": { + "smithy.api#documentation": "Options for all machine learning features for the specified domain.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/sagemaker.json b/codegen/sdk/aws-models/sagemaker.json index a02c56b9e21..b27846a9ecd 100644 --- a/codegen/sdk/aws-models/sagemaker.json +++ b/codegen/sdk/aws-models/sagemaker.json @@ -385,6 +385,51 @@ } } }, + "com.amazonaws.sagemaker#AdditionalModelChannelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\.\\-_]+$" + } + }, + "com.amazonaws.sagemaker#AdditionalModelDataSource": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.sagemaker#AdditionalModelChannelName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A custom name for this AdditionalModelDataSource object.
Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
Specifies configurations for one or more training jobs that SageMaker runs to test the\n algorithm.
" } }, + "com.amazonaws.sagemaker#AmazonQSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "Whether Amazon Q has been enabled within the domain.
" + } + }, + "QProfileArn": { + "target": "com.amazonaws.sagemaker#QProfileArn", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon Q profile used within the domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain.
" + } + }, "com.amazonaws.sagemaker#AnnotationConsolidationConfig": { "type": "structure", "members": { @@ -7396,7 +7461,7 @@ } }, "traits": { - "smithy.api#documentation": "A Git repository that SageMaker automatically displays to users for cloning in the JupyterServer application.
" + "smithy.api#documentation": "A Git repository that SageMaker automatically displays to users for cloning in the\n JupyterServer application.
" } }, "com.amazonaws.sagemaker#CodeRepositoryArn": { @@ -8040,6 +8105,12 @@ "smithy.api#documentation": "Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource in conjunction with SageMaker\n batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Data sources that are available to your model in addition to the one that you specify for ModelDataSource when you use the CreateModel action.
Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active simultaneously.
" + "smithy.api#documentation": "Creates a running app for the specified UserProfile. This operation is automatically\n invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel\n configurations are selected by the user. A user may have multiple Apps active\n simultaneously.
" } }, "com.amazonaws.sagemaker#CreateAppImageConfig": { @@ -8687,13 +8758,13 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be set.
The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName\n must be set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
Each tag consists of a key and an optional value.\n Tag keys must be unique per resource.
" + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
" } }, "ResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
\nThe value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for\n the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a\n KernelGateway app, the CreateApp call fails with a request validation error.
The instance type and the Amazon Resource Name (ARN) of the SageMaker image\n created on the instance.
\nThe value of InstanceType passed as part of the ResourceSpec\n in the CreateApp call overrides the value passed as part of the\n ResourceSpec configured for the user profile or the domain. If\n InstanceType is not specified in any of those three ResourceSpec\n values for a KernelGateway app, the CreateApp call fails with a\n request validation error.
Creates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list\n of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC)\n configurations. Users within a domain can share notebook files and other artifacts with each\n other.
\n EFS storage\n
\nWhen a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks, Git\n repositories, and data files.
\nSageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to\n encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by\n default. For more control, you can specify a customer managed key. For more information, see\n Protect Data\n at Rest Using Encryption.
\n\n VPC configuration\n
\nAll traffic between the domain and the Amazon EFS volume is through the specified VPC and\n subnets. For other traffic, you can specify the AppNetworkAccessType parameter.\n AppNetworkAccessType corresponds to the network access type that you choose\n when you onboard to the domain. The following options are available:
\n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.
\n VpcOnly - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook\n or to train or host models unless your VPC has an interface endpoint to the SageMaker API and\n runtime or a NAT gateway and your security groups allow outbound connections.
\nNFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker Studio app successfully.
\nFor more information, see Connect Amazon SageMaker Studio\n Notebooks to Resources in a VPC.
" + "smithy.api#documentation": "Creates a Domain. A domain consists of an associated Amazon Elastic File System\n volume, a list of authorized users, and a variety of security, application, policy, and\n Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files\n and other artifacts with each other.
\n EFS storage\n
\nWhen a domain is created, an EFS volume is created for use by all of the users within the\n domain. Each user receives a private home directory within the EFS volume for notebooks, Git\n repositories, and data files.
\nSageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services\n KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key\n by default. For more control, you can specify a customer managed key. For more information,\n see Protect Data\n at Rest Using Encryption.
\n\n VPC configuration\n
\nAll traffic between the domain and the Amazon EFS volume is through the specified\n VPC and subnets. For other traffic, you can specify the AppNetworkAccessType\n parameter. AppNetworkAccessType corresponds to the network access type that you\n choose when you onboard to the domain. The following options are available:
\n PublicInternetOnly - Non-EFS traffic goes through a VPC managed by\n Amazon SageMaker, which allows internet access. This is the default value.
\n VpcOnly - All traffic is through the specified VPC and subnets. Internet\n access is disabled by default. To allow internet access, you must specify a NAT\n gateway.
When internet access is disabled, you won't be able to run a Amazon SageMaker\n Studio notebook or to train or host models unless your VPC has an interface endpoint to\n the SageMaker API and runtime or a NAT gateway and your security groups allow\n outbound connections.
\nNFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules\n in order to launch a Amazon SageMaker Studio app successfully.
\nFor more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC.
" } }, "com.amazonaws.sagemaker#CreateDomainRequest": { @@ -9610,7 +9681,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Creates a job that optimizes a model for inference performance. To create the job, you\n provide the location of a source model, and you provide the settings for the optimization\n techniques that you want the job to apply. When the job completes successfully, SageMaker\n uploads the new optimized model to the output destination that you specify.
\nFor more information about how to use this action, and about the supported optimization\n techniques, see Optimize model inference with Amazon SageMaker.
" + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A custom name for the new optimization job.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
\nDuring model optimization, Amazon SageMaker needs your permission to:
\nRead input data from an S3 bucket
\nWrite model artifacts to an S3 bucket
\nWrite logs to Amazon CloudWatch Logs
\nPublish metrics to Amazon CloudWatch
\nYou grant permissions for all of these tasks to an IAM role. To pass this\n role to Amazon SageMaker, the caller of this API must have the\n iam:PassRole permission. For more information, see Amazon SageMaker Roles.\n
The location of the source model to optimize with an optimization job.
", + "smithy.api#required": {} + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to set in the model container.
" + } + }, + "OptimizationConfigs": { + "target": "com.amazonaws.sagemaker#OptimizationConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Settings for each of the optimization techniques that the job applies.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.sagemaker#TagList", + "traits": { + "smithy.api#documentation": "A list of key-value pairs associated with the optimization job. For more information,\n see Tagging Amazon Web Services resources in the Amazon Web Services General Reference\n Guide.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", + "traits": { + "smithy.api#documentation": "A VPC in Amazon VPC that your optimized model has access to.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#CreateOptimizationJobResponse": { + "type": "structure", + "members": { + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#CreatePipeline": { "type": "operation", "input": { @@ -12547,7 +12735,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser,\n the user will be automatically signed in to the domain, and granted access to all of\n the Apps and files associated with the Domain's Amazon Elastic File System volume.\n This operation can only be called when the authentication mode equals IAM.\n
\nThe IAM role or user passed to this API defines the permissions to access the app. Once\n the presigned URL is created, no additional permission is required to access this URL. IAM\n authorization policies for this API are also enforced for every HTTP request and WebSocket\n frame that attempts to connect to the app.
\nYou can restrict access to this API and to the\n URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint\n .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you\n are directed to the Amazon Web Services console sign-in page.
Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the\n user will be automatically signed in to the domain, and granted access to all of the Apps and\n files associated with the Domain's Amazon Elastic File System volume. This operation can only be\n called when the authentication mode equals IAM.
\nThe IAM role or user passed to this API defines the permissions to access\n the app. Once the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every\n HTTP request and WebSocket frame that attempts to connect to the app.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more\n information, see Connect to Amazon SageMaker\n Studio Through an Interface VPC Endpoint .
\nThe URL that you get from a call to CreatePresignedDomainUrl has a default\n timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If\n you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.
The number of seconds until the pre-signed URL expires. This value defaults to\n 300.
" + "smithy.api#documentation": "The number of seconds until the pre-signed URL expires. This value defaults to 300.
" } }, "SpaceName": { @@ -12590,7 +12778,7 @@ "LandingUri": { "target": "com.amazonaws.sagemaker#LandingUri", "traits": { - "smithy.api#documentation": "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:
\n\n studio::relative/path: Directs users to the relative path in Studio.
\n app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.
\n app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.
\n app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.
\n app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
\n app:Canvas:relative/path: Directs users to the relative path in the Canvas application.
The landing page that the user is directed to when accessing the presigned URL. Using this\n value, users can access Studio or Studio Classic, even if it is not the default experience for\n the domain. The supported values are:
\n\n studio::relative/path: Directs users to the relative path in\n Studio.
\n app:JupyterServer:relative/path: Directs users to the relative path in\n the Studio Classic application.
\n app:JupyterLab:relative/path: Directs users to the relative path in the\n JupyterLab application.
\n app:RStudioServerPro:relative/path: Directs users to the relative path in\n the RStudio application.
\n app:CodeEditor:relative/path: Directs users to the relative path in the\n Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
\n app:Canvas:relative/path: Directs users to the relative path in the\n Canvas application.
Tags to associated with the space. Each tag consists of a key and an optional value.\n Tag keys must be unique for each resource. Tags are searchable using the\n Search API.
Tags to associated with the space. Each tag consists of a key and an optional value. Tag\n keys must be unique for each resource. Tags are searchable using the Search\n API.
The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.
", + "smithy.api#documentation": "The content of your Amazon SageMaker Studio Lifecycle Configuration script. This\n content must be base64 encoded.
", "smithy.api#required": {} } }, @@ -13049,7 +13237,7 @@ "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
" + "smithy.api#documentation": "Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an\n optional value. Tag keys must be unique per resource. Tags are searchable using the Search\n API.
" } } }, @@ -13594,7 +13782,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user profile is\n automatically created. A user profile is the primary holder of settings for an individual\n user and has a reference to the user's private Amazon Elastic File System home directory.\n
" + "smithy.api#documentation": "Creates a user profile. A user profile represents a single user within a domain, and is\n the main way to reference a \"person\" for the purposes of sharing, reporting, and other\n user-oriented features. This entity is created when a user onboards to a domain. If an\n administrator invites a person by email or imports them from IAM Identity Center, a user\n profile is automatically created. A user profile is the primary holder of settings for an\n individual user and has a reference to the user's private Amazon Elastic File System home\n directory.
" } }, "com.amazonaws.sagemaker#CreateUserProfileRequest": { @@ -13619,19 +13807,19 @@ "SingleSignOnUserIdentifier": { "target": "com.amazonaws.sagemaker#SingleSignOnUserIdentifier", "traits": { - "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\".\n If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" + "smithy.api#documentation": "A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only\n supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is\n required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" } }, "SingleSignOnUserValue": { "target": "com.amazonaws.sagemaker#String256", "traits": { - "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is\n required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.\n
" + "smithy.api#documentation": "The username of the associated Amazon Web Services Single Sign-On User for this\n UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must\n match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
" } }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { - "smithy.api#documentation": "Each tag consists of a key and an optional value.\n Tag keys must be unique per resource.
\nTags that you specify for the User Profile are also added to all Apps that the\n User Profile launches.
" + "smithy.api#documentation": "Each tag consists of a key and an optional value. Tag keys must be unique per\n resource.
\nTags that you specify for the User Profile are also added to all Apps that the User\n Profile launches.
" } }, "UserSettings": { @@ -14634,7 +14822,7 @@ "SecurityGroups": { "target": "com.amazonaws.sagemaker#SecurityGroupIds", "traits": { - "smithy.api#documentation": "The security group IDs for the Amazon VPC that the space uses for communication.
" + "smithy.api#documentation": "The security group IDs for the Amazon VPC that the space uses for\n communication.
" } }, "JupyterServerAppSettings": { @@ -14655,7 +14843,7 @@ "CustomFileSystemConfigs": { "target": "com.amazonaws.sagemaker#CustomFileSystemConfigs", "traits": { - "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.
" + "smithy.api#documentation": "The settings for assigning a custom file system to a domain. Permitted users can access\n this file system in Amazon SageMaker Studio.
" } } }, @@ -14833,13 +15021,13 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be set.
The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName\n must be set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
Deletes an optimization job.
" + } + }, + "com.amazonaws.sagemaker#DeleteOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.sagemaker#DeletePipeline": { "type": "operation", "input": { @@ -16433,7 +16654,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.
" + "smithy.api#documentation": "Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the\n Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You\n must also remove the Lifecycle Configuration from UserSettings in all Domains and\n UserProfiles.
" } }, "com.amazonaws.sagemaker#DeleteStudioLifecycleConfigRequest": { @@ -16606,7 +16827,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS\n volume, including data, notebooks, and other artifacts.
" + "smithy.api#documentation": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS\n volume, including data, notebooks, and other artifacts.
" } }, "com.amazonaws.sagemaker#DeleteUserProfileRequest": { @@ -17295,7 +17516,7 @@ "UserProfileName": { "target": "com.amazonaws.sagemaker#UserProfileName", "traits": { - "smithy.api#documentation": "The user profile name. If this value is not set, then SpaceName must be set.
The user profile name. If this value is not set, then SpaceName must be\n set.
The name of the space. If this value is not set, then UserProfileName\n must be set.
The name of the space. If this value is not set, then UserProfileName must be\n set.
The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
The timestamp of the last user's activity. LastUserActivityTimestamp is also\n updated when SageMaker performs health checks without user activity. As a result, this\n value is set to the same value as LastHealthCheckTimestamp.
The creation time of the application.
\nAfter an application has been shut down for 24 hours, SageMaker deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.
\nThe creation time of the application.
\nAfter an application has been shut down for 24 hours, SageMaker deletes all\n metadata for the application. To be considered an update and retain application metadata,\n applications must be restarted within 24 hours after the previous application has been shut\n down. After this time window, creation of an application is considered a new application\n rather than an update of the previous application.
\nThe instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" + "smithy.api#documentation": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image\n created on the instance.
" } } }, @@ -18778,7 +18999,7 @@ "SingleSignOnApplicationArn": { "target": "com.amazonaws.sagemaker#SingleSignOnApplicationArn", "traits": { - "smithy.api#documentation": "The ARN of the application managed by SageMaker in IAM Identity Center. This value is\n only returned for domains created after October 1, 2023.
" + "smithy.api#documentation": "The ARN of the application managed by SageMaker in IAM Identity Center. This value\n is only returned for domains created after October 1, 2023.
" } }, "Status": { @@ -18832,7 +19053,7 @@ "AppNetworkAccessType": { "target": "com.amazonaws.sagemaker#AppNetworkAccessType", "traits": { - "smithy.api#documentation": "Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Specifies the VPC used for non-EFS traffic. The default value is\n PublicInternetOnly.
\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
\n VpcOnly - All traffic is through the specified VPC and subnets
Provides the properties of the specified optimization job.
" + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#DescribeOptimizationJobResponse": { + "type": "structure", + "members": { + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationJobStatus": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job started.
" + } + }, + "OptimizationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job finished processing.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when you created the optimization job.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when the optimization job was last updated.
", + "smithy.api#required": {} + } + }, + "FailureReason": { + "target": "com.amazonaws.sagemaker#FailureReason", + "traits": { + "smithy.api#documentation": "If the optimization job status is FAILED, the reason for the\n failure.
The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + }, + "ModelSource": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location of the source model to optimize with an optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to set in the model container.
" + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationConfigs": { + "target": "com.amazonaws.sagemaker#OptimizationConfigs", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Settings for each of the optimization techniques that the job applies.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.sagemaker#OptimizationJobOutputConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationOutput": { + "target": "com.amazonaws.sagemaker#OptimizationOutput", + "traits": { + "smithy.api#documentation": "Output values produced by an optimization job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.sagemaker#RoleArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the IAM role that you assigned to the optimization job.
", + "smithy.api#required": {} + } + }, + "StoppingCondition": { + "target": "com.amazonaws.sagemaker#StoppingCondition", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.sagemaker#OptimizationVpcConfig", + "traits": { + "smithy.api#documentation": "A VPC in Amazon VPC that your optimized model has access to.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#DescribePipeline": { "type": "operation", "input": { @@ -23803,7 +24188,7 @@ "Url": { "target": "com.amazonaws.sagemaker#String1024", "traits": { - "smithy.api#documentation": "Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to the URL after appending the respective redirect parameter for the application type to be federated through Amazon Web Services IAM Identity Center.
\nThe following application types are supported:
\nStudio Classic: &redirect=JupyterServer\n
JupyterLab: &redirect=JupyterLab\n
Code Editor, based on Code-OSS, Visual Studio Code - Open Source: &redirect=CodeEditor\n
Returns the URL of the space. If the space is created with Amazon Web Services IAM Identity\n Center (Successor to Amazon Web Services Single Sign-On) authentication, users can navigate to\n the URL after appending the respective redirect parameter for the application type to be\n federated through Amazon Web Services IAM Identity Center.
\nThe following application types are supported:
\nStudio Classic: &redirect=JupyterServer\n
JupyterLab: &redirect=JupyterLab\n
Code Editor, based on Code-OSS, Visual Studio Code - Open Source:\n &redirect=CodeEditor\n
The name of the Amazon SageMaker Studio Lifecycle Configuration that is described.
" + "smithy.api#documentation": "The name of the Amazon SageMaker Studio Lifecycle Configuration that is\n described.
" } }, "CreationTime": { @@ -23868,7 +24253,7 @@ "LastModifiedTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.
" + "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle\n Configurations are immutable.
" } }, "StudioLifecycleConfigContent": { @@ -25672,7 +26057,7 @@ "VpcOnlyTrustedAccounts": { "target": "com.amazonaws.sagemaker#VpcOnlyTrustedAccounts", "traits": { - "smithy.api#documentation": "The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.
" + "smithy.api#documentation": "The list of Amazon Web Services accounts that are trusted when the domain is created in\n VPC-only mode.
" } } }, @@ -25803,7 +26188,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.sagemaker#DomainSecurityGroupIds", "traits": { - "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication\n between Domain-level apps and user apps.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.
" + "smithy.api#documentation": "The configuration for attaching a SageMaker user profile name to the execution\n role as a sts:SourceIdentity key.
" } }, "DockerSettings": { @@ -25823,6 +26208,12 @@ "traits": { "smithy.api#documentation": "A collection of settings that configure the domain's Docker interaction.
" } + }, + "AmazonQSettings": { + "target": "com.amazonaws.sagemaker#AmazonQSettings", + "traits": { + "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain. The\n AuthMode that you use to create the domain must be SSO.
The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no\n apps in the InService or Pending state.
The configuration for attaching a SageMaker user profile name to the execution\n role as a sts:SourceIdentity key. This configuration can only be modified if there are no\n apps in the InService or Pending state.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication\n between Domain-level apps and user apps.
The security groups for the Amazon Virtual Private Cloud that the Domain uses for\n communication between Domain-level apps and user apps.
A collection of settings that configure the domain's Docker interaction.
" } + }, + "AmazonQSettings": { + "target": "com.amazonaws.sagemaker#AmazonQSettings", + "traits": { + "smithy.api#documentation": "A collection of settings that configure the Amazon Q experience within the domain.
" + } } }, "traits": { @@ -34710,19 +35107,19 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.
The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the\n LifecycleConfigArns parameter, then this parameter is also required.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the\n JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is\n also required.
To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.
" + "smithy.api#documentation": "A list of Git repositories that SageMaker automatically displays to users for\n cloning in the JupyterServer application.
" } } }, @@ -34769,19 +35166,19 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
\nThe Amazon SageMaker Studio UI does not use the default instance type value set here. The\n default instance type set here is used when Apps are created using the CLI or\n CloudFormation and the instance type parameter value is not passed.
\nThe default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
\nThe Amazon SageMaker Studio UI does not use the default instance type value set\n 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\n passed.
\nA list of custom SageMaker images that are configured to run as a KernelGateway app.
" + "smithy.api#documentation": "A list of custom SageMaker images that are configured to run as a KernelGateway\n app.
" } }, "LifecycleConfigArns": { "target": "com.amazonaws.sagemaker#LifecycleConfigArns", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
\nTo remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user\n profile or domain.
\nTo remove a Lifecycle Config, you must set LifecycleConfigArns to an empty\n list.
If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
A parameter to search by user profile name. If SpaceNameEquals is set, then\n this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set,\n then this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set, then\n this value cannot be set.
If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } } }, @@ -37316,7 +37713,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
Lists the optimization jobs in your account and their properties.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "OptimizationJobSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "A token that you use to get the next set of results following a truncated response. If\n the response to the previous request was truncated, that response provides the value for\n this token.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sagemaker#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of optimization jobs to return in the response. The default is\n 50.
" + } + }, + "CreationTimeAfter": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were created after the\n specified time.
" + } + }, + "CreationTimeBefore": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were created before the\n specified time.
" + } + }, + "LastModifiedTimeAfter": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated after the\n specified time.
" + } + }, + "LastModifiedTimeBefore": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that were updated before the\n specified time.
" + } + }, + "OptimizationContains": { + "target": "com.amazonaws.sagemaker#NameContains", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs that apply the specified\n optimization techniques. You can specify either Quantization or\n Compilation.
Filters the results to only those optimization jobs with a name that contains the\n specified string.
" + } + }, + "StatusEquals": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#documentation": "Filters the results to only those optimization jobs with the specified status.
" + } + }, + "SortBy": { + "target": "com.amazonaws.sagemaker#ListOptimizationJobsSortBy", + "traits": { + "smithy.api#documentation": "The field by which to sort the optimization jobs in the response. The default is\n CreationTime\n
The sort order for results. The default is Ascending\n
A list of optimization jobs and their properties that matches any of the filters you\n specified in the request.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sagemaker#NextToken", + "traits": { + "smithy.api#documentation": "The token to use in a subsequent request to get the next set of results following a\n truncated response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sagemaker#ListOptimizationJobsSortBy": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "CREATION_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationTime" + } + }, + "STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Status" + } + } + } + }, "com.amazonaws.sagemaker#ListPipelineExecutionSteps": { "type": "operation", "input": { @@ -41936,13 +42470,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your\n next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your\n next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } } }, @@ -42090,7 +42624,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.
", + "smithy.api#documentation": "Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services\n Account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -42105,49 +42639,49 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
The total number of items to return in the response. If the total number of items\n available is more than the value specified, a NextToken is provided in the\n response. To resume pagination, provide the NextToken value in the as part of a\n subsequent call. The default value is 10.
If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.
" + "smithy.api#documentation": "If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle\n Configurations, the call returns a token for getting the next set of Lifecycle\n Configurations.
" } }, "NameContains": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigName", "traits": { - "smithy.api#documentation": "A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.
" + "smithy.api#documentation": "A string in the Lifecycle Configuration name. This filter returns only Lifecycle\n Configurations whose name contains the specified string.
" } }, "AppTypeEquals": { "target": "com.amazonaws.sagemaker#StudioLifecycleConfigAppType", "traits": { - "smithy.api#documentation": "A parameter to search for the App Type to which the Lifecycle Configuration is attached.
" + "smithy.api#documentation": "A parameter to search for the App Type to which the Lifecycle Configuration is\n attached.
" } }, "CreationTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or before the specified time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or before the specified\n time.
" } }, "CreationTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or after the specified time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations created on or after the specified\n time.
" } }, "ModifiedTimeBefore": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified before the specified time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified before the specified\n time.
" } }, "ModifiedTimeAfter": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified after the specified time.
" + "smithy.api#documentation": "A filter that returns only Lifecycle Configurations modified after the specified\n time.
" } }, "SortBy": { @@ -42173,7 +42707,7 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } }, "StudioLifecycleConfigs": { @@ -42874,13 +43408,13 @@ "NextToken": { "target": "com.amazonaws.sagemaker#NextToken", "traits": { - "smithy.api#documentation": "If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken\n is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
This parameter defines the maximum number of results that can be return in a single\n response. The MaxResults parameter is an upper bound, not a target. If there are\n more results available than the value specified, a NextToken is provided in the\n response. The NextToken indicates that the user should get the next set of\n results by providing this token as a part of a subsequent call. The default value for\n MaxResults is 10.
If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token. Use it in your next\n request to receive the next set of results.
" } } }, @@ -44517,6 +45051,26 @@ "smithy.api#documentation": "Configures the timeout and maximum number of retries for processing a transform job\n invocation.
" } }, + "com.amazonaws.sagemaker#ModelCompilationConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the model compilation technique that's applied by a model optimization job.
" + } + }, "com.amazonaws.sagemaker#ModelCompressionType": { "type": "enum", "members": { @@ -46149,6 +46703,26 @@ "smithy.api#documentation": "The input for the model quality monitoring job. Currently endpoints are supported for\n input for model quality monitoring jobs.
" } }, + "com.amazonaws.sagemaker#ModelQuantizationConfig": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to run the optimization.
" + } + }, + "OverrideEnvironment": { + "target": "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables", + "traits": { + "smithy.api#documentation": "Environment variables that override the default ones in the model container.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for the model quantization technique that's applied by a model optimization job.
" + } + }, "com.amazonaws.sagemaker#ModelRegisterSettings": { "type": "structure", "members": { @@ -48680,6 +49254,521 @@ } } }, + "com.amazonaws.sagemaker#OptimizationConfig": { + "type": "union", + "members": { + "ModelQuantizationConfig": { + "target": "com.amazonaws.sagemaker#ModelQuantizationConfig", + "traits": { + "smithy.api#documentation": "Settings for the model quantization technique that's applied by a model optimization job.
" + } + }, + "ModelCompilationConfig": { + "target": "com.amazonaws.sagemaker#ModelCompilationConfig", + "traits": { + "smithy.api#documentation": "Settings for the model compilation technique that's applied by a model optimization job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings for an optimization technique that you apply with a model optimization\n job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.sagemaker#OptimizationContainerImage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationJobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:optimization-job/" + } + }, + "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType": { + "type": "enum", + "members": { + "ML_P4D_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4d.24xlarge" + } + }, + "ML_P4DE_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p4de.24xlarge" + } + }, + "ML_P5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5.48xlarge" + } + }, + "ML_G5_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.xlarge" + } + }, + "ML_G5_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.2xlarge" + } + }, + "ML_G5_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.4xlarge" + } + }, + "ML_G5_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.8xlarge" + } + }, + "ML_G5_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.12xlarge" + } + }, + "ML_G5_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.16xlarge" + } + }, + "ML_G5_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.24xlarge" + } + }, + "ML_G5_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g5.48xlarge" + } + }, + "ML_G6_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.xlarge" + } + }, + "ML_G6_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.2xlarge" + } + }, + "ML_G6_4XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.4xlarge" + } + }, + "ML_G6_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.8xlarge" + } + }, + "ML_G6_12XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.12xlarge" + } + }, + "ML_G6_16XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.16xlarge" + } + }, + "ML_G6_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.24xlarge" + } + }, + "ML_G6_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.g6.48xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_TRN1N_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1n.32xlarge" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobEnvironmentVariables": { + "type": "map", + "key": { + "target": "com.amazonaws.sagemaker#NonEmptyString256" + }, + "value": { + "target": "com.amazonaws.sagemaker#String256" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobModelSource": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.sagemaker#OptimizationJobModelSourceS3", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of a source model to optimize with an optimization job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the source model to optimize with an optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationJobModelSourceS3": { + "type": "structure", + "members": { + "S3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "An Amazon S3 URI that locates a source model to optimize with an optimization job.
" + } + }, + "ModelAccessConfig": { + "target": "com.amazonaws.sagemaker#OptimizationModelAccessConfig", + "traits": { + "smithy.api#documentation": "The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon S3 location of a source model to optimize with an optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationJobOutputConfig": { + "type": "structure", + "members": { + "KmsKeyId": { + "target": "com.amazonaws.sagemaker#KmsKeyId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS. SageMaker uses they key to encrypt the artifacts of the\n optimized model when SageMaker uploads the model to Amazon S3.
" + } + }, + "S3OutputLocation": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon S3 URI for where to store the optimized model that you create with an optimization\n job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details for where to store the optimized model that you create with the optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationJobStatus": { + "type": "enum", + "members": { + "INPROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPROGRESS" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.sagemaker#OptimizationJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationJobSummary" + } + }, + "com.amazonaws.sagemaker#OptimizationJobSummary": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationJobArn": { + "target": "com.amazonaws.sagemaker#OptimizationJobArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the optimization job.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.sagemaker#CreationTime", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time when you created the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationJobStatus": { + "target": "com.amazonaws.sagemaker#OptimizationJobStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current status of the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationStartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job started.
" + } + }, + "OptimizationEndTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the optimization job finished processing.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.sagemaker#LastModifiedTime", + "traits": { + "smithy.api#documentation": "The time when the optimization job was last updated.
" + } + }, + "DeploymentInstanceType": { + "target": "com.amazonaws.sagemaker#OptimizationJobDeploymentInstanceType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of instance that hosts the optimized model that you create with the optimization job.
", + "smithy.api#required": {} + } + }, + "OptimizationTypes": { + "target": "com.amazonaws.sagemaker#OptimizationTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The optimization techniques that are applied by the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Summarizes an optimization job by providing some of its key properties.
" + } + }, + "com.amazonaws.sagemaker#OptimizationModelAcceptEula": { + "type": "boolean" + }, + "com.amazonaws.sagemaker#OptimizationModelAccessConfig": { + "type": "structure", + "members": { + "AcceptEula": { + "target": "com.amazonaws.sagemaker#OptimizationModelAcceptEula", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies agreement to the model end-user license agreement (EULA). The\n AcceptEula value must be explicitly defined as True in order\n to accept the EULA that this model requires. You are responsible for reviewing and\n complying with any applicable license terms and making sure they are acceptable for your\n use case before downloading or using a model.
The access configuration settings for the source ML model for an optimization job, where you can accept the model end-user license agreement (EULA).
" + } + }, + "com.amazonaws.sagemaker#OptimizationOutput": { + "type": "structure", + "members": { + "RecommendedInferenceImage": { + "target": "com.amazonaws.sagemaker#OptimizationContainerImage", + "traits": { + "smithy.api#documentation": "The image that SageMaker recommends that you use to host the optimized model that you created\n with an optimization job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Output values produced by an optimization job.
" + } + }, + "com.amazonaws.sagemaker#OptimizationType": { + "type": "string" + }, + "com.amazonaws.sagemaker#OptimizationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationType" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcConfig": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security\n groups for the VPC that is specified in the Subnets field.
The ID of the subnets in the VPC to which you want to connect your optimized\n model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A VPC in Amazon VPC that's accessible to an optimized that you create with an optimization\n job. You can control access to and from your resources by configuring a VPC. For more\n information, see Give SageMaker Access to Resources in your Amazon VPC.
" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+$" + } + }, + "com.amazonaws.sagemaker#OptimizationVpcSubnets": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#OptimizationVpcSubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.sagemaker#OptionalDouble": { "type": "double" }, @@ -53217,6 +54306,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#QProfileArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[-.a-z0-9]{1,63}:codewhisperer:([-.a-z0-9]{0,63}:){2}([a-zA-Z0-9-_:/]){1,1023}$" + } + }, "com.amazonaws.sagemaker#QualityCheckStepMetadata": { "type": "structure", "members": { @@ -53509,7 +54604,7 @@ "CustomImages": { "target": "com.amazonaws.sagemaker#CustomImages", "traits": { - "smithy.api#documentation": "A list of custom SageMaker images that are configured to run as a RSession app.
" + "smithy.api#documentation": "A list of custom SageMaker images that are configured to run as a RSession\n app.
" } } }, @@ -53546,12 +54641,12 @@ "UserGroup": { "target": "com.amazonaws.sagemaker#RStudioServerProUserGroup", "traits": { - "smithy.api#documentation": "The level of permissions that the user has within the RStudioServerPro\n app. This value defaults to `User`. The `Admin` value allows the user access to the\n RStudio Administrative Dashboard.
The level of permissions that the user has within the RStudioServerPro app.\n This value defaults to `User`. The `Admin` value allows the user access to the RStudio\n Administrative Dashboard.
A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.
A collection of settings that update the current configuration for the\n RStudioServerPro Domain-level app.
The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the\n Resource.
" } } }, @@ -55889,6 +56984,9 @@ { "target": "com.amazonaws.sagemaker#CreateNotebookInstanceLifecycleConfig" }, + { + "target": "com.amazonaws.sagemaker#CreateOptimizationJob" + }, { "target": "com.amazonaws.sagemaker#CreatePipeline" }, @@ -56057,6 +57155,9 @@ { "target": "com.amazonaws.sagemaker#DeleteNotebookInstanceLifecycleConfig" }, + { + "target": "com.amazonaws.sagemaker#DeleteOptimizationJob" + }, { "target": "com.amazonaws.sagemaker#DeletePipeline" }, @@ -56231,6 +57332,9 @@ { "target": "com.amazonaws.sagemaker#DescribeNotebookInstanceLifecycleConfig" }, + { + "target": "com.amazonaws.sagemaker#DescribeOptimizationJob" + }, { "target": "com.amazonaws.sagemaker#DescribePipeline" }, @@ -56474,6 +57578,9 @@ { "target": "com.amazonaws.sagemaker#ListNotebookInstances" }, + { + "target": "com.amazonaws.sagemaker#ListOptimizationJobs" + }, { "target": "com.amazonaws.sagemaker#ListPipelineExecutions" }, @@ -56609,6 +57716,9 @@ { "target": "com.amazonaws.sagemaker#StopNotebookInstance" }, + { + "target": "com.amazonaws.sagemaker#StopOptimizationJob" + }, { "target": "com.amazonaws.sagemaker#StopPipelineExecution" }, @@ -58789,24 +59899,24 @@ "NotebookOutputOption": { "target": "com.amazonaws.sagemaker#NotebookOutputOption", "traits": { - "smithy.api#documentation": "Whether to include the notebook cell output when sharing the notebook. The default\n is Disabled.
Whether to include the notebook cell output when sharing the notebook. The default is\n Disabled.
When NotebookOutputOption is Allowed, the Amazon S3 bucket used\n to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon S3\n bucket used to store the shared notebook snapshots.
When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS)\n encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.
When NotebookOutputOption is Allowed, the Amazon Web Services Key\n Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the\n Amazon S3 bucket.
Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain\n API is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing\n isn't allowed.
Specifies options for sharing Amazon SageMaker Studio notebooks. These settings are\n specified as part of DefaultUserSettings when the CreateDomain API\n is called, and as part of UserSettings when the CreateUserProfile\n API is called. When SharingSettings is not specified, notebook sharing isn't\n allowed.
Ends a running inference optimization job.
" + } + }, + "com.amazonaws.sagemaker#StopOptimizationJobRequest": { + "type": "structure", + "members": { + "OptimizationJobName": { + "target": "com.amazonaws.sagemaker#EntityName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that you assigned to the optimization job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.sagemaker#StopPipelineExecution": { "type": "operation", "input": { @@ -60667,7 +61810,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies a limit to how long a model training job or model compilation job can run.\n It also specifies how long a managed spot training job has to complete. When the job\n reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap\n model training costs.
\nTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.
\nSpecifies a limit to how long a job can run. When the job reaches the time limit, SageMaker\n ends the job. Use this API to cap costs.
\nTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\n which delays job termination for 120 seconds. Algorithms can use this 120-second window\n to save the model artifacts, so the results of training are not lost.
The training algorithms provided by SageMaker automatically save the intermediate results\n of a model training job when possible. This attempt to save artifacts is only a best\n effort case as model might not be in a state from which it can be saved. For example, if\n training has just started, the model might not be ready to save. When saved, this\n intermediate data is a valid model artifact. You can use it to create a model with\n CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model\n artifacts. When training NTMs, make sure that the maximum runtime is sufficient for\n the training job to complete.
\nThis value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle Configurations are immutable.
" + "smithy.api#documentation": "This value is equivalent to CreationTime because Amazon SageMaker Studio Lifecycle\n Configurations are immutable.
" } }, "StudioLifecycleConfigAppType": { @@ -60928,12 +62071,12 @@ "HiddenAppTypes": { "target": "com.amazonaws.sagemaker#HiddenAppTypesList", "traits": { - "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation pane.
" + "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation\n pane.
" } } }, "traits": { - "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
" + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" } }, "com.amazonaws.sagemaker#SubnetId": { @@ -61689,7 +62832,7 @@ "DefaultResourceSpec": { "target": "com.amazonaws.sagemaker#ResourceSpec", "traits": { - "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.
" + "smithy.api#documentation": "The default instance type and the Amazon Resource Name (ARN) of the SageMaker\n image created on the instance.
" } } }, @@ -66201,7 +67344,7 @@ "AppSecurityGroupManagement": { "target": "com.amazonaws.sagemaker#AppSecurityGroupManagement", "traits": { - "smithy.api#documentation": "The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
The VPC subnets that Studio uses for communication.
\nIf removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.
The VPC subnets that Studio uses for communication.
\nIf removing subnets, ensure there are no apps in the InService,\n Pending, or Deleting state.
Specifies the VPC used for non-EFS traffic.
\n\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by\n Amazon SageMaker, which allows direct internet access.
\n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.
This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.
Specifies the VPC used for non-EFS traffic.
\n\n PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.
\n VpcOnly - All Studio traffic is through the specified VPC and\n subnets.
This configuration can only be modified if there are no apps in the\n InService, Pending, or Deleting state. The\n configuration cannot be updated if\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already\n set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided as part of the same request.
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
\nOptional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for the domain.
Amazon SageMaker adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the\n number of security groups that you can specify is one less than the maximum number shown.
" + "smithy.api#documentation": "The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for\n communication.
\nOptional when the CreateDomain.AppNetworkAccessType parameter is set to\n PublicInternetOnly.
Required when the CreateDomain.AppNetworkAccessType parameter is set to\n VpcOnly, unless specified as part of the DefaultUserSettings for\n the domain.
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\n maximum number shown.
" } }, "SharingSettings": { @@ -68532,7 +69675,7 @@ "RStudioServerProAppSettings": { "target": "com.amazonaws.sagemaker#RStudioServerProAppSettings", "traits": { - "smithy.api#documentation": "A collection of settings that configure user interaction with the\n RStudioServerPro app.
A collection of settings that configure user interaction with the\n RStudioServerPro app.
The default experience that the user is directed to when accessing the domain. The supported values are:
\n\n studio::: Indicates that Studio is the default experience. This value can only be passed if StudioWebPortal is set to ENABLED.
\n app:JupyterServer:: Indicates that Studio Classic is the default experience.
The default experience that the user is directed to when accessing the domain. The\n supported values are:
\n\n studio::: Indicates that Studio is the default experience. This value can\n only be passed if StudioWebPortal is set to ENABLED.
\n app:JupyterServer:: Indicates that Studio Classic is the default\n experience.
Whether the user can access Studio. If this value is set to DISABLED, the user cannot access Studio, even if that is the default experience for the domain.
Whether the user can access Studio. If this value is set to DISABLED, the\n user cannot access Studio, even if that is the default experience for the domain.
Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
" + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over\n the settings applied on a domain level.
" } } }, "traits": { - "smithy.api#documentation": "A collection of settings that apply to users in a domain. These settings are\n specified when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.
A collection of settings that apply to users in a domain. These settings are specified\n when the CreateUserProfile API is called, and as DefaultUserSettings\n when the CreateDomain API is called.
\n SecurityGroups is aggregated when specified in both calls. For all other\n settings in UserSettings, the values specified in CreateUserProfile\n take precedence over those specified in CreateDomain.