AWS.Tools.SageMaker.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SageMaker</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SM.AddSMResourceTagCmdlet"> <summary> Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. <para> Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see <a href="https://aws.amazon.com/answers/account-management/aws-tagging-strategies/">AWS Tagging Strategies</a>. </para><note><para> Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the <code>Tags</code> parameter of <a>CreateHyperParameterTuningJob</a></para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMResourceTagCmdlet.Tag"> <summary> <para> <para>An array of <code>Tag</code> objects. Each tag is a key-value pair. Only the <code>key</code> parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.AddTagsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.AddTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Tag parameter. The -PassThru parameter is deprecated, use -Select '^Tag' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmCmdlet"> <summary> Returns a description of the specified algorithm that is in your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmCmdlet.AlgorithmName"> <summary> <para> <para>The name of the algorithm to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeAlgorithmResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeAlgorithmResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AlgorithmName parameter. The -PassThru parameter is deprecated, use -Select '^AlgorithmName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet"> <summary> Lists the machine learning algorithms that have been created.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only algorithms created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only algorithms created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.NameContain"> <summary> <para> <para>A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of algorithms to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <code>ListAlgorithms</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of algorithms, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AlgorithmSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListAlgorithmsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListAlgorithmsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NameContain parameter. The -PassThru parameter is deprecated, use -Select '^NameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAlgorithmListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryCmdlet"> <summary> Gets details about the specified Git repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryCmdlet.CodeRepositoryName"> <summary> <para> <para>The name of the Git repository to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeCodeRepositoryResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeCodeRepositoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CodeRepositoryName parameter. The -PassThru parameter is deprecated, use -Select '^CodeRepositoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet"> <summary> Gets a list of the Git repositories in your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only Git repositories that were created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only Git repositories that were created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only Git repositories that were last modified after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only Git repositories that were last modified before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.NameContain"> <summary> <para> <para>A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>Name</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of Git repositories to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.NextToken"> <summary> <para> <para>If the result of a <code>ListCodeRepositoriesOutput</code> request was truncated, the response includes a <code>NextToken</code>. To get the next set of Git repositories, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CodeRepositorySummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListCodeRepositoriesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListCodeRepositoriesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobCmdlet"> <summary> Returns information about a model compilation job. <para> To create a model compilation job, use <a>CreateCompilationJob</a>. To get information about multiple model compilation jobs, use <a>ListCompilationJobs</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobCmdlet.CompilationJobName"> <summary> <para> <para>The name of the model compilation job that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeCompilationJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeCompilationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CompilationJobName parameter. The -PassThru parameter is deprecated, use -Select '^CompilationJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet"> <summary> Lists model compilation jobs that satisfy various filters. <para> To create a model compilation job, use <a>CreateCompilationJob</a>. To get information about a particular model compilation job you have created, use <a>DescribeCompilationJob</a>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns the model compilation jobs that were created after a specified time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns the model compilation jobs that were created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns the model compilation jobs that were modified after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns the model compilation jobs that were modified before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.NameContain"> <summary> <para> <para>A filter that returns the model compilation jobs whose name contains a specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort results. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves model compilation jobs with a specific <a>DescribeCompilationJobResponse$CompilationJobStatus</a> status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of model compilation jobs to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListCompilationJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model compilation jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CompilationJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListCompilationJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListCompilationJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NameContain parameter. The -PassThru parameter is deprecated, use -Select '^NameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet"> <summary> Lists endpoint configurations.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only endpoint configurations created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.NameContain"> <summary> <para> <para>A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Descending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of training jobs to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListEndpointConfig</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of endpoint configurations, use the token in the next request. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListEndpointConfigsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListEndpointConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointCmdlet"> <summary> Returns the description of an endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointCmdlet.EndpointName"> <summary> <para> <para>The name of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeEndpointResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointConfigCmdlet"> <summary> Returns the description of an endpoint configuration created using the <code>CreateEndpointConfig</code> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointConfigCmdlet.EndpointConfigName"> <summary> <para> <para>The name of the endpoint configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeEndpointConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeEndpointConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointConfigName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet"> <summary> Lists endpoints.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only endpoints that were created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para> A filter that returns only endpoints that were modified after the specified timestamp. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para> A filter that returns only endpoints that were modified before the specified timestamp. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.NameContain"> <summary> <para> <para>A string in endpoint names. This filter returns only endpoints whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.SortBy"> <summary> <para> <para>Sorts the list of results. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Descending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.StatusEqual"> <summary> <para> <para> A filter that returns only endpoints with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of endpoints to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.NextToken"> <summary> <para> <para>If the result of a <code>ListEndpoints</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of endpoints, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListEndpointsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobCmdlet"> <summary> Gets a description of a hyperparameter tuning job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobName"> <summary> <para> <para>The name of the tuning job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeHyperParameterTuningJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeHyperParameterTuningJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HyperParameterTuningJobName parameter. The -PassThru parameter is deprecated, use -Select '^HyperParameterTuningJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet"> <summary> Gets a list of <a>HyperParameterTuningJobSummary</a> objects that describe the hyperparameter tuning jobs launched in your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only tuning jobs that were created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only tuning jobs that were created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only tuning jobs that were modified after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only tuning jobs that were modified before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.NameContain"> <summary> <para> <para>A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>Name</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that returns only tuning jobs with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tuning jobs to return. The default value is 10.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListHyperParameterTuningJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of tuning jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HyperParameterTuningJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListHyperParameterTuningJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListHyperParameterTuningJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobCmdlet"> <summary> Gets information about a labeling job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobCmdlet.LabelingJobName"> <summary> <para> <para>The name of the labeling job to return information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeLabelingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeLabelingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LabelingJobName parameter. The -PassThru parameter is deprecated, use -Select '^LabelingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet"> <summary> Gets a list of labeling jobs.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only labeling jobs created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only labeling jobs created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only labeling jobs modified after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only labeling jobs modified before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.NameContain"> <summary> <para> <para>A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only labeling jobs with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of labeling jobs to return in each page of the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListLabelingJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LabelingJobSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListLabelingJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListLabelingJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NameContain parameter. The -PassThru parameter is deprecated, use -Select '^NameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet"> <summary> Gets a list of labeling jobs assigned to a specified work team.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only labeling jobs created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only labeling jobs created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.JobReferenceCodeContain"> <summary> <para> <para>A filter the limits jobs to only the ones whose job reference code contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.WorkteamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.MaxResult"> <summary> <para> <para>The maximum number of labeling jobs to return in each page of the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListLabelingJobsForWorkteam</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LabelingJobSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListLabelingJobsForWorkteamResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListLabelingJobsForWorkteamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkteamArn parameter. The -PassThru parameter is deprecated, use -Select '^WorkteamArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelCmdlet"> <summary> Describes a model that you created using the <code>CreateModel</code> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCmdlet.ModelName"> <summary> <para> <para>The name of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeModelResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelName parameter. The -PassThru parameter is deprecated, use -Select '^ModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet"> <summary> Lists models created with the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateModel.html">CreateModel</a> API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only models created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.NameContain"> <summary> <para> <para>A string in the training job name. This filter returns only models in the training job whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.SortBy"> <summary> <para> <para>Sorts the list of results. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Descending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of models to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <code>ListModels</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of models, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Models'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageCmdlet"> <summary> Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace. <para> To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageCmdlet.ModelPackageName"> <summary> <para> <para>The name of the model package to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeModelPackageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelPackageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet"> <summary> Lists the model packages that have been created.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only model packages created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only model packages created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.NameContain"> <summary> <para> <para>A string in the model package name. This filter returns only model packages whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of model packages to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <code>ListModelPackages</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of model packages, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelPackageSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelPackagesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelPackagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NameContain parameter. The -PassThru parameter is deprecated, use -Select '^NameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceCmdlet"> <summary> Returns information about a notebook instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the notebook instance that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeNotebookInstanceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeNotebookInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigCmdlet"> <summary> Returns a description of a notebook instance lifecycle configuration. <para> For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigCmdlet.NotebookInstanceLifecycleConfigName"> <summary> <para> <para>The name of the lifecycle configuration to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeNotebookInstanceLifecycleConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeNotebookInstanceLifecycleConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet"> <summary> Lists notebook instance lifestyle configurations created with the <a>CreateNotebookInstanceLifecycleConfig</a> API.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only lifecycle configurations that were created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only lifecycle configurations that were created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.NameContain"> <summary> <para> <para>A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.SortBy"> <summary> <para> <para>Sorts the list of results. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of lifecycle configurations to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.NextToken"> <summary> <para> <para>If the result of a <code>ListNotebookInstanceLifecycleConfigs</code> request was truncated, the response includes a <code>NextToken</code>. To get the next set of lifecycle configurations, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookInstanceLifecycleConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListNotebookInstanceLifecycleConfigsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListNotebookInstanceLifecycleConfigsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceLifecycleConfigListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet"> <summary> Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.AdditionalCodeRepositoryEqual"> <summary> <para> <para>A filter that returns only notebook instances with associated with the specified git repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only notebook instances that were created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only notebook instances that were created before the specified time (timestamp). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.DefaultCodeRepositoryContain"> <summary> <para> <para>A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only notebook instances that were modified after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only notebook instances that were modified before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.NameContain"> <summary> <para> <para>A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.NotebookInstanceLifecycleConfigNameContain"> <summary> <para> <para>A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>Name</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.StatusEqual"> <summary> <para> <para>A filter that returns only notebook instances with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of notebook instances to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.NextToken"> <summary> <para> <para> If the previous call to the <code>ListNotebookInstances</code> is truncated, the response includes a <code>NextToken</code>. You can use this token in your subsequent <code>ListNotebookInstances</code> request to fetch the next set of notebook instances. </para><note><para>You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request. </para></note> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListNotebookInstancesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListNotebookInstancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMNotebookInstanceListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet"> <summary> Returns the tags for the specified Amazon SageMaker resource.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of tags to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet.NextToken"> <summary> <para> <para> If the response to the previous <code>ListTags</code> request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTagsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceTagListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet"> <summary> An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in <code>Search</code> queries. Provides suggestions for <code>HyperParameters</code>, <code>Tags</code>, and <code>Metrics</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet.PropertyNameQuery_PropertyNameHint"> <summary> <para> <para>Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the <code>PropertyNameHint</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet.Resource"> <summary> <para> <para>The name of the Amazon SageMaker resource to Search for. The only valid <code>Resource</code> value is <code>TrainingJob</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PropertyNameSuggestions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.GetSearchSuggestionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.GetSearchSuggestionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Resource parameter. The -PassThru parameter is deprecated, use -Select '^Resource' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamCmdlet"> <summary> Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamCmdlet.WorkteamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the subscribed work team to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SubscribedWorkteam'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeSubscribedWorkteamResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeSubscribedWorkteamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkteamArn parameter. The -PassThru parameter is deprecated, use -Select '^WorkteamArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet"> <summary> Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the <code>NameContains</code> parameter.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet.NameContain"> <summary> <para> <para>A string in the work team name. This filter returns only work teams whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of work teams to return in each page of the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListSubscribedWorkteams</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SubscribedWorkteams'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListSubscribedWorkteamsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListSubscribedWorkteamsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NameContain parameter. The -PassThru parameter is deprecated, use -Select '^NameContain' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSubscribedWorkteamListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobCmdlet"> <summary> Returns information about a training job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobCmdlet.TrainingJobName"> <summary> <para> <para>The name of the training job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeTrainingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeTrainingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrainingJobName parameter. The -PassThru parameter is deprecated, use -Select '^TrainingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet"> <summary> Lists training jobs.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only training jobs created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only training jobs created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only training jobs modified after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only training jobs modified before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.NameContain"> <summary> <para> <para>A string in the training job name. This filter returns only training jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only training jobs with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of training jobs to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListTrainingJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of training jobs, use the token in the next request. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrainingJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTrainingJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListTrainingJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet"> <summary> Gets a list of <a>TrainingJobSummary</a> objects that describe the training jobs that a hyperparameter tuning job launched.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.HyperParameterTuningJobName"> <summary> <para> <para>The name of the tuning job whose training jobs you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>Name</code>.</para><para>If the value of this field is <code>FinalObjectiveMetricValue</code>, any training jobs that did not return an objective metric are not listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that returns only training jobs with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of training jobs to return. The default value is 10.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListTrainingJobsForHyperParameterTuningJob</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of training jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrainingJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTrainingJobsForHyperParameterTuningJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListTrainingJobsForHyperParameterTuningJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HyperParameterTuningJobName parameter. The -PassThru parameter is deprecated, use -Select '^HyperParameterTuningJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobsForHyperParameterTuningJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobCmdlet"> <summary> Returns information about a transform job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobCmdlet.TransformJobName"> <summary> <para> <para>The name of the transform job that you want to view details of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeTransformJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeTransformJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransformJobName parameter. The -PassThru parameter is deprecated, use -Select '^TransformJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet"> <summary> Lists transform jobs.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only transform jobs created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only transform jobs created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only transform jobs modified after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only transform jobs modified before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.NameContain"> <summary> <para> <para>A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Descending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only transform jobs with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of transform jobs to return in the response. The default value is <code>10</code>.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListTransformJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of transform jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TransformJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTransformJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListTransformJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamCmdlet"> <summary> Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamCmdlet.WorkteamName"> <summary> <para> <para>The name of the work team to return a description of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workteam'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeWorkteamResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeWorkteamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkteamName parameter. The -PassThru parameter is deprecated, use -Select '^WorkteamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet"> <summary> Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the <code>NameContains</code> parameter.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.NameContain"> <summary> <para> <para>A string in the work team's name. This filter returns only work teams whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <code>CreationTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <code>Ascending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of work teams to return in each page of the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <code>ListWorkteams</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workteams'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListWorkteamsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListWorkteamsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet"> <summary> Renders the UI template so that you can preview the worker's experience. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet.UiTemplate_Content"> <summary> <para> <para>The content of the Liquid template for the worker user interface.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet.Task_Input"> <summary> <para> <para>A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable <code>task.input</code>. For example, if you define a variable <code>task.input.text</code> in your template, you can supply the variable in the JSON object as <code>"text": "sample text"</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.RenderUiTemplateResponse). Specifying the name of a property of type Amazon.SageMaker.Model.RenderUiTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UiTemplate_Content parameter. The -PassThru parameter is deprecated, use -Select '^UiTemplate_Content' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.InvokeSMUiTemplateRenderingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet"> <summary> Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.AlgorithmDescription"> <summary> <para> <para>A description of the algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.AlgorithmName"> <summary> <para> <para>The name of the algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.CertifyForMarketplace"> <summary> <para> <para>Whether to certify the algorithm so that it can be listed in AWS Marketplace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.InferenceSpecification_Container"> <summary> <para> <para>The Amazon ECR registry path of the Docker image that contains the inference code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_MetricDefinition"> <summary> <para> <para>A list of <code>MetricDefinition</code> objects, which are used for parsing metrics generated by the algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.InferenceSpecification_SupportedContentType"> <summary> <para> <para>The supported MIME types for the input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_SupportedHyperParameter"> <summary> <para> <para>A list of the <code>HyperParameterSpecification</code> objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.InferenceSpecification_SupportedRealtimeInferenceInstanceType"> <summary> <para> <para>A list of the instance types that are used to generate inferences in real-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.InferenceSpecification_SupportedResponseMIMEType"> <summary> <para> <para>The supported MIME types for the output data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_SupportedTrainingInstanceType"> <summary> <para> <para>A list of the instance types that this algorithm can use for training.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.InferenceSpecification_SupportedTransformInstanceType"> <summary> <para> <para>A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_SupportedTuningJobObjectiveMetric"> <summary> <para> <para>A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_SupportsDistributedTraining"> <summary> <para> <para>Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_TrainingChannel"> <summary> <para> <para>A list of <code>ChannelSpecification</code> objects, which specify the input sources to be used by the algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_TrainingImage"> <summary> <para> <para>The Amazon ECR registry path of the Docker image that contains the training algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_TrainingImageDigest"> <summary> <para> <para>An MD5 hash of the training algorithm that identifies the Docker image used for training.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.ValidationSpecification_ValidationProfile"> <summary> <para> <para>An array of <code>AlgorithmValidationProfile</code> objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.ValidationSpecification_ValidationRole"> <summary> <para> <para>The IAM roles that Amazon SageMaker uses to run the training jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AlgorithmArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAlgorithmResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAlgorithmResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AlgorithmName parameter. The -PassThru parameter is deprecated, use -Select '^AlgorithmName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet"> <summary> Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. <para> The repository can be hosted either in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit</a> or in any other Git repository. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.GitConfig_Branch"> <summary> <para> <para>The default branch for the Git repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.CodeRepositoryName"> <summary> <para> <para>The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.GitConfig_RepositoryUrl"> <summary> <para> <para>The URL where the Git repository is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.GitConfig_SecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of <code>AWSCURRENT</code> and must be in the following format:</para><para><code>{"username": <i>UserName</i>, "password": <i>Password</i>}</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CodeRepositoryArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateCodeRepositoryResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateCodeRepositoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CodeRepositoryName parameter. The -PassThru parameter is deprecated, use -Select '^CodeRepositoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet"> <summary> Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. <para> If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource. </para><para> In the request body, you provide the following: </para><ul><li><para> A name for the compilation job </para></li><li><para> Information about the input model artifacts </para></li><li><para> The output location for the compiled model and the device (target) that the model runs on </para></li><li><para><code>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job</code></para></li></ul><para> You can also provide a <code>Tag</code> to track the model compilation job's resource use and costs. The response body contains the <code>CompilationJobArn</code> for the compiled job. </para><para> To stop a model compilation job, use <a>StopCompilationJob</a>. To get information about a particular model compilation job, use <a>DescribeCompilationJob</a>. To get information about multiple model compilation jobs, use <a>ListCompilationJobs</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.CompilationJobName"> <summary> <para> <para>A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.InputConfig_DataInputConfig"> <summary> <para> <para>Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are <a>InputConfig$Framework</a> specific. </para><ul><li><para><code>TensorFlow</code>: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.</para><ul><li><para>Examples for one input:</para><ul><li><para>If using the console, <code>{"input":[1,1024,1024,3]}</code></para></li><li><para>If using the CLI, <code>{\"input\":[1,1024,1024,3]}</code></para></li></ul></li><li><para>Examples for two inputs:</para><ul><li><para>If using the console, <code>{"data1": [1,28,28,1], "data2":[1,28,28,1]}</code></para></li><li><para>If using the CLI, <code>{\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}</code></para></li></ul></li></ul></li><li><para><code>MXNET/ONNX</code>: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.</para><ul><li><para>Examples for one input:</para><ul><li><para>If using the console, <code>{"data":[1,3,1024,1024]}</code></para></li><li><para>If using the CLI, <code>{\"data\":[1,3,1024,1024]}</code></para></li></ul></li><li><para>Examples for two inputs:</para><ul><li><para>If using the console, <code>{"var1": [1,1,28,28], "var2":[1,1,28,28]} </code></para></li><li><para>If using the CLI, <code>{\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}</code></para></li></ul></li></ul></li><li><para><code>PyTorch</code>: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.</para><ul><li><para>Examples for one input in dictionary format:</para><ul><li><para>If using the console, <code>{"input0":[1,3,224,224]}</code></para></li><li><para>If using the CLI, <code>{\"input0\":[1,3,224,224]}</code></para></li></ul></li><li><para>Example for one input in list format: <code>[[1,3,224,224]]</code></para></li><li><para>Examples for two inputs in dictionary format:</para><ul><li><para>If using the console, <code>{"input0":[1,3,224,224], "input1":[1,3,224,224]}</code></para></li><li><para>If using the CLI, <code>{\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} </code></para></li></ul></li><li><para>Example for two inputs in list format: <code>[[1,3,224,224], [1,3,224,224]]</code></para></li></ul></li><li><para><code>XGBOOST</code>: input data name and shape are not needed.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.InputConfig_Framework"> <summary> <para> <para>Identifies the framework in which the model was trained. For example: TENSORFLOW.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.StoppingCondition_MaxWaitTimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than <code>MaxRuntimeInSeconds</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. </para><para>During model compilation, Amazon SageMaker needs your permission to:</para><ul><li><para>Read input data from an S3 bucket</para></li><li><para>Write model artifacts to an S3 bucket</para></li><li><para>Write logs to Amazon CloudWatch Logs</para></li><li><para>Publish metrics to Amazon CloudWatch</para></li></ul><para>You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles.</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.OutputConfig_S3OutputLocation"> <summary> <para> <para>Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.InputConfig_S3Uri"> <summary> <para> <para>The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.OutputConfig_TargetDevice"> <summary> <para> <para>Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CompilationJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateCompilationJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateCompilationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CompilationJobName parameter. The -PassThru parameter is deprecated, use -Select '^CompilationJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet"> <summary> Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html">CreateEndpointConfig</a> API. <note><para> Use this API only for hosting models using Amazon SageMaker hosting services. </para><para> You must not delete an <code>EndpointConfig</code> in use by an endpoint that is live or while the <code>UpdateEndpoint</code> or <code>CreateEndpoint</code> operations are being performed on the endpoint. To update an endpoint, you must create a new <code>EndpointConfig</code>. </para></note><para> The endpoint name must be unique within an AWS Region in your AWS account. </para><para> When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. </para><para> When Amazon SageMaker receives the request, it sets the endpoint status to <code>Creating</code>. After it creates the endpoint, it sets the status to <code>InService</code>. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_DescribeEndpoint.html">DescribeEndpoint</a> API. </para><para> For an example, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ex1.html">Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker</a>. </para><para> If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see <a href="IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS i an AWS Region</a> in the <i>AWS Identity and Access Management User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.EndpointConfigName"> <summary> <para> <para>The name of an endpoint configuration. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html">CreateEndpointConfig</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.EndpointName"> <summary> <para> <para>The name of the endpoint. The name must be unique within an AWS Region in your AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a>in the <i>AWS Billing and Cost Management User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateEndpointResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointConfigName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet"> <summary> Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the <code>CreateModel</code> API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html">CreateEndpoint</a> API. <note><para> Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production. </para></note><para> In the request, you define one or more <code>ProductionVariant</code>s, each of which identifies a model. Each <code>ProductionVariant</code> parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy. </para><para> If you are hosting multiple models, you also assign a <code>VariantWeight</code> to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.EndpointConfigName"> <summary> <para> <para>The name of the endpoint configuration. You specify this name in a <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpoint.html">CreateEndpoint</a> request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.</para><note><para>Nitro-based instances do not support encryption with AWS KMS. If any of the models that you specify in the <code>ProductionVariants</code> parameter use nitro-based instances, do not specify a value for the <code>KmsKeyId</code> parameter. If you specify a value for <code>KmsKeyId</code> when using any nitro-based instances, the call to <code>CreateEndpointConfig</code> fails.</para><para>For a list of nitro-based instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Nitro-based Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>.</para><para>For more information about storage volumes on nitro-based instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nvme-ebs-volumes.html">Amazon EBS and NVMe on Linux Instances</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ProductionVariant"> <summary> <para> <para>An list of <code>ProductionVariant</code> objects, one for each model that you want to host at this endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> AWS Billing and Cost Management User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointConfigArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateEndpointConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateEndpointConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointConfigName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet"> <summary> Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.AlgorithmSpecification_AlgorithmName"> <summary> <para> <para>The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for <code>TrainingImage</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_CategoricalParameterRange"> <summary> <para> <para>The array of <a>CategoricalParameterRange</a> objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_ContinuousParameterRange"> <summary> <para> <para>The array of <a>ContinuousParameterRange</a> objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_EnableInterContainerTrafficEncryption"> <summary> <para> <para>To encrypt all communications between ML compute instances in distributed training, choose <code>True</code>. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_EnableManagedSpotTraining"> <summary> <para> <para>A Boolean indicating whether managed spot training is enabled (<code>True</code>) or not (<code>False</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_EnableNetworkIsolation"> <summary> <para> <para>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</para><note><para>The Semantic Segmentation built-in algorithm does not support network isolation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobName"> <summary> <para> <para>The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_InputDataConfig"> <summary> <para> <para>An array of <a>Channel</a> objects that specify the input for the training jobs that the tuning job launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_IntegerParameterRange"> <summary> <para> <para>The array of <a>IntegerParameterRange</a> objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.CheckpointConfig_LocalPath"> <summary> <para> <para>(Optional) The local directory where checkpoints are written. The default directory is <code>/opt/ml/checkpoints/</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ResourceLimits_MaxNumberOfTrainingJob"> <summary> <para> <para>The maximum number of training jobs that a hyperparameter tuning job can launch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ResourceLimits_MaxParallelTrainingJob"> <summary> <para> <para>The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.StoppingCondition_MaxWaitTimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than <code>MaxRuntimeInSeconds</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.AlgorithmSpecification_MetricDefinition"> <summary> <para> <para>An array of <a>MetricDefinition</a> objects that specify the metrics that the algorithm emits.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobObjective_MetricName"> <summary> <para> <para>The name of the metric to use for the objective metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_OutputDataConfig"> <summary> <para> <para>Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.WarmStartConfig_ParentHyperParameterTuningJob"> <summary> <para> <para>An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-warm-start.html">Using a Previous Hyperparameter Tuning Job as a Starting Point</a>.</para><para>Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_ResourceConfig"> <summary> <para> <para>The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.</para><para>Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose <code>File</code> as the <code>TrainingInputMode</code> in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.CheckpointConfig_S3Uri"> <summary> <para> <para>Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, <code>s3://bucket-name/key-name-prefix</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the <code>Subnets</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_StaticHyperParameter"> <summary> <para> <para>Specifies the values of hyperparameters that do not change for the tuning job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobConfig_Strategy"> <summary> <para> <para>Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to <code>Bayesian</code>. To randomly search, set it to <code>Random</code>. For information about search strategies, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How Hyperparameter Tuning Works</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. </para><note><para>Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/https:/aws.amazon.com/answers/account-management/aws-tagging-strategies/">AWS Tagging Strategies</a>.</para><para>Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.AlgorithmSpecification_TrainingImage"> <summary> <para> <para> The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html">Algorithms Provided by Amazon SageMaker: Common Parameters</a>. Amazon SageMaker supports both <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code> image path formats. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon SageMaker</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.AlgorithmSpecification_TrainingInputMode"> <summary> <para> <para>The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container. </para><para>If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.</para><para>For more information about input modes, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobConfig_TrainingJobEarlyStoppingType"> <summary> <para> <para>Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is <code>OFF</code>):</para><dl><dt>OFF</dt><dd><para>Training jobs launched by the hyperparameter tuning job do not use early stopping.</para></dd><dt>AUTO</dt><dd><para>Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html">Stop Training Jobs Early</a>.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobObjective_Type"> <summary> <para> <para>Whether to minimize or maximize the objective metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.WarmStartConfig_WarmStartType"> <summary> <para> <para>Specifies one of the following:</para><dl><dt>IDENTICAL_DATA_AND_ALGORITHM</dt><dd><para>The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.</para></dd><dt>TRANSFER_LEARNING</dt><dd><para>The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HyperParameterTuningJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateHyperParameterTuningJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateHyperParameterTuningJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HyperParameterTuningJobName parameter. The -PassThru parameter is deprecated, use -Select '^HyperParameterTuningJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet"> <summary> Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. <para> You can select your workforce from one of three providers: </para><ul><li><para> A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required. </para></li><li><para> One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas. </para></li><li><para> The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information. </para></li></ul><para> You can also use <i>automated data labeling</i> to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses <i>active learning</i> to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-automated-labeling.html">Using Automated Data Labeling</a>. </para><para> The data objects to be labeled are contained in an Amazon S3 bucket. You create a <i>manifest file</i> that describes the location of each object. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-data.html">Using Input and Output Data</a>. </para><para> The output can be used as the manifest file for another labeling job or as training data for your machine learning models. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.AnnotationConsolidationConfig_AnnotationConsolidationLambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.</para><para>For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:</para><ul><li><para><i>Bounding box</i> - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.</para><para><code>arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox</code></para><para><code>arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox</code></para></li><li><para><i>Image classification</i> - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.</para><para><code>arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass</code></para><para><code>arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass</code></para></li><li><para><i>Semantic segmentation</i> - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.</para><para><code>arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation</code></para><para><code>arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation</code></para></li><li><para><i>Text classification</i> - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.</para><para><code>arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass</code></para><para><code>arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass</code></para></li><li><para><i>Named entity eecognition</i> - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.</para><para><code>arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition</code></para><para><code>arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition</code></para></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html">Annotation Consolidation</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.AmountInUsd_Cent"> <summary> <para> <para>The fractional portion, in cents, of the amount. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.DataAttributes_ContentClassifier"> <summary> <para> <para>Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.AmountInUsd_Dollar"> <summary> <para> <para>The whole number of dollars in the amount.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelingJobAlgorithmsConfig_InitialActiveLearningModelArn"> <summary> <para> <para>At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The AWS Key Management Service ID of the key used to encrypt the output data, if any.</para><para>If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call <code>kms:Encrypt</code>. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for <code>LabelingJobOutputConfig</code>. If you use a bucket policy with an <code>s3:PutObject</code> permission that only allows objects with server-side encryption, set the condition key of <code>s3:x-amz-server-side-encryption</code> to <code>"aws:kms"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">KMS-Managed Encryption Keys</a> in the <i>Amazon Simple Storage Service Developer Guide.</i></para><para>The KMS key policy must grant permission to the IAM role that you specify in your <code>CreateLabelingJob</code> request. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Using Key Policies in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelAttributeName"> <summary> <para> <para>The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with "-metadata". If you are running a semantic segmentation labeling job, the attribute name must end with "-ref". If you are running any other kind of labeling job, the attribute name must not end with "-ref".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelCategoryConfigS3Uri"> <summary> <para> <para>The S3 URL of the file that defines the categories used to label the data objects.</para><para>The file is a JSON structure in the following format:</para><para><code>{</code></para><para><code> "document-version": "2018-11-28"</code></para><para><code> "labels": [</code></para><para><code> {</code></para><para><code> "label": "<i>label 1</i>"</code></para><para><code> },</code></para><para><code> {</code></para><para><code> "label": "<i>label 2</i>"</code></para><para><code> },</code></para><para><code> ...</code></para><para><code> {</code></para><para><code> "label": "<i>label n</i>"</code></para><para><code> }</code></para><para><code> ]</code></para><para><code>}</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelingJobAlgorithmsConfig_LabelingJobAlgorithmSpecificationArn"> <summary> <para> <para>Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:</para><ul><li><para><i>Image classification</i></para><para><code>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/image-classification</code></para></li><li><para><i>Text classification</i></para><para><code>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/text-classification</code></para></li><li><para><i>Object detection</i></para><para><code>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/object-detection</code></para></li><li><para><i>Semantic Segmentation</i></para><para><code>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/semantic-segmentation</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelingJobName"> <summary> <para> <para>The name of the labeling job. This name is used to identify the job in a list of labeling jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.S3DataSource_ManifestS3Uri"> <summary> <para> <para>The Amazon S3 location of the manifest file that describes the input data objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_MaxConcurrentTaskCount"> <summary> <para> <para>Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.StoppingConditions_MaxHumanLabeledObjectCount"> <summary> <para> <para>The maximum number of objects that can be labeled by human workers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.StoppingConditions_MaxPercentageOfInputDatasetLabeled"> <summary> <para> <para>The maximum number of input data objects that should be labeled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_NumberOfHumanWorkersPerDataObject"> <summary> <para> <para>The number of human workers that will label an object. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_PreHumanTaskLambdaArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.</para><para>For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:</para><para><b>US East (Northern Virginia) (us-east-1):</b></para><ul><li><para><code>arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox</code></para></li><li><para><code>arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>US East (Ohio) (us-east-2):</b></para><ul><li><para><code>arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox</code></para></li><li><para><code>arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>US West (Oregon) (us-west-2):</b></para><ul><li><para><code>arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox</code></para></li><li><para><code>arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>Canada (Central) (ca-central-1):</b></para><ul><li><para><code>arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox</code></para></li><li><para><code>arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>EU (Ireland) (eu-west-1):</b></para><ul><li><para><code>arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox</code></para></li><li><para><code>arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>EU (London) (eu-west-2):</b></para><ul><li><para><code>arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox</code></para></li><li><para><code>arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>EU Frankfurt (eu-central-1):</b></para><ul><li><para><code>arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox</code></para></li><li><para><code>arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>Asia Pacific (Tokyo) (ap-northeast-1):</b></para><ul><li><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox</code></para></li><li><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>Asia Pacific (Seoul) (ap-northeast-2):</b></para><ul><li><para><code>arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox</code></para></li><li><para><code>arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>Asia Pacific (Mumbai) (ap-south-1):</b></para><ul><li><para><code>arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox</code></para></li><li><para><code>arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>Asia Pacific (Singapore) (ap-southeast-1):</b></para><ul><li><para><code>arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox</code></para></li><li><para><code>arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition</code></para></li></ul><para><b>Asia Pacific (Sydney) (ap-southeast-2):</b></para><ul><li><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox</code></para></li><li><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass</code></para></li><li><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation</code></para></li><li><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass</code></para></li><li><para><code>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.OutputConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 location to write output data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.Tag"> <summary> <para> <para>An array of key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_TaskAvailabilityLifetimeInSecond"> <summary> <para> <para>The length of time that a task remains available for labeling by human workers. <b>If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200)</b>. For private and vendor workforces, the maximum is as listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_TaskDescription"> <summary> <para> <para>A description of the task for your human workers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_TaskKeyword"> <summary> <para> <para>Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_TaskTimeLimitInSecond"> <summary> <para> <para>The amount of time that a worker has to complete a task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_TaskTitle"> <summary> <para> <para>A title for the task for your human workers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.AmountInUsd_TenthFractionsOfACent"> <summary> <para> <para>Fractions of a cent, in tenths.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.UiConfig_UiTemplateS3Uri"> <summary> <para> <para>The Amazon S3 bucket location of the UI template. For more information about the contents of a UI template, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step2.html"> Creating Your Custom Labeling Task Template</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelingJobResourceConfig_VolumeKmsKeyId"> <summary> <para> <para>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The <code>VolumeKmsKeyId</code> can be any of the following formats:</para><ul><li><para>// KMS Key ID</para><para><code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key</para><para><code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.HumanTaskConfig_WorkteamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LabelingJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateLabelingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateLabelingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LabelingJobName parameter. The -PassThru parameter is deprecated, use -Select '^LabelingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet"> <summary> Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and custom environment map that the inference code uses when you deploy the model for predictions. <para> Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job. </para><para> To host your model, you create an endpoint configuration with the <code>CreateEndpointConfig</code> API, and then create an endpoint with the <code>CreateEndpoint</code> API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment. </para><para> To run a batch transform using your model, you start a job with the <code>CreateTransformJob</code> API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. </para><para> In the <code>CreateModel</code> request, you must define a container with the <code>PrimaryContainer</code> parameter. </para><para> In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.Container"> <summary> <para> <para>Specifies the containers in the inference pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.EnableNetworkIsolation"> <summary> <para> <para>Isolates the model container. No inbound or outbound network calls can be made to or from the model container.</para><note><para>The Semantic Segmentation built-in algorithm does not support network isolation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles</a>. </para><note><para>To be able to pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.ModelName"> <summary> <para> <para>The name of the new model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.PrimaryContainer"> <summary> <para> <para>The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the <code>Subnets</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. </para><note><para>Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrimaryContainer parameter. The -PassThru parameter is deprecated, use -Select '^PrimaryContainer' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet"> <summary> Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker. <para> To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for <code>InferenceSpecification</code>. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for <code>SourceAlgorithmSpecification</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.CertifyForMarketplace"> <summary> <para> <para>Whether to certify the model package for listing on AWS Marketplace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.InferenceSpecification_Container"> <summary> <para> <para>The Amazon ECR registry path of the Docker image that contains the inference code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelPackageDescription"> <summary> <para> <para>A description of the model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelPackageName"> <summary> <para> <para>The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.SourceAlgorithmSpecification_SourceAlgorithm"> <summary> <para> <para>A list of the algorithms that were used to create a model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.InferenceSpecification_SupportedContentType"> <summary> <para> <para>The supported MIME types for the input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.InferenceSpecification_SupportedRealtimeInferenceInstanceType"> <summary> <para> <para>A list of the instance types that are used to generate inferences in real-time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.InferenceSpecification_SupportedResponseMIMEType"> <summary> <para> <para>The supported MIME types for the output data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.InferenceSpecification_SupportedTransformInstanceType"> <summary> <para> <para>A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ValidationSpecification_ValidationProfile"> <summary> <para> <para>An array of <code>ModelPackageValidationProfile</code> objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ValidationSpecification_ValidationRole"> <summary> <para> <para>The IAM roles to be used for the validation of the model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelPackageArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelPackageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelPackageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet"> <summary> Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. <para> In a <code>CreateNotebookInstance</code> request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. </para><para> Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework. </para><para> After receiving the request, Amazon SageMaker does the following: </para><ol><li><para> Creates a network interface in the Amazon SageMaker VPC. </para></li><li><para> (Option) If you specified <code>SubnetId</code>, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. </para></li><li><para> Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified <code>SubnetId</code> of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. </para></li></ol><para> After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. </para><para> After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models. </para><para> For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html">How It Works</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.AcceleratorType"> <summary> <para> <para>A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html">Using Elastic Inference in Amazon SageMaker</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.AdditionalCodeRepository"> <summary> <para> <para>An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href="codecommit/latest/userguide/welcome.html">AWS CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with Amazon SageMaker Notebook Instances</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.DefaultCodeRepository"> <summary> <para> <para>A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with Amazon SageMaker Notebook Instances</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.DirectInternetAccess"> <summary> <para> <para>Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to <code>Disabled</code> this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC.</para><para>For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access">Notebook Instances Are Internet-Enabled by Default</a>. You can set the value of this parameter to <code>Disabled</code> only if you set a value for the <code>SubnetId</code> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.InstanceType"> <summary> <para> <para>The type of ML compute instance to launch for the notebook instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html">Enabling and Disabling Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.LifecycleConfigName"> <summary> <para> <para>The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the new notebook instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.RoleArn"> <summary> <para> <para> When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissionsto to assume this role. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles</a>. </para><note><para>To be able to pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.RootAccess"> <summary> <para> <para>Whether root access is enabled or disabled for users of the notebook instance. The default value is <code>Enabled</code>.</para><note><para>Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.SubnetId"> <summary> <para> <para>The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the notebook instance. You can add tags later by using the <code>CreateTags</code> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.VolumeSizeInGB"> <summary> <para> <para>The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookInstanceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateNotebookInstanceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateNotebookInstanceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet"> <summary> Creates a lifecycle configuration that you can associate with a notebook instance. A <i>lifecycle configuration</i> is a collection of shell scripts that run when you create or start a notebook instance. <para> Each lifecycle configuration script has a limit of 16384 characters. </para><para> The value of the <code>$PATH</code> environment variable that is available to both scripts is <code>/sbin:bin:/usr/sbin:/usr/bin</code>. </para><para> View CloudWatch Logs for notebook instance lifecycle configurations in log group <code>/aws/sagemaker/NotebookInstances</code> in log stream <code>[notebook-instance-name]/[LifecycleConfigHook]</code>. </para><para> Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started. </para><para> For information about notebook instance lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet.NotebookInstanceLifecycleConfigName"> <summary> <para> <para>The name of the lifecycle configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet.OnCreate"> <summary> <para> <para>A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet.OnStart"> <summary> <para> <para>A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotebookInstanceLifecycleConfigArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateNotebookInstanceLifecycleConfigResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceLifecycleConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedNotebookInstanceUrlCmdlet"> <summary> Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose <code>Open</code> next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. <para> IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the <code>NotIpAddress</code> condition operator and the <code>aws:SourceIP</code> condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-ip-filter.html">Limit Access to a Notebook Instance by IP Address</a>. </para><note><para> The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedNotebookInstanceUrlCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the notebook instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedNotebookInstanceUrlCmdlet.SessionExpirationDurationInSecond"> <summary> <para> <para>The duration of the session, in seconds. The default is 12 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedNotebookInstanceUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AuthorizedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreatePresignedNotebookInstanceUrlResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreatePresignedNotebookInstanceUrlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedNotebookInstanceUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedNotebookInstanceUrlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet"> <summary> Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. <para> If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences. </para><para> In the request body, you provide the following: </para><ul><li><para><code>AlgorithmSpecification</code> - Identifies the training algorithm to use. </para></li><li><para><code>HyperParameters</code> - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </para></li><li><para><code>InputDataConfig</code> - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. </para></li><li><para><code>OutputDataConfig</code> - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training. </para></li><li><para><code>ResourceConfig</code> - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. </para></li><li><para><code>EnableManagedSpotTraining</code> - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html">Managed Spot Training</a>. </para></li><li><para><code>RoleARN</code> - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. </para></li><li><para><code>StoppingCondition</code> - To help cap training costs, use <code>MaxRuntimeInSeconds</code> to set a time limit for training. Use <code>MaxWaitTimeInSeconds</code> to specify how long you are willing to to wait for a managed spot training job to complete. </para></li></ul><para> For more information about Amazon SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html">How It Works</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.AlgorithmSpecification"> <summary> <para> <para>The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. For information about providing your own algorithms, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html">Using Your Own Algorithms with Amazon SageMaker</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.EnableInterContainerTrafficEncryption"> <summary> <para> <para>To encrypt all communications between ML compute instances in distributed training, choose <code>True</code>. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html">Protect Communications Between ML Compute Instances in a Distributed Training Job</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.EnableManagedSpotTraining"> <summary> <para> <para>To train models using managed spot training, choose <code>True</code>. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run. </para><para>The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.EnableNetworkIsolation"> <summary> <para> <para>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</para><note><para>The Semantic Segmentation built-in algorithm does not support network isolation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.HyperParameter"> <summary> <para> <para>Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </para><para>You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the <code>Length Constraint</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.InputDataConfig"> <summary> <para> <para>An array of <code>Channel</code> objects. Each channel is a named input source. <code>InputDataConfig</code> describes the input data and its location. </para><para>Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, <code>training_data</code> and <code>validation_data</code>. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. </para><para>Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.CheckpointConfig_LocalPath"> <summary> <para> <para>(Optional) The local directory where checkpoints are written. The default directory is <code>/opt/ml/checkpoints/</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.StoppingCondition_MaxWaitTimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than <code>MaxRuntimeInSeconds</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.OutputDataConfig"> <summary> <para> <para>Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ResourceConfig"> <summary> <para> <para>The resources, including the ML compute instances and ML storage volumes, to use for model training. </para><para>ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose <code>File</code> as the <code>TrainingInputMode</code> in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. </para><para>During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles</a>. </para><note><para>To be able to pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.CheckpointConfig_S3Uri"> <summary> <para> <para>Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, <code>s3://bucket-name/key-name-prefix</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the <code>Subnets</code> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. </para><note><para>Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.TrainingJobName"> <summary> <para> <para>The name of the training job. The name must be unique within an AWS Region in an AWS account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrainingJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateTrainingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateTrainingJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrainingJobName parameter. The -PassThru parameter is deprecated, use -Select '^TrainingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet"> <summary> Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. <para> To perform batch transformations, you create a transform job and use the data that you have readily available. </para><para> In the request body, you provide the following: </para><ul><li><para><code>TransformJobName</code> - Identifies the transform job. The name must be unique within an AWS Region in an AWS account. </para></li><li><para><code>ModelName</code> - Identifies the model to use. <code>ModelName</code> must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see <a>CreateModel</a>. </para></li><li><para><code>TransformInput</code> - Describes the dataset to be transformed and the Amazon S3 location where it is stored. </para></li><li><para><code>TransformOutput</code> - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. </para></li><li><para><code>TransformResources</code> - Identifies the ML compute instances for the transform job. </para></li></ul><para> For more information about how batch transformation works Amazon SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">How It Works</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformOutput_Accept"> <summary> <para> <para>The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformOutput_AssembleWith"> <summary> <para> <para>Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify <code>None</code>. To add a newline character at the end of every transformed record, specify <code>Line</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.BatchStrategy"> <summary> <para> <para>Specifies the number of records to include in a mini-batch for an HTTP inference request. A <i>record</i><i /> is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record. </para><para>To enable the batch strategy, you must set <code>SplitType</code> to <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</para><para>To use only one record when making an HTTP invocation request to a container, set <code>BatchStrategy</code> to <code>SingleRecord</code> and <code>SplitType</code> to <code>Line</code>.</para><para>To fit as many records in a mini-batch as can fit within the <code>MaxPayloadInMB</code> limit, set <code>BatchStrategy</code> to <code>MultiRecord</code> and <code>SplitType</code> to <code>Line</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformInput_CompressionType"> <summary> <para> <para>If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is <code>None</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformInput_ContentType"> <summary> <para> <para>The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.Environment"> <summary> <para> <para>The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.DataProcessing_InputFilter"> <summary> <para> <para>A <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators">JSONPath</a> expression used to select a portion of the input data to pass to the algorithm. Use the <code>InputFilter</code> parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value <code>$</code>.</para><para>Examples: <code>"$"</code>, <code>"$[1:]"</code>, <code>"$.features"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformResources_InstanceCount"> <summary> <para> <para>The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is <code>1</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformResources_InstanceType"> <summary> <para> <para>The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or <code>ml.m5.large</code> instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.DataProcessing_JoinSource"> <summary> <para> <para>Specifies the source of the data to join with the transformed data. The valid values are <code>None</code> and <code>Input</code> The default value is <code>None</code> which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set <code>JoinSource</code> to <code>Input</code>. </para><para>For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called <code>SageMakerOutput</code>. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the <code>SageMakerInput</code> key and the results are stored in <code>SageMakerOutput</code>.</para><para>For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformOutput_KmsKeyId"> <summary> <para> <para>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The <code>KmsKeyId</code> can be any of the following formats: </para><ul><li><para>// KMS Key ID</para><para><code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key</para><para><code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>// KMS Key Alias</para><para><code>"alias/ExampleAlias"</code></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key Alias</para><para><code>"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"</code></para></li></ul><para>If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">KMS-Managed Encryption Keys</a> in the <i>Amazon Simple Storage Service Developer Guide.</i></para><para>The KMS key policy must grant permission to the IAM role that you specify in your <code>CreateTramsformJob</code> request. For more information, see <a href="http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Using Key Policies in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.MaxConcurrentTransform"> <summary> <para> <para>The maximum number of parallel requests that can be sent to each instance in a transform job. If <code>MaxConcurrentTransforms</code> is set to <code>0</code> or left unset, Amazon SageMaker checks the optional execution-parameters to determine the optimal settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is <code>1</code>. For more information on execution-parameters, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests">How Containers Serve Requests</a>. For built-in algorithms, you don't need to set a value for <code>MaxConcurrentTransforms</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.MaxPayloadInMB"> <summary> <para> <para>The maximum allowed size of the payload, in MB. A <i>payload</i> is the data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code> must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is <code>6</code> MB. </para><para>For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to <code>0</code>. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.ModelName"> <summary> <para> <para>The name of the model that you want to use for the transform job. <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.DataProcessing_OutputFilter"> <summary> <para> <para>A <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators">JSONPath</a> expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, <code>$</code>. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.</para><para>Examples: <code>"$"</code>, <code>"$[0,5:]"</code>, <code>"$['id','SageMakerOutput']"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.S3DataSource_S3DataType"> <summary> <para> <para>If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform. </para><para>If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform. </para><para>The following values are compatible: <code>ManifestFile</code>, <code>S3Prefix</code></para><para>The following value is not compatible: <code>AugmentedManifestFile</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformOutput_S3OutputPath"> <summary> <para> <para>The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, <code>s3://bucket-name/key-name-prefix</code>.</para><para>For every S3 object used as input for the transform job, batch transform stores the transformed data with an .<code>out</code> suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at <code>s3://bucket-name/input-name-prefix/dataset01/data.csv</code>, batch transform stores the transformed data at <code>s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out</code>. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .<code>out</code> file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.S3DataSource_S3Uri"> <summary> <para> <para>Depending on the value specified for the <code>S3DataType</code>, identifies either a key name prefix or a manifest. For example:</para><ul><li><para> A key name prefix might look like this: <code>s3://bucketname/exampleprefix</code>. </para></li><li><para> A manifest might look like this: <code>s3://bucketname/example.manifest</code></para><para> The manifest is an S3 object which is a JSON file with the following format: </para><para><code>[</code></para><para><code> {"prefix": "s3://customer_bucket/some/prefix/"},</code></para><para><code> "relative/path/to/custdata-1",</code></para><para><code> "relative/path/custdata-2",</code></para><para><code> ...</code></para><para><code> ]</code></para><para> The preceding JSON matches the following <code>S3Uris</code>: </para><para><code>s3://customer_bucket/some/prefix/relative/path/to/custdata-1</code></para><para><code>s3://customer_bucket/some/prefix/relative/path/custdata-1</code></para><para><code>...</code></para><para> The complete set of <code>S3Uris</code> in this manifest constitutes the input data for the channel for this datasource. The object that each <code>S3Uris</code> points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformInput_SplitType"> <summary> <para> <para>The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for <code>SplitType</code> is <code>None</code>, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to <code>Line</code> to split records on a newline character boundary. <code>SplitType</code> also supports a number of record-oriented binary data formats.</para><para>When splitting is enabled, the size of a mini-batch depends on the values of the <code>BatchStrategy</code> and <code>MaxPayloadInMB</code> parameters. When the value of <code>BatchStrategy</code> is <code>MultiRecord</code>, Amazon SageMaker sends the maximum number of records in each request, up to the <code>MaxPayloadInMB</code> limit. If the value of <code>BatchStrategy</code> is <code>SingleRecord</code>, Amazon SageMaker sends individual records in each request.</para><note><para>Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of <code>BatchStrategy</code> is set to <code>SingleRecord</code>. Padding is not removed if the value of <code>BatchStrategy</code> is set to <code>MultiRecord</code>.</para><para>For more information about the RecordIO, see <a href="http://mxnet.io/architecture/note_data_loading.html#data-format">Data Format</a> in the MXNet documentation. For more information about the TFRecord, see <a href="https://www.tensorflow.org/guide/datasets#consuming_tfrecord_data">Consuming TFRecord data</a> in the TensorFlow documentation.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.Tag"> <summary> <para> <para>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformJobName"> <summary> <para> <para>The name of the transform job. The name must be unique within an AWS Region in an AWS account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformResources_VolumeKmsKeyId"> <summary> <para> <para>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The <code>VolumeKmsKeyId</code> can be any of the following formats:</para><ul><li><para>// KMS Key ID</para><para><code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key</para><para><code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TransformJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateTransformJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateTransformJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransformJobName parameter. The -PassThru parameter is deprecated, use -Select '^TransformJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet"> <summary> Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. <para> You cannot create more than 25 work teams in an account and region. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.Description"> <summary> <para> <para>A description of the work team.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.MemberDefinition"> <summary> <para> <para>A list of <code>MemberDefinition</code> objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</para><para>All of the <code>CognitoMemberDefinition</code> objects that make up the member definition must have the same <code>ClientId</code> and <code>UserPool</code> values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.NotificationConfiguration_NotificationTopicArn"> <summary> <para> <para>The ARN for the SNS topic to which notifications should be published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs.</para><para>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html">Resource Tag</a> and <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i> AWS Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.WorkteamName"> <summary> <para> <para>The name of the work team. Use this name to identify the work team.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkteamArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateWorkteamResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateWorkteamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkteamName parameter. The -PassThru parameter is deprecated, use -Select '^WorkteamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMAlgorithmCmdlet"> <summary> Removes the specified algorithm from your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAlgorithmCmdlet.AlgorithmName"> <summary> <para> <para>The name of the algorithm to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAlgorithmCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteAlgorithmResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAlgorithmCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AlgorithmName parameter. The -PassThru parameter is deprecated, use -Select '^AlgorithmName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAlgorithmCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMCodeRepositoryCmdlet"> <summary> Deletes the specified Git repository from your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCodeRepositoryCmdlet.CodeRepositoryName"> <summary> <para> <para>The name of the Git repository to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCodeRepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteCodeRepositoryResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCodeRepositoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CodeRepositoryName parameter. The -PassThru parameter is deprecated, use -Select '^CodeRepositoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCodeRepositoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointCmdlet"> <summary> Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created. <para> Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the <a href="http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html">RevokeGrant</a> API call. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointCmdlet.EndpointName"> <summary> <para> <para>The name of the endpoint that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteEndpointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointConfigCmdlet"> <summary> Deletes an endpoint configuration. The <code>DeleteEndpointConfig</code> API deletes only the specified configuration. It does not delete endpoints created using the configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointConfigCmdlet.EndpointConfigName"> <summary> <para> <para>The name of the endpoint configuration that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteEndpointConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointConfigName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEndpointConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCmdlet"> <summary> Deletes a model. The <code>DeleteModel</code> API deletes only the model entry that was created in Amazon SageMaker when you called the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateModel.html">CreateModel</a> API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCmdlet.ModelName"> <summary> <para> <para>The name of the model to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteModelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelName parameter. The -PassThru parameter is deprecated, use -Select '^ModelName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageCmdlet"> <summary> Deletes a model package. <para> A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageCmdlet.ModelPackageName"> <summary> <para> <para>The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteModelPackageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceCmdlet"> <summary> Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the <code>StopNotebookInstance</code> API. <important><para> When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the Amazon SageMaker notebook instance to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteNotebookInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceLifecycleConfigCmdlet"> <summary> Deletes a notebook instance lifecycle configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceLifecycleConfigCmdlet.NotebookInstanceLifecycleConfigName"> <summary> <para> <para>The name of the lifecycle configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceLifecycleConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteNotebookInstanceLifecycleConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMNotebookInstanceLifecycleConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMResourceTagCmdlet"> <summary> Deletes the specified tags from an Amazon SageMaker resource. <para> To list a resource's tags, use the <code>ListTags</code> API. </para><note><para> When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose tags you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMResourceTagCmdlet.TagKey"> <summary> <para> <para>An array or one or more tag keys to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TagKey parameter. The -PassThru parameter is deprecated, use -Select '^TagKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkteamCmdlet"> <summary> Deletes an existing work team. This operation can't be undone. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkteamCmdlet.WorkteamName"> <summary> <para> <para>The name of the work team to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkteamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Success'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteWorkteamResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteWorkteamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkteamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkteamName parameter. The -PassThru parameter is deprecated, use -Select '^WorkteamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkteamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet"> <summary> Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of <code>SearchResult</code> objects in the response. You can sort the search results by any resource property in a ascending or descending order. <para> You can query against the following value types: numerical, text, Booleans, and timestamps. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SearchExpression_Filter"> <summary> <para> <para>A list of filter objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SearchExpression_NestedFilter"> <summary> <para> <para>A list of nested filter objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SearchExpression_Operator"> <summary> <para> <para>A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify <code>And</code>. If only a single conditional statement needs to be true for the entire search expression to be true, specify <code>Or</code>. The default value is <code>And</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.Resource"> <summary> <para> <para>The name of the Amazon SageMaker resource to search for. Currently, the only valid <code>Resource</code> value is <code>TrainingJob</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SortBy"> <summary> <para> <para>The name of the resource property used to sort the <code>SearchResults</code>. The default is <code>LastModifiedTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SortOrder"> <summary> <para> <para>How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or <code>Descending</code>. The default is <code>Descending</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SearchExpression_SubExpression"> <summary> <para> <para>A list of search expression objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a <code>SearchResponse</code>.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.NextToken"> <summary> <para> <para>If more than <code>MaxResults</code> resource objects match the specified <code>SearchExpression</code>, the <code>SearchResponse</code> includes a <code>NextToken</code>. The <code>NextToken</code> can be passed to the next <code>SearchRequest</code> to continue retrieving results for the specified <code>SearchExpression</code> and <code>Sort</code> parameters.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.SearchResponse). Specifying the name of a property of type Amazon.SageMaker.Model.SearchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Resource parameter. The -PassThru parameter is deprecated, use -Select '^Resource' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StartSMNotebookInstanceCmdlet"> <summary> Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to <code>InService</code>. A notebook instance's status must be <code>InService</code> before you can connect to your Jupyter notebook. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMNotebookInstanceCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the notebook instance to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMNotebookInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StartNotebookInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMNotebookInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMNotebookInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StopSMCompilationJobCmdlet"> <summary> Stops a model compilation job. <para> To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal. </para><para> When it receives a <code>StopCompilationJob</code> request, Amazon SageMaker changes the <a>CompilationJobSummary$CompilationJobStatus</a> of the job to <code>Stopping</code>. After Amazon SageMaker stops the job, it sets the <a>CompilationJobSummary$CompilationJobStatus</a> to <code>Stopped</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMCompilationJobCmdlet.CompilationJobName"> <summary> <para> <para>The name of the model compilation job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMCompilationJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopCompilationJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMCompilationJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CompilationJobName parameter. The -PassThru parameter is deprecated, use -Select '^CompilationJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMCompilationJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StopSMHyperParameterTuningJobCmdlet"> <summary> Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched. <para> All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the <code>Stopped</code> state, it releases all reserved resources for the tuning job. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobName"> <summary> <para> <para>The name of the tuning job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMHyperParameterTuningJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopHyperParameterTuningJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMHyperParameterTuningJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HyperParameterTuningJobName parameter. The -PassThru parameter is deprecated, use -Select '^HyperParameterTuningJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMHyperParameterTuningJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StopSMLabelingJobCmdlet"> <summary> Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMLabelingJobCmdlet.LabelingJobName"> <summary> <para> <para>The name of the labeling job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMLabelingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopLabelingJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMLabelingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LabelingJobName parameter. The -PassThru parameter is deprecated, use -Select '^LabelingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMLabelingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StopSMNotebookInstanceCmdlet"> <summary> Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call <code>StopNotebookInstance</code>. <para> To access data on the ML storage volume for a notebook instance that has been terminated, call the <code>StartNotebookInstance</code> API. <code>StartNotebookInstance</code> launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMNotebookInstanceCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the notebook instance to terminate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMNotebookInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopNotebookInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMNotebookInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMNotebookInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StopSMTrainingJobCmdlet"> <summary> Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. <para> When it receives a <code>StopTrainingJob</code> request, Amazon SageMaker changes the status of the job to <code>Stopping</code>. After Amazon SageMaker stops the job, it sets the status to <code>Stopped</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTrainingJobCmdlet.TrainingJobName"> <summary> <para> <para>The name of the training job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTrainingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopTrainingJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTrainingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrainingJobName parameter. The -PassThru parameter is deprecated, use -Select '^TrainingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTrainingJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.StopSMTransformJobCmdlet"> <summary> Stops a transform job. <para> When Amazon SageMaker receives a <code>StopTransformJob</code> request, the status of the job changes to <code>Stopping</code>. After Amazon SageMaker stops the job, the status is set to <code>Stopped</code>. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTransformJobCmdlet.TransformJobName"> <summary> <para> <para>The name of the transform job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTransformJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopTransformJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTransformJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TransformJobName parameter. The -PassThru parameter is deprecated, use -Select '^TransformJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMTransformJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.UpdateSMCodeRepositoryCmdlet"> <summary> Updates the specified Git repository with the specified values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMCodeRepositoryCmdlet.CodeRepositoryName"> <summary> <para> <para>The name of the Git repository to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMCodeRepositoryCmdlet.GitConfig_SecretArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of <code>AWSCURRENT</code> and must be in the following format:</para><para><code>{"username": <i>UserName</i>, "password": <i>Password</i>}</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMCodeRepositoryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CodeRepositoryArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateCodeRepositoryResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateCodeRepositoryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMCodeRepositoryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CodeRepositoryName parameter. The -PassThru parameter is deprecated, use -Select '^CodeRepositoryName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMCodeRepositoryCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet"> <summary> Deploys the new <code>EndpointConfig</code> specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous <code>EndpointConfig</code> (there is no availability loss). <para> When Amazon SageMaker receives the request, it sets the endpoint status to <code>Updating</code>. After updating the endpoint, it sets the status to <code>InService</code>. To check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_DescribeEndpoint.html">DescribeEndpoint</a> API. </para><note><para> You must not delete an <code>EndpointConfig</code> in use by an endpoint that is live or while the <code>UpdateEndpoint</code> or <code>CreateEndpoint</code> operations are being performed on the endpoint. To update an endpoint, you must create a new <code>EndpointConfig</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.EndpointConfigName"> <summary> <para> <para>The name of the new endpoint configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.EndpointName"> <summary> <para> <para>The name of the endpoint whose configuration you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateEndpointResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointConfigName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointWeightAndCapacityCmdlet"> <summary> Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to <code>Updating</code>. After updating the endpoint, it sets the status to <code>InService</code>. To check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_DescribeEndpoint.html">DescribeEndpoint</a> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointWeightAndCapacityCmdlet.DesiredWeightsAndCapacity"> <summary> <para> <para>An object that provides new capacity and weight values for a variant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointWeightAndCapacityCmdlet.EndpointName"> <summary> <para> <para>The name of an existing Amazon SageMaker endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointWeightAndCapacityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateEndpointWeightsAndCapacitiesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateEndpointWeightsAndCapacitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointWeightAndCapacityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointWeightAndCapacityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet"> <summary> Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.AcceleratorType"> <summary> <para> <para>A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see <a href="sagemaker/latest/dg/ei.html">Using Elastic Inference in Amazon SageMaker</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.AdditionalCodeRepository"> <summary> <para> <para>An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with Amazon SageMaker Notebook Instances</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.DefaultCodeRepository"> <summary> <para> <para>The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">AWS CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html">Associating Git Repositories with Amazon SageMaker Notebook Instances</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.DisassociateAcceleratorType"> <summary> <para> <para>A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.DisassociateAdditionalCodeRepository"> <summary> <para> <para>A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.DisassociateDefaultCodeRepository"> <summary> <para> <para>The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.DisassociateLifecycleConfig"> <summary> <para> <para>Set to <code>true</code> to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.InstanceType"> <summary> <para> <para>The Amazon ML compute instance type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.LifecycleConfigName"> <summary> <para> <para>The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html">Step 2.1: (Optional) Customize a Notebook Instance</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.NotebookInstanceName"> <summary> <para> <para>The name of the notebook instance to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">Amazon SageMaker Roles</a>. </para><note><para>To be able to pass this role to Amazon SageMaker, the caller of this API must have the <code>iam:PassRole</code> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.RootAccess"> <summary> <para> <para>Whether root access is enabled or disabled for users of the notebook instance. The default value is <code>Enabled</code>.</para><note><para>If you set this to <code>Disabled</code>, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.VolumeSizeInGB"> <summary> <para> <para>The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateNotebookInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet"> <summary> Updates a notebook instance lifecycle configuration created with the <a>CreateNotebookInstanceLifecycleConfig</a> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet.NotebookInstanceLifecycleConfigName"> <summary> <para> <para>The name of the lifecycle configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet.OnCreate"> <summary> <para> <para>The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet.OnStart"> <summary> <para> <para>The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateNotebookInstanceLifecycleConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the NotebookInstanceLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^NotebookInstanceLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMNotebookInstanceLifecycleConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet"> <summary> Updates an existing work team with new member definitions or description. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.Description"> <summary> <para> <para>An updated description for the work team.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.MemberDefinition"> <summary> <para> <para>A list of <code>MemberDefinition</code> objects that contain the updated work team members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.NotificationConfiguration_NotificationTopicArn"> <summary> <para> <para>The ARN for the SNS topic to which notifications should be published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.WorkteamName"> <summary> <para> <para>The name of the work team to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workteam'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateWorkteamResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateWorkteamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkteamName parameter. The -PassThru parameter is deprecated, use -Select '^WorkteamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |