AWS.Tools.SageMaker.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SageMaker</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SM.AddSMAssociationCmdlet"> <summary> Creates an <i>association</i> between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMAssociationCmdlet.AssociationType"> <summary> <para> <para>The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.</para><ul><li><para>ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.</para></li><li><para>AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.</para></li><li><para>DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.</para></li><li><para>Produced - The source generated the destination. For example, a training job produced a model artifact.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMAssociationCmdlet.DestinationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMAssociationCmdlet.SourceArn"> <summary> <para> <para>The ARN of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.AddSMAssociationCmdlet.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.AddAssociationResponse). Specifying the name of a property of type Amazon.SageMaker.Model.AddAssociationResponse 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.AddSMAssociationCmdlet.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.AddSMResourceTagCmdlet"> <summary> Adds or overwrites one or more tags for the specified 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/">Amazon Web Services 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 <c>Tags</c> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a></para></note><note><para> Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the <c>Tags</c> parameter of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html">CreateUserProfile</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 key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</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.DisableSMSagemakerServicecatalogPortfolioCmdlet"> <summary> Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.DisableSMSagemakerServicecatalogPortfolioCmdlet.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.DisableSagemakerServicecatalogPortfolioResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.DisableSMSagemakerServicecatalogPortfolioCmdlet.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.EnableSMSagemakerServicecatalogPortfolioCmdlet"> <summary> Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.EnableSMSagemakerServicecatalogPortfolioCmdlet.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.EnableSagemakerServicecatalogPortfolioResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.EnableSMSagemakerServicecatalogPortfolioCmdlet.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.FindSMLineageCmdlet"> <summary> Use this action to inspect your lineage and discover relationships between entities. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html"> Querying Lineage Entities</a> in the <i>Amazon SageMaker Developer Guide</i>.<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.FindSMLineageCmdlet.Filters_CreatedAfter"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c>(s) after the create date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Filters_CreatedBefore"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c>(s) by created date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Direction"> <summary> <para> <para>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.IncludeEdge"> <summary> <para> <para> Setting this value to <c>True</c> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <c>False</c> to only return lineage entities that match your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Filters_LineageType"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c>(s) by the type of the lineage entity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.MaxDepth"> <summary> <para> <para>The maximum depth in lineage relationships from the <c>StartArns</c> that are traversed. Depth is a measure of the number of <c>Associations</c> from the <c>StartArn</c> entity to the matched results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Filters_ModifiedAfter"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c>(s) after the last modified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Filters_ModifiedBefore"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c>(s) before the last modified date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Filters_Property"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c>(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.StartArn"> <summary> <para> <para>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.Filters_Type"> <summary> <para> <para>Filter the lineage entities connected to the <c>StartArn</c> by type. For example: <c>DataSet</c>, <c>Model</c>, <c>Endpoint</c>, or <c>ModelDeployment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.MaxResult"> <summary> <para> <para>Limits the number of vertices in the results. Use the <c>NextToken</c> in a response to to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.FindSMLineageCmdlet.NextToken"> <summary> <para> <para>Limits the number of vertices in the request. Use the <c>NextToken</c> in a response to to retrieve the next page of results.</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.FindSMLineageCmdlet.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.QueryLineageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.QueryLineageResponse 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.FindSMLineageCmdlet.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.GetSMActionCmdlet"> <summary> Describes an action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionCmdlet.ActionName"> <summary> <para> <para>The name of the action to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionCmdlet.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.DescribeActionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeActionResponse 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.GetSMActionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActionName parameter. The -PassThru parameter is deprecated, use -Select '^ActionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet"> <summary> Lists the actions in your account and their properties.<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.GetSMActionListCmdlet.ActionType"> <summary> <para> <para>A filter that returns only actions of the specified type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only actions created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only actions created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.SourceUri"> <summary> <para> <para>A filter that returns only actions with the specified source URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of actions to return in the response. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMActionListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListActions</c> didn't return the full set of actions, the call returns a token for getting the next set of actions.</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.GetSMActionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListActionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListActionsResponse 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.GetSMActionListCmdlet.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.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 <c>CreationTime</c>.</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 <c>Ascending</c>.</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 <c>ListAlgorithms</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMAliasListCmdlet"> <summary> Lists the aliases of a specified image or image version.<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.GetSMAliasListCmdlet.Alias"> <summary> <para> <para>The alias of the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAliasListCmdlet.ImageName"> <summary> <para> <para>The name of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAliasListCmdlet.Version"> <summary> <para> <para>The version of the image. If image version is not specified, the aliases of all versions of the image are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAliasListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of aliases to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAliasListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListAliases</c> didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.</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.GetSMAliasListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SageMakerImageVersionAliases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListAliasesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListAliasesResponse 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.GetSMAliasListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAliasListCmdlet.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.GetSMAppCmdlet"> <summary> Describes the app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppCmdlet.AppName"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppCmdlet.AppType"> <summary> <para> <para>The type of app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppCmdlet.SpaceName"> <summary> <para> <para>The name of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppCmdlet.UserProfileName"> <summary> <para> <para>The user profile name. If this value is not set, then <c>SpaceName</c> must be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppCmdlet.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.DescribeAppResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeAppResponse 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.GetSMAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppName parameter. The -PassThru parameter is deprecated, use -Select '^AppName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigCmdlet"> <summary> Describes an AppImageConfig. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigCmdlet.AppImageConfigName"> <summary> <para> <para>The name of the AppImageConfig to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigCmdlet.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.DescribeAppImageConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeAppImageConfigResponse 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.GetSMAppImageConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppImageConfigName parameter. The -PassThru parameter is deprecated, use -Select '^AppImageConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet"> <summary> Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.<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.GetSMAppImageConfigListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only AppImageConfigs created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only AppImageConfigs created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.ModifiedTimeAfter"> <summary> <para> <para>A filter that returns only AppImageConfigs modified on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.ModifiedTimeBefore"> <summary> <para> <para>A filter that returns only AppImageConfigs modified on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.NameContain"> <summary> <para> <para>A filter that returns only AppImageConfigs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return in the response. If the total number of items available is more than the value specified, a <c>NextToken</c> is provided in the response. To resume pagination, provide the <c>NextToken</c> value in the as part of a subsequent call. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppImageConfigListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListImages</c> didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.</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.GetSMAppImageConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppImageConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListAppImageConfigsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListAppImageConfigsResponse 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.GetSMAppImageConfigListCmdlet.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.GetSMAppListCmdlet"> <summary> Lists apps.<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.GetSMAppListCmdlet.DomainIdEqual"> <summary> <para> <para>A parameter to search for the domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is CreationTime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is Ascending.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppListCmdlet.SpaceNameEqual"> <summary> <para> <para>A parameter to search by space name. If <c>UserProfileNameEquals</c> is set, then this value cannot be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppListCmdlet.UserProfileNameEqual"> <summary> <para> <para>A parameter to search by user profile name. If <c>SpaceNameEquals</c> is set, then this value cannot be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAppListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return in the response. If the total number of items available is more than the value specified, a <c>NextToken</c> is provided in the response. To resume pagination, provide the <c>NextToken</c> value in the as part of a subsequent call. 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.GetSMAppListCmdlet.NextToken"> <summary> <para> <para>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</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.GetSMAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Apps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListAppsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListAppsResponse 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.GetSMAppListCmdlet.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.GetSMArtifactCmdlet"> <summary> Describes an artifact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactCmdlet.ArtifactArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the artifact to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactCmdlet.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.DescribeArtifactResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeArtifactResponse 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.GetSMArtifactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ArtifactArn parameter. The -PassThru parameter is deprecated, use -Select '^ArtifactArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet"> <summary> Lists the artifacts in your account and their properties.<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.GetSMArtifactListCmdlet.ArtifactType"> <summary> <para> <para>A filter that returns only artifacts of the specified type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only artifacts created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only artifacts created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.SourceUri"> <summary> <para> <para>A filter that returns only artifacts with the specified source URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of artifacts to return in the response. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMArtifactListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListArtifacts</c> didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.</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.GetSMArtifactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ArtifactSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListArtifactsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListArtifactsResponse 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.GetSMArtifactListCmdlet.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.GetSMAssociationListCmdlet"> <summary> Lists the associations in your account and their properties.<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.GetSMAssociationListCmdlet.AssociationType"> <summary> <para> <para>A filter that returns only associations of the specified type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only associations created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only associations created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.DestinationArn"> <summary> <para> <para>A filter that returns only associations with the specified destination Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.DestinationType"> <summary> <para> <para>A filter that returns only associations with the specified destination type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.SourceArn"> <summary> <para> <para>A filter that returns only associations with the specified source ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.SourceType"> <summary> <para> <para>A filter that returns only associations with the specified source type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of associations to return in the response. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAssociationListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListAssociations</c> didn't return the full set of associations, the call returns a token for getting the next set of associations.</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.GetSMAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListAssociationsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListAssociationsResponse 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.GetSMAssociationListCmdlet.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.GetSMAutoMLJobCmdlet"> <summary> Returns information about an AutoML job created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a>. <note><para> AutoML jobs created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> cannot be described by <c>DescribeAutoMLJob</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobCmdlet.AutoMLJobName"> <summary> <para> <para>Requests information about an AutoML job using its unique name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobCmdlet.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.DescribeAutoMLJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeAutoMLJobResponse 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.GetSMAutoMLJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet"> <summary> Request a list of 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.GetSMAutoMLJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>Request a list of jobs, using a filter for time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>Request a list of jobs, using a filter for time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Request a list of jobs, using a filter for time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Request a list of jobs, using a filter for time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.NameContain"> <summary> <para> <para>Request a list of jobs, using a search filter for name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is <c>Name</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.StatusEqual"> <summary> <para> <para>Request a list of jobs, using a filter for status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobListCmdlet.MaxResult"> <summary> <para> <para>Request a list of jobs up to a specified limit.</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.GetSMAutoMLJobListCmdlet.NextToken"> <summary> <para> <para>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</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.GetSMAutoMLJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoMLJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListAutoMLJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListAutoMLJobsResponse 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.GetSMAutoMLJobListCmdlet.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.GetSMAutoMLJobV2Cmdlet"> <summary> Returns information about an AutoML job created by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobV2Cmdlet.AutoMLJobName"> <summary> <para> <para>Requests information about an AutoML job V2 using its unique name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMAutoMLJobV2Cmdlet.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.DescribeAutoMLJobV2Response). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeAutoMLJobV2Response 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.GetSMAutoMLJobV2Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet"> <summary> List the candidates created for the job.<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.GetSMCandidatesForAutoMLJobListCmdlet.AutoMLJobName"> <summary> <para> <para>List the candidates created for the job by providing the job's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet.CandidateNameEqual"> <summary> <para> <para>List the candidates for the job and filter by candidate name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet.StatusEqual"> <summary> <para> <para>List the candidates for the job and filter by status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet.MaxResult"> <summary> <para> <para>List the job's candidates up to a specified limit.</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.GetSMCandidatesForAutoMLJobListCmdlet.NextToken"> <summary> <para> <para>If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.</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.GetSMCandidatesForAutoMLJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Candidates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListCandidatesForAutoMLJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListCandidatesForAutoMLJobResponse 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.GetSMCandidatesForAutoMLJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCandidatesForAutoMLJobListCmdlet.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.GetSMClusterCmdlet"> <summary> Retrieves information of a SageMaker HyperPod cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterCmdlet.ClusterName"> <summary> <para> <para>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterCmdlet.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.DescribeClusterResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeClusterResponse 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.GetSMClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet"> <summary> Retrieves the list of SageMaker HyperPod clusters.<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.GetSMClusterListCmdlet.CreationTimeAfter"> <summary> <para> <para>Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard. </para><para>Acceptable formats include:</para><ul><li><para><c>YYYY-MM-DDThh:mm:ss.sssTZD</c> (UTC), for example, <c>2014-10-01T20:30:00.000Z</c></para></li><li><para><c>YYYY-MM-DDThh:mm:ss.sssTZD</c> (with offset), for example, <c>2014-10-01T12:30:00.000-08:00</c></para></li><li><para><c>YYYY-MM-DD</c>, for example, <c>2014-10-01</c></para></li><li><para>Unix time in seconds, for example, <c>1412195400</c>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</para></li></ul><para>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet.CreationTimeBefore"> <summary> <para> <para>Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for <c>CreationTimeAfter</c>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet.NameContain"> <summary> <para> <para>Set the maximum number of instances to print in the list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort results. The default value is <c>CREATION_TIME</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default value is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet.MaxResult"> <summary> <para> <para>Set the maximum number of SageMaker HyperPod clusters to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterListCmdlet.NextToken"> <summary> <para> <para>Set the next token to retrieve the list of SageMaker HyperPod clusters.</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.GetSMClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListClustersResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListClustersResponse 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.GetSMClusterListCmdlet.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.GetSMClusterNodeCmdlet"> <summary> Retrieves information of an instance (also called a <i>node</i> interchangeably) of a SageMaker HyperPod cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeCmdlet.ClusterName"> <summary> <para> <para>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the instance is.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeCmdlet.NodeId"> <summary> <para> <para>The ID of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NodeDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeClusterNodeResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeClusterNodeResponse 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.GetSMClusterNodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet"> <summary> Retrieves the list of instances (also called <i>nodes</i> interchangeably) in a SageMaker HyperPod cluster.<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.GetSMClusterNodeListCmdlet.ClusterName"> <summary> <para> <para>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard. </para><para>Acceptable formats include:</para><ul><li><para><c>YYYY-MM-DDThh:mm:ss.sssTZD</c> (UTC), for example, <c>2014-10-01T20:30:00.000Z</c></para></li><li><para><c>YYYY-MM-DDThh:mm:ss.sssTZD</c> (with offset), for example, <c>2014-10-01T12:30:00.000-08:00</c></para></li><li><para><c>YYYY-MM-DD</c>, for example, <c>2014-10-01</c></para></li><li><para>Unix time in seconds, for example, <c>1412195400</c>. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.</para></li></ul><para>For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for <c>CreationTimeAfter</c>. For more information about the timestamp format, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">Timestamp</a> in the <i>Amazon Web Services Command Line Interface User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.InstanceGroupNameContain"> <summary> <para> <para>A filter that returns the instance groups whose name contain a specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort results. The default value is <c>CREATION_TIME</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default value is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of nodes to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListClusterNodes</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of cluster nodes, 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.GetSMClusterNodeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterNodeSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListClusterNodesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListClusterNodesResponse 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.GetSMClusterNodeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMClusterNodeListCmdlet.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 <c>Name</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCodeRepositoryListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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 <c>ListCodeRepositoriesOutput</c> request was truncated, the response includes a <c>NextToken</c>. 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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html">CreateCompilationJob</a>. To get information about multiple model compilation jobs, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html">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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html">CreateCompilationJob</a>. To get information about a particular model compilation job you have created, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html">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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMCompilationJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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 <c>CompilationJobStatus</c> 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 <c>ListCompilationJobs</c> request was truncated, the response includes a <c>NextToken</c>. 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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMConfigListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Descending</c>.</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 <c>ListEndpointConfig</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMContextCmdlet"> <summary> Describes a context. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextCmdlet.ContextName"> <summary> <para> <para>The name of the context to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextCmdlet.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.DescribeContextResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeContextResponse 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.GetSMContextCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContextName parameter. The -PassThru parameter is deprecated, use -Select '^ContextName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet"> <summary> Lists the contexts in your account and their properties.<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.GetSMContextListCmdlet.ContextType"> <summary> <para> <para>A filter that returns only contexts of the specified type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only contexts created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only contexts created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.SourceUri"> <summary> <para> <para>A filter that returns only contexts with the specified source URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of contexts to return in the response. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMContextListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListContexts</c> didn't return the full set of contexts, the call returns a token for getting the next set of contexts.</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.GetSMContextListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContextSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListContextsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListContextsResponse 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.GetSMContextListCmdlet.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.GetSMDataQualityJobDefinitionCmdlet"> <summary> Gets the details of a data quality monitoring job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the data quality monitoring job definition to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionCmdlet.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.DescribeDataQualityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeDataQualityJobDefinitionResponse 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.GetSMDataQualityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet"> <summary> Lists the data quality job definitions 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.GetSMDataQualityJobDefinitionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only data quality monitoring job definitions created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only data quality monitoring job definitions created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.EndpointName"> <summary> <para> <para>A filter that lists the data quality job definitions associated with the specified endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.NameContain"> <summary> <para> <para>A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.SortOrder"> <summary> <para> <para>Whether to sort the results in <c>Ascending</c> or <c>Descending</c> order. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of data quality monitoring job definitions to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDataQualityJobDefinitionListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListDataQualityJobDefinitions</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMDataQualityJobDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListDataQualityJobDefinitionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListDataQualityJobDefinitionsResponse 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.GetSMDataQualityJobDefinitionListCmdlet.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.GetSMDescribeModelPackageCmdlet"> <summary> This action batch describes a list of versioned model packages </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDescribeModelPackageCmdlet.ModelPackageArnList"> <summary> <para> <para>The list of Amazon Resource Name (ARN) of the model package groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDescribeModelPackageCmdlet.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.BatchDescribeModelPackageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.BatchDescribeModelPackageResponse 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="T:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceCmdlet"> <summary> Describes the device.<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.GetSMDeviceCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet the devices belong to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceCmdlet.DeviceName"> <summary> <para> <para>The unique ID of the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceCmdlet.NextToken"> <summary> <para> <para>Next token of device description.</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.GetSMDeviceCmdlet.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.DescribeDeviceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeDeviceResponse 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.GetSMDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceCmdlet.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.GetSMDeviceFleetCmdlet"> <summary> A description of the fleet the device belongs to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetCmdlet.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.DescribeDeviceFleetResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeDeviceFleetResponse 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.GetSMDeviceFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet"> <summary> Returns a list of devices in the fleet.<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.GetSMDeviceFleetListCmdlet.CreationTimeAfter"> <summary> <para> <para>Filter fleets where packaging job was created after specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.CreationTimeBefore"> <summary> <para> <para>Filter fleets where the edge packaging job was created before specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Select fleets where the job was updated after X</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Select fleets where the job was updated before X</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.NameContain"> <summary> <para> <para>Filter for fleets containing this name in their fleet device name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.SortBy"> <summary> <para> <para>The column to sort by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.SortOrder"> <summary> <para> <para>What direction to sort in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetListCmdlet.NextToken"> <summary> <para> <para>The response from the last list when returning a list large enough to need tokening.</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.GetSMDeviceFleetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeviceFleetSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListDeviceFleetsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListDeviceFleetsResponse 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.GetSMDeviceFleetListCmdlet.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.GetSMDeviceFleetReportCmdlet"> <summary> Describes a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetReportCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceFleetReportCmdlet.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.GetDeviceFleetReportResponse). Specifying the name of a property of type Amazon.SageMaker.Model.GetDeviceFleetReportResponse 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.GetSMDeviceFleetReportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceListCmdlet"> <summary> A list of devices.<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.GetSMDeviceListCmdlet.DeviceFleetName"> <summary> <para> <para>Filter for fleets containing this name in their device fleet name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceListCmdlet.LatestHeartbeatAfter"> <summary> <para> <para>Select fleets where the job was updated after X</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceListCmdlet.ModelName"> <summary> <para> <para>A filter that searches devices that contains this name in any of their models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDeviceListCmdlet.NextToken"> <summary> <para> <para>The response from the last list when returning a list large enough to need tokening.</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.GetSMDeviceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeviceSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListDevicesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListDevicesResponse 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.GetSMDeviceListCmdlet.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.GetSMDomainCmdlet"> <summary> The description of the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDomainCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMDomainCmdlet.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.DescribeDomainResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeDomainResponse 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.GetSMDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMDomainListCmdlet"> <summary> Lists the domains.<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.GetSMDomainListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return in the response. If the total number of items available is more than the value specified, a <c>NextToken</c> is provided in the response. To resume pagination, provide the <c>NextToken</c> value in the as part of a subsequent call. 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.GetSMDomainListCmdlet.NextToken"> <summary> <para> <para>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</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.GetSMDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Domains'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListDomainsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListDomainsResponse 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.GetSMDomainListCmdlet.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.GetSMEdgeDeploymentPlanCmdlet"> <summary> Describes an edge deployment plan with deployment status per stage.<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.GetSMEdgeDeploymentPlanCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the deployment plan to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to select (50 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanCmdlet.NextToken"> <summary> <para> <para>If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.</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.GetSMEdgeDeploymentPlanCmdlet.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.DescribeEdgeDeploymentPlanResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeEdgeDeploymentPlanResponse 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.GetSMEdgeDeploymentPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EdgeDeploymentPlanName parameter. The -PassThru parameter is deprecated, use -Select '^EdgeDeploymentPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanCmdlet.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.GetSMEdgeDeploymentPlanListCmdlet"> <summary> Lists all edge deployment plans.<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.GetSMEdgeDeploymentPlanListCmdlet.CreationTimeAfter"> <summary> <para> <para>Selects edge deployment plans created after this time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.CreationTimeBefore"> <summary> <para> <para>Selects edge deployment plans created before this time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.DeviceFleetNameContain"> <summary> <para> <para>Selects edge deployment plans with a device fleet name containing this name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Selects edge deployment plans that were last updated after this time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Selects edge deployment plans that were last updated before this time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.NameContain"> <summary> <para> <para>Selects edge deployment plans with names containing this name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.SortBy"> <summary> <para> <para>The column by which to sort the edge deployment plans. Can be one of <c>NAME</c>, <c>DEVICEFLEETNAME</c>, <c>CREATIONTIME</c>, <c>LASTMODIFIEDTIME</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.SortOrder"> <summary> <para> <para>The direction of the sorting (ascending or descending).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to select (50 by default).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgeDeploymentPlanListCmdlet.NextToken"> <summary> <para> <para>The response from the last list when returning a list large enough to need tokening.</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.GetSMEdgeDeploymentPlanListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EdgeDeploymentPlanSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListEdgeDeploymentPlansResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListEdgeDeploymentPlansResponse 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.GetSMEdgeDeploymentPlanListCmdlet.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.GetSMEdgePackagingJobCmdlet"> <summary> A description of edge packaging jobs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobCmdlet.EdgePackagingJobName"> <summary> <para> <para>The name of the edge packaging job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobCmdlet.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.DescribeEdgePackagingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeEdgePackagingJobResponse 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.GetSMEdgePackagingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EdgePackagingJobName parameter. The -PassThru parameter is deprecated, use -Select '^EdgePackagingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet"> <summary> Returns a list of edge packaging 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.GetSMEdgePackagingJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>Select jobs where the job was created after specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>Select jobs where the job was created before specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Select jobs where the job was updated after specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Select jobs where the job was updated before specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.ModelNameContain"> <summary> <para> <para>Filter for jobs where the model name contains this string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.NameContain"> <summary> <para> <para>Filter for jobs containing this name in their packaging job name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.SortBy"> <summary> <para> <para>Use to specify what column to sort by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.SortOrder"> <summary> <para> <para>What direction to sort by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.StatusEqual"> <summary> <para> <para>The job status to filter for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEdgePackagingJobListCmdlet.NextToken"> <summary> <para> <para>The response from the last list when returning a list large enough to need tokening.</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.GetSMEdgePackagingJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EdgePackagingJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListEdgePackagingJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListEdgePackagingJobsResponse 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.GetSMEdgePackagingJobListCmdlet.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 <c>CreateEndpointConfig</c> 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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMEndpointListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Descending</c>.</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. This value defaults to 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.GetSMEndpointListCmdlet.NextToken"> <summary> <para> <para>If the result of a <c>ListEndpoints</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMExperimentCmdlet"> <summary> Provides a list of an experiment's properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentCmdlet.ExperimentName"> <summary> <para> <para>The name of the experiment to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentCmdlet.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.DescribeExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeExperimentResponse 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.GetSMExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExperimentName parameter. The -PassThru parameter is deprecated, use -Select '^ExperimentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentListCmdlet"> <summary> Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.<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.GetSMExperimentListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only experiments created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only experiments created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMExperimentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of experiments to return in the response. 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.GetSMExperimentListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListExperiments</c> didn't return the full set of experiments, the call returns a token for getting the next set of experiments.</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.GetSMExperimentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExperimentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListExperimentsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListExperimentsResponse 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.GetSMExperimentListCmdlet.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.GetSMFeatureGroupCmdlet"> <summary> Use this operation to describe a <c>FeatureGroup</c>. The response includes information on the creation time, <c>FeatureGroup</c> name, the unique identifier for each <c>FeatureGroup</c>, and more.<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.GetSMFeatureGroupCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the <c>FeatureGroup</c> you want described. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupCmdlet.NextToken"> <summary> <para> <para>A token to resume pagination of the list of <c>Features</c> (<c>FeatureDefinitions</c>). 2,500 <c>Features</c> are returned by default.</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.GetSMFeatureGroupCmdlet.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.DescribeFeatureGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeFeatureGroupResponse 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.GetSMFeatureGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupCmdlet.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.GetSMFeatureGroupListCmdlet"> <summary> List <c>FeatureGroup</c>s based on given filter and order.<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.GetSMFeatureGroupListCmdlet.CreationTimeAfter"> <summary> <para> <para>Use this parameter to search for <c>FeatureGroups</c>s created after a specific date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.CreationTimeBefore"> <summary> <para> <para>Use this parameter to search for <c>FeatureGroups</c>s created before a specific date and time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.FeatureGroupStatusEqual"> <summary> <para> <para>A <c>FeatureGroup</c> status. Filters by <c>FeatureGroup</c> status. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.NameContain"> <summary> <para> <para>A string that partially matches one or more <c>FeatureGroup</c>s names. Filters <c>FeatureGroup</c>s by name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.OfflineStoreStatusEqual"> <summary> <para> <para>An <c>OfflineStore</c> status. Filters by <c>OfflineStore</c> status. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.SortBy"> <summary> <para> <para>The value on which the feature group list is sorted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.SortOrder"> <summary> <para> <para>The order in which feature groups are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results returned by <c>ListFeatureGroups</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureGroupListCmdlet.NextToken"> <summary> <para> <para>A token to resume pagination of <c>ListFeatureGroups</c> results.</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.GetSMFeatureGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeatureGroupSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListFeatureGroupsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListFeatureGroupsResponse 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.GetSMFeatureGroupListCmdlet.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.GetSMFeatureMetadataCmdlet"> <summary> Shows the metadata for a feature within a feature group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureMetadataCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the feature group containing the feature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureMetadataCmdlet.FeatureName"> <summary> <para> <para>The name of the feature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFeatureMetadataCmdlet.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.DescribeFeatureMetadataResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeFeatureMetadataResponse 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.GetSMFeatureMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionCmdlet"> <summary> Returns information about the specified flow definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionCmdlet.FlowDefinitionName"> <summary> <para> <para>The name of the flow definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionCmdlet.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.DescribeFlowDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeFlowDefinitionResponse 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.GetSMFlowDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^FlowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionListCmdlet"> <summary> Returns information about the flow definitions 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.GetSMFlowDefinitionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only flow definitions that were created before the specified timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionListCmdlet.SortOrder"> <summary> <para> <para>An optional value that specifies whether you want the results sorted in <c>Ascending</c> or <c>Descending</c> order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMFlowDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return. If the total number of available items is more than the value specified in <c>MaxResults</c>, then a <c>NextToken</c> will be provided in the output that you can use to resume pagination.</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.GetSMFlowDefinitionListCmdlet.NextToken"> <summary> <para> <para>A token to resume pagination.</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.GetSMFlowDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowDefinitionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListFlowDefinitionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListFlowDefinitionsResponse 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.GetSMFlowDefinitionListCmdlet.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.GetSMHubCmdlet"> <summary> Describe a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubCmdlet.HubName"> <summary> <para> <para>The name of the hub to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubCmdlet.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.DescribeHubResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeHubResponse 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.GetSMHubCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HubName parameter. The -PassThru parameter is deprecated, use -Select '^HubName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentCmdlet"> <summary> Describe the content of a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentCmdlet.HubContentName"> <summary> <para> <para>The name of the content to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentCmdlet.HubContentType"> <summary> <para> <para>The type of content in the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentCmdlet.HubContentVersion"> <summary> <para> <para>The version of the content to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentCmdlet.HubName"> <summary> <para> <para>The name of the hub that contains the content to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentCmdlet.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.DescribeHubContentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeHubContentResponse 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="T:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet"> <summary> List the contents of a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note><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.GetSMHubContentListCmdlet.CreationTimeAfter"> <summary> <para> <para>Only list hub content that was created after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.CreationTimeBefore"> <summary> <para> <para>Only list hub content that was created before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.HubContentType"> <summary> <para> <para>The type of hub content to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.HubName"> <summary> <para> <para>The name of the hub to list the contents of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.MaxSchemaVersion"> <summary> <para> <para>The upper bound of the hub content schema verion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.NameContain"> <summary> <para> <para>Only list hub content if the name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.SortBy"> <summary> <para> <para>Sort hub content versions by either name or creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.SortOrder"> <summary> <para> <para>Sort hubs by ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.MaxResult"> <summary> <para> <para>The maximum amount of hub content to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListHubContents</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of hub content, 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.GetSMHubContentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HubContentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListHubContentsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListHubContentsResponse 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.GetSMHubContentListCmdlet.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.GetSMHubContentVersionListCmdlet"> <summary> List hub content versions. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note><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.GetSMHubContentVersionListCmdlet.CreationTimeAfter"> <summary> <para> <para>Only list hub content versions that were created after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.CreationTimeBefore"> <summary> <para> <para>Only list hub content versions that were created before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.HubContentName"> <summary> <para> <para>The name of the hub content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.HubContentType"> <summary> <para> <para>The type of hub content to list versions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.HubName"> <summary> <para> <para>The name of the hub to list the content versions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.MaxSchemaVersion"> <summary> <para> <para>The upper bound of the hub content schema version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.MinVersion"> <summary> <para> <para>The lower bound of the hub content versions to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.SortBy"> <summary> <para> <para>Sort hub content versions by either name or creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.SortOrder"> <summary> <para> <para>Sort hub content versions by ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of hub content versions to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubContentVersionListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListHubContentVersions</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of hub content versions, 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.GetSMHubContentVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HubContentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListHubContentVersionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListHubContentVersionsResponse 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.GetSMHubContentVersionListCmdlet.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.GetSMHubListCmdlet"> <summary> List all existing hubs. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note><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.GetSMHubListCmdlet.CreationTimeAfter"> <summary> <para> <para>Only list hubs that were created after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.CreationTimeBefore"> <summary> <para> <para>Only list hubs that were created before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Only list hubs that were last modified after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Only list hubs that were last modified before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.NameContain"> <summary> <para> <para>Only list hubs with names that contain the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.SortBy"> <summary> <para> <para>Sort hubs by either name or creation time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.SortOrder"> <summary> <para> <para>Sort hubs by ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of hubs to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHubListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListHubs</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of hubs, 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.GetSMHubListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HubSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListHubsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListHubsResponse 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.GetSMHubListCmdlet.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.GetSMHumanTaskUiCmdlet"> <summary> Returns information about the requested human task user interface (worker task template). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHumanTaskUiCmdlet.HumanTaskUiName"> <summary> <para> <para>The name of the human task user interface (worker task template) you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHumanTaskUiCmdlet.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.DescribeHumanTaskUiResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeHumanTaskUiResponse 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.GetSMHumanTaskUiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HumanTaskUiName parameter. The -PassThru parameter is deprecated, use -Select '^HumanTaskUiName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMHumanTaskUiListCmdlet"> <summary> Returns information about the human task user interfaces 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.GetSMHumanTaskUiListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHumanTaskUiListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only human task user interfaces that were created before the specified timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHumanTaskUiListCmdlet.SortOrder"> <summary> <para> <para>An optional value that specifies whether you want the results sorted in <c>Ascending</c> or <c>Descending</c> order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHumanTaskUiListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return. If the total number of available items is more than the value specified in <c>MaxResults</c>, then a <c>NextToken</c> will be provided in the output that you can use to resume pagination.</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.GetSMHumanTaskUiListCmdlet.NextToken"> <summary> <para> <para>A token to resume pagination.</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.GetSMHumanTaskUiListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HumanTaskUiSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListHumanTaskUisResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListHumanTaskUisResponse 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.GetSMHumanTaskUiListCmdlet.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> Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobName"> <summary> <para> <para>The name of the tuning job.</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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html">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 <c>Name</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMHyperParameterTuningJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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 <c>ListHyperParameterTuningJobs</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMImageCmdlet"> <summary> Describes a SageMaker image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageCmdlet.ImageName"> <summary> <para> <para>The name of the image to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageCmdlet.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.DescribeImageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeImageResponse 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.GetSMImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet"> <summary> Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.<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.GetSMImageListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only images created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only images created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only images modified on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only images modified on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.NameContain"> <summary> <para> <para>A filter that returns only images whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CREATION_TIME</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>DESCENDING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of images to return in the response. The default value is 10. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListImages</c> didn't return the full set of images, the call returns a token for getting the next set of images.</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.GetSMImageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Images'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListImagesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListImagesResponse 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.GetSMImageListCmdlet.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.GetSMImageVersionCmdlet"> <summary> Describes a version of a SageMaker image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionCmdlet.Alias"> <summary> <para> <para>The alias of the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionCmdlet.ImageName"> <summary> <para> <para>The name of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionCmdlet.Version"> <summary> <para> <para>The version of the image. If not specified, the latest version is described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionCmdlet.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.DescribeImageVersionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeImageVersionResponse 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.GetSMImageVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet"> <summary> Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.<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.GetSMImageVersionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only versions created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only versions created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.ImageName"> <summary> <para> <para>The name of the image to list the versions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only versions modified on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only versions modified on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CREATION_TIME</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>DESCENDING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of versions to return in the response. The default value is 10. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListImageVersions</c> didn't return the full set of versions, the call returns a token for getting the next set of versions.</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.GetSMImageVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageVersions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListImageVersionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListImageVersionsResponse 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.GetSMImageVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMImageVersionListCmdlet.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.GetSMInferenceComponentCmdlet"> <summary> Returns information about an inference component. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentCmdlet.InferenceComponentName"> <summary> <para> <para>The name of the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentCmdlet.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.DescribeInferenceComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeInferenceComponentResponse 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.GetSMInferenceComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InferenceComponentName parameter. The -PassThru parameter is deprecated, use -Select '^InferenceComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet"> <summary> Lists the inference components in your account and their properties.<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.GetSMInferenceComponentListCmdlet.CreationTimeAfter"> <summary> <para> <para>Filters the results to only those inference components that were created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.CreationTimeBefore"> <summary> <para> <para>Filters the results to only those inference components that were created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.EndpointNameEqual"> <summary> <para> <para>An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Filters the results to only those inference components that were updated after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Filters the results to only those inference components that were updated before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.NameContain"> <summary> <para> <para>Filters the results to only those inference components with a name that contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort the inference components in the response. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.StatusEqual"> <summary> <para> <para>Filters the results to only those inference components with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.VariantNameEqual"> <summary> <para> <para>A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of inference components to return in the response. This value defaults to 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceComponentListCmdlet.NextToken"> <summary> <para> <para>A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.</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.GetSMInferenceComponentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceComponents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListInferenceComponentsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListInferenceComponentsResponse 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.GetSMInferenceComponentListCmdlet.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.GetSMInferenceExperimentCmdlet"> <summary> Returns details about an inference experiment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentCmdlet.Name"> <summary> <para> <para>The name of the inference experiment to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentCmdlet.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.DescribeInferenceExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeInferenceExperimentResponse 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.GetSMInferenceExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet"> <summary> Returns the list of all inference experiments.<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.GetSMInferenceExperimentListCmdlet.CreationTimeAfter"> <summary> <para> <para>Selects inference experiments which were created after this timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.CreationTimeBefore"> <summary> <para> <para>Selects inference experiments which were created before this timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>Selects inference experiments which were last modified after this timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>Selects inference experiments which were last modified before this timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.NameContain"> <summary> <para> <para>Selects inference experiments whose names contain this name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.SortBy"> <summary> <para> <para>The column by which to sort the listed inference experiments.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.SortOrder"> <summary> <para> <para>The direction of sorting (ascending or descending).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.StatusEqual"> <summary> <para> <para> Selects inference experiments which are in this status. For the possible statuses, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html">DescribeInferenceExperiment</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.Type"> <summary> <para> <para> Selects inference experiments of this type. For the possible types of inference experiments, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html">CreateInferenceExperiment</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceExperimentListCmdlet.NextToken"> <summary> <para> <para> The response from the last list when returning a list large enough to need tokening. </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.GetSMInferenceExperimentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceExperiments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListInferenceExperimentsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListInferenceExperimentsResponse 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.GetSMInferenceExperimentListCmdlet.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.GetSMInferenceRecommendationsJobCmdlet"> <summary> Provides the results of the Inference Recommender job. One or more recommendation jobs are returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobCmdlet.JobName"> <summary> <para> <para>The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobCmdlet.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.DescribeInferenceRecommendationsJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeInferenceRecommendationsJobResponse 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.GetSMInferenceRecommendationsJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobName parameter. The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet"> <summary> Lists recommendation jobs that satisfy various filters.<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.GetSMInferenceRecommendationsJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only jobs created after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only jobs created before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only jobs that were last modified after the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only jobs that were last modified before the specified time (timestamp).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.ModelNameEqual"> <summary> <para> <para>A filter that returns only jobs that were created for this model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.ModelPackageVersionArnEqual"> <summary> <para> <para>A filter that returns only jobs that were created for this versioned model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.NameContain"> <summary> <para> <para>A string in the job name. This filter returns only recommendations whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only inference recommendations jobs with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recommendations to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListInferenceRecommendationsJobsRequest</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of recommendations, 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.GetSMInferenceRecommendationsJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceRecommendationsJobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListInferenceRecommendationsJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListInferenceRecommendationsJobsResponse 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.GetSMInferenceRecommendationsJobListCmdlet.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.GetSMInferenceRecommendationsJobStepListCmdlet"> <summary> Returns a list of the subtasks for an Inference Recommender job. <para> The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types. </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.GetSMInferenceRecommendationsJobStepListCmdlet.JobName"> <summary> <para> <para>The name for the Inference Recommender job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobStepListCmdlet.Status"> <summary> <para> <para>A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobStepListCmdlet.StepType"> <summary> <para> <para>A filter to return details about the specified type of subtask.</para><para><c>BENCHMARK</c>: Evaluate the performance of your model on different instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobStepListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobStepListCmdlet.NextToken"> <summary> <para> <para>A token that you can specify to return more results from the list. Specify this field if you have a token that was returned from a previous 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.GetSMInferenceRecommendationsJobStepListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Steps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListInferenceRecommendationsJobStepsResponse 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.GetSMInferenceRecommendationsJobStepListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobName parameter. The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMInferenceRecommendationsJobStepListCmdlet.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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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 <c>ListLabelingJobs</c> request was truncated, the response includes a <c>NextToken</c>. 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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLabelingJobListForWorkteamCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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 <c>ListLabelingJobsForWorkteam</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMLineageGroupCmdlet"> <summary> Provides a list of properties for the requested lineage group. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html"> Cross-Account Lineage Tracking </a> in the <i>Amazon SageMaker Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupCmdlet.LineageGroupName"> <summary> <para> <para>The name of the lineage group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupCmdlet.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.DescribeLineageGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeLineageGroupResponse 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.GetSMLineageGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LineageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LineageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupListCmdlet"> <summary> A list of lineage groups shared with your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html"> Cross-Account Lineage Tracking </a> in the <i>Amazon SageMaker Developer Guide</i>.<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.GetSMLineageGroupListCmdlet.CreatedAfter"> <summary> <para> <para>A timestamp to filter against lineage groups created after a certain point in time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupListCmdlet.CreatedBefore"> <summary> <para> <para>A timestamp to filter against lineage groups created before a certain point in time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of endpoints to return in the response. This value defaults to 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupListCmdlet.NextToken"> <summary> <para> <para>If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, 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.GetSMLineageGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LineageGroupSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListLineageGroupsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListLineageGroupsResponse 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.GetSMLineageGroupListCmdlet.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.GetSMLineageGroupPolicyCmdlet"> <summary> The resource policy for the lineage group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupPolicyCmdlet.LineageGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the lineage group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMLineageGroupPolicyCmdlet.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.GetLineageGroupPolicyResponse). Specifying the name of a property of type Amazon.SageMaker.Model.GetLineageGroupPolicyResponse 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.GetSMLineageGroupPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LineageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^LineageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelCmdlet"> <summary> Describes a model that you created using the <c>CreateModel</c> 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.GetSMModelBiasJobDefinitionCmdlet"> <summary> Returns a description of a model bias job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionCmdlet.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.DescribeModelBiasJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelBiasJobDefinitionResponse 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.GetSMModelBiasJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet"> <summary> Lists model bias jobs definitions that satisfy various filters.<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.GetSMModelBiasJobDefinitionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only model bias jobs created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only model bias jobs created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.EndpointName"> <summary> <para> <para>Name of the endpoint to monitor for model bias.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.NameContain"> <summary> <para> <para>Filter for model bias jobs whose name contains a specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.SortBy"> <summary> <para> <para>Whether to sort results by the <c>Name</c> or <c>CreationTime</c> field. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.SortOrder"> <summary> <para> <para>Whether to sort the results in <c>Ascending</c> or <c>Descending</c> order. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of model bias jobs to return in the response. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelBiasJobDefinitionListCmdlet.NextToken"> <summary> <para> <para>The token returned if the response is truncated. To retrieve the next set of job executions, use it 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.GetSMModelBiasJobDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelBiasJobDefinitionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelBiasJobDefinitionsResponse 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.GetSMModelBiasJobDefinitionListCmdlet.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.GetSMModelCardCmdlet"> <summary> Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardCmdlet.ModelCardName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the model card to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardCmdlet.ModelCardVersion"> <summary> <para> <para>The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardCmdlet.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.DescribeModelCardResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelCardResponse 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.GetSMModelCardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobCmdlet"> <summary> Describes an Amazon SageMaker Model Card export job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobCmdlet.ModelCardExportJobArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model card export job to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobCmdlet.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.DescribeModelCardExportJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelCardExportJobResponse 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.GetSMModelCardExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardExportJobArn parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardExportJobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet"> <summary> List the export jobs for the Amazon SageMaker Model Card.<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.GetSMModelCardExportJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>Only list model card export jobs that were created after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>Only list model card export jobs that were created before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.ModelCardExportJobNameContain"> <summary> <para> <para>Only list model card export jobs with names that contain the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.ModelCardName"> <summary> <para> <para>List export jobs for the model card with the specified name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.ModelCardVersion"> <summary> <para> <para>List export jobs for the model card with the specified version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.SortBy"> <summary> <para> <para>Sort model card export jobs by either name or creation time. Sorts by creation time by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.SortOrder"> <summary> <para> <para>Sort model card export jobs by ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.StatusEqual"> <summary> <para> <para>Only list model card export jobs with the specified status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of model card export jobs to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListModelCardExportJobs</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of model card export 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.GetSMModelCardExportJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelCardExportJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelCardExportJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelCardExportJobsResponse 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.GetSMModelCardExportJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardExportJobListCmdlet.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.GetSMModelCardListCmdlet"> <summary> List existing model cards.<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.GetSMModelCardListCmdlet.CreationTimeAfter"> <summary> <para> <para>Only list model cards that were created after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.CreationTimeBefore"> <summary> <para> <para>Only list model cards that were created before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.ModelCardStatus"> <summary> <para> <para>Only list model cards with the specified approval status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.NameContain"> <summary> <para> <para>Only list model cards with names that contain the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.SortBy"> <summary> <para> <para>Sort model cards by either name or creation time. Sorts by creation time by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.SortOrder"> <summary> <para> <para>Sort model cards by ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of model cards to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListModelCards</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of model cards, 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.GetSMModelCardListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelCardSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelCardsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelCardsResponse 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.GetSMModelCardListCmdlet.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.GetSMModelCardVersionListCmdlet"> <summary> List existing versions of an Amazon SageMaker Model Card.<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.GetSMModelCardVersionListCmdlet.CreationTimeAfter"> <summary> <para> <para>Only list model card versions that were created after the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.CreationTimeBefore"> <summary> <para> <para>Only list model card versions that were created before the time specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.ModelCardName"> <summary> <para> <para>List model card versions for the model card with the specified name or Amazon Resource Name (ARN).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.ModelCardStatus"> <summary> <para> <para>Only list model card versions with the specified approval status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.SortBy"> <summary> <para> <para>Sort listed model card versions by version. Sorts by version by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.SortOrder"> <summary> <para> <para>Sort model card versions by ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of model card versions to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListModelCardVersions</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of model card versions, 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.GetSMModelCardVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelCardVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelCardVersionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelCardVersionsResponse 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.GetSMModelCardVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelCardVersionListCmdlet.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.GetSMModelExplainabilityJobDefinitionCmdlet"> <summary> Returns a description of a model explainability job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionCmdlet.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.DescribeModelExplainabilityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelExplainabilityJobDefinitionResponse 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.GetSMModelExplainabilityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet"> <summary> Lists model explainability job definitions that satisfy various filters.<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.GetSMModelExplainabilityJobDefinitionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only model explainability jobs created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only model explainability jobs created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.EndpointName"> <summary> <para> <para>Name of the endpoint to monitor for model explainability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.NameContain"> <summary> <para> <para>Filter for model explainability jobs whose name contains a specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.SortBy"> <summary> <para> <para>Whether to sort results by the <c>Name</c> or <c>CreationTime</c> field. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.SortOrder"> <summary> <para> <para>Whether to sort the results in <c>Ascending</c> or <c>Descending</c> order. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of jobs to return in the response. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelExplainabilityJobDefinitionListCmdlet.NextToken"> <summary> <para> <para>The token returned if the response is truncated. To retrieve the next set of job executions, use it 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.GetSMModelExplainabilityJobDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelExplainabilityJobDefinitionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelExplainabilityJobDefinitionsResponse 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.GetSMModelExplainabilityJobDefinitionListCmdlet.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.GetSMModelListCmdlet"> <summary> Lists models created with the <c>CreateModel</c> 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 model name. This filter returns only models 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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Descending</c>.</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 <c>ListModels</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMModelMetadataListCmdlet"> <summary> Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.<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.GetSMModelMetadataListCmdlet.SearchExpression_Filter"> <summary> <para> <para>A list of filter objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelMetadataListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of models to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelMetadataListCmdlet.NextToken"> <summary> <para> <para>If the response to a previous <c>ListModelMetadataResponse</c> request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, 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.GetSMModelMetadataListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelMetadataSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelMetadataResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelMetadataResponse 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.GetSMModelMetadataListCmdlet.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 SageMaker models or list them on Amazon Web Services Marketplace. <para> To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageCmdlet.ModelPackageName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the model package to describe.</para><para>When you specify a name, 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.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.GetSMModelPackageGroupCmdlet"> <summary> Gets a description for the specified model group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupCmdlet.ModelPackageGroupName"> <summary> <para> <para>The name of the model group to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupCmdlet.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.DescribeModelPackageGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelPackageGroupResponse 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.GetSMModelPackageGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet"> <summary> Gets a list of the model groups in your Amazon Web Services 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.GetSMModelPackageGroupListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only model groups created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only model groups created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet.NameContain"> <summary> <para> <para>A string in the model group name. This filter returns only model groups whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListModelPackageGroups</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of model groups, 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.GetSMModelPackageGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelPackageGroupSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelPackageGroupsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelPackageGroupsResponse 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.GetSMModelPackageGroupListCmdlet.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.GetSMModelPackageGroupPolicyCmdlet"> <summary> Gets a resource policy that manages access for a model group. For information about resource policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html">Identity-based policies and resource-based policies</a> in the <i>Amazon Web Services Identity and Access Management User Guide.</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupPolicyCmdlet.ModelPackageGroupName"> <summary> <para> <para>The name of the model group for which to get the resource policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageGroupPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourcePolicy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.GetModelPackageGroupPolicyResponse). Specifying the name of a property of type Amazon.SageMaker.Model.GetModelPackageGroupPolicyResponse 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.GetSMModelPackageGroupPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageGroupName' 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.ModelApprovalStatus"> <summary> <para> <para>A filter that returns only the model packages with the specified approval status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.ModelPackageGroupName"> <summary> <para> <para>A filter that returns only model versions that belong to the specified model group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelPackageListCmdlet.ModelPackageType"> <summary> <para> <para>A filter that returns only the model packages of the specified type. This can be one of the following values.</para><ul><li><para><c>UNVERSIONED</c> - List only unversioined models. This is the default value if no <c>ModelPackageType</c> is specified.</para></li><li><para><c>VERSIONED</c> - List only versioned models.</para></li><li><para><c>BOTH</c> - List both versioned and unversioned models.</para></li></ul> </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 <c>CreationTime</c>.</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 <c>Ascending</c>.</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 <c>ListModelPackages</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMModelQualityJobDefinitionCmdlet"> <summary> Returns a description of a model quality job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionCmdlet.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.DescribeModelQualityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeModelQualityJobDefinitionResponse 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.GetSMModelQualityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet"> <summary> Gets a list of model quality monitoring job definitions 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.GetSMModelQualityJobDefinitionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only model quality monitoring job definitions created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only model quality monitoring job definitions created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.EndpointName"> <summary> <para> <para>A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.NameContain"> <summary> <para> <para>A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.SortOrder"> <summary> <para> <para>Whether to sort the results in <c>Ascending</c> or <c>Descending</c> order. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a call to <c>ListModelQualityJobDefinitions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMModelQualityJobDefinitionListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListModelQualityJobDefinitions</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of model quality monitoring job definitions, 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.GetSMModelQualityJobDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListModelQualityJobDefinitionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListModelQualityJobDefinitionsResponse 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.GetSMModelQualityJobDefinitionListCmdlet.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.GetSMMonitoringAlertHistoryListCmdlet"> <summary> Gets a list of past alerts in a model monitoring schedule.<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.GetSMMonitoringAlertHistoryListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only alerts created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only alerts created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.MonitoringAlertName"> <summary> <para> <para>The name of a monitoring alert.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of a monitoring schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.SortBy"> <summary> <para> <para>The field used to sort results. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.SortOrder"> <summary> <para> <para>The sort order, whether <c>Ascending</c> or <c>Descending</c>, of the alert history. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only alerts with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to display. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertHistoryListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListMonitoringAlertHistory</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of alerts in the history, 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.GetSMMonitoringAlertHistoryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringAlertHistory'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListMonitoringAlertHistoryResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListMonitoringAlertHistoryResponse 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.GetSMMonitoringAlertHistoryListCmdlet.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.GetSMMonitoringAlertListCmdlet"> <summary> Gets the alerts for a single monitoring schedule.<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.GetSMMonitoringAlertListCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of a monitoring schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to display. The default is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListMonitoringAlerts</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of alerts in the history, 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.GetSMMonitoringAlertListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringAlertSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListMonitoringAlertsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListMonitoringAlertsResponse 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.GetSMMonitoringAlertListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringAlertListCmdlet.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.GetSMMonitoringExecutionListCmdlet"> <summary> Returns list of all monitoring job executions.<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.GetSMMonitoringExecutionListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only jobs created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only jobs created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.EndpointName"> <summary> <para> <para>Name of a specific endpoint to fetch jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only jobs modified before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only jobs modified after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.MonitoringJobDefinitionName"> <summary> <para> <para>Gets a list of the monitoring job runs of the specified monitoring job definitions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.MonitoringScheduleName"> <summary> <para> <para>Name of a specific schedule to fetch jobs for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.MonitoringTypeEqual"> <summary> <para> <para>A filter that returns only the monitoring job runs of the specified monitoring type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.ScheduledTimeAfter"> <summary> <para> <para>Filter for jobs scheduled after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.ScheduledTimeBefore"> <summary> <para> <para>Filter for jobs scheduled before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.SortBy"> <summary> <para> <para>Whether to sort the results by the <c>Status</c>, <c>CreationTime</c>, or <c>ScheduledTime</c> field. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.SortOrder"> <summary> <para> <para>Whether to sort the results in <c>Ascending</c> or <c>Descending</c> order. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only jobs with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of jobs to return in the response. 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.GetSMMonitoringExecutionListCmdlet.NextToken"> <summary> <para> <para>The token returned if the response is truncated. To retrieve the next set of job executions, use it 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.GetSMMonitoringExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringExecutionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListMonitoringExecutionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListMonitoringExecutionsResponse 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.GetSMMonitoringExecutionListCmdlet.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.GetSMMonitoringScheduleCmdlet"> <summary> Describes the schedule for a monitoring job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleCmdlet.MonitoringScheduleName"> <summary> <para> <para>Name of a previously created monitoring schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleCmdlet.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.DescribeMonitoringScheduleResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeMonitoringScheduleResponse 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.GetSMMonitoringScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet"> <summary> Returns list of all monitoring schedules.<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.GetSMMonitoringScheduleListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only monitoring schedules created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only monitoring schedules created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.EndpointName"> <summary> <para> <para>Name of a specific endpoint to fetch schedules for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only monitoring schedules modified after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only monitoring schedules modified before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.MonitoringJobDefinitionName"> <summary> <para> <para>Gets a list of the monitoring schedules for the specified monitoring job definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.MonitoringTypeEqual"> <summary> <para> <para>A filter that returns only the monitoring schedules for the specified monitoring type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.NameContain"> <summary> <para> <para>Filter for monitoring schedules whose name contains a specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.SortBy"> <summary> <para> <para>Whether to sort the results by the <c>Status</c>, <c>CreationTime</c>, or <c>ScheduledTime</c> field. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.SortOrder"> <summary> <para> <para>Whether to sort the results in <c>Ascending</c> or <c>Descending</c> order. The default is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.StatusEqual"> <summary> <para> <para>A filter that returns only monitoring schedules modified before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMMonitoringScheduleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of jobs to return in the response. 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.GetSMMonitoringScheduleListCmdlet.NextToken"> <summary> <para> <para>The token returned if the response is truncated. To retrieve the next set of job executions, use it 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.GetSMMonitoringScheduleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringScheduleSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListMonitoringSchedulesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListMonitoringSchedulesResponse 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.GetSMMonitoringScheduleListCmdlet.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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html">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 <c>CreationTime</c>.</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 <c>ListNotebookInstanceLifecycleConfigs</c> request was truncated, the response includes a <c>NextToken</c>. 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 SageMaker notebook instances in the requester's account in an Amazon Web Services 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 <c>Name</c>.</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 <c>ListNotebookInstances</c> is truncated, the response includes a <c>NextToken</c>. You can use this token in your subsequent <c>ListNotebookInstances</c> 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.GetSMPipelineCmdlet"> <summary> Describes the details of a pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineCmdlet.PipelineName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the pipeline to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineCmdlet.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.DescribePipelineResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribePipelineResponse 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.GetSMPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineDefinitionForExecutionCmdlet"> <summary> Describes the details of an execution's pipeline definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineDefinitionForExecutionCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineDefinitionForExecutionCmdlet.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.DescribePipelineDefinitionForExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribePipelineDefinitionForExecutionResponse 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.GetSMPipelineDefinitionForExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionCmdlet"> <summary> Describes the details of a pipeline execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionCmdlet.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.DescribePipelineExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribePipelineExecutionResponse 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.GetSMPipelineExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet"> <summary> Gets a list of the pipeline executions.<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.GetSMPipelineExecutionListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns the pipeline executions that were created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns the pipeline executions that were created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.PipelineName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort results. The default is <c>CreatedTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of pipeline executions to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListPipelineExecutions</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of pipeline executions, 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.GetSMPipelineExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListPipelineExecutionsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListPipelineExecutionsResponse 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.GetSMPipelineExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionListCmdlet.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.GetSMPipelineExecutionStepListCmdlet"> <summary> Gets a list of <c>PipeLineExecutionStep</c> objects.<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.GetSMPipelineExecutionStepListCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionStepListCmdlet.SortOrder"> <summary> <para> <para>The field by which to sort results. The default is <c>CreatedTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionStepListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of pipeline execution steps to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionStepListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListPipelineExecutionSteps</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of pipeline execution steps, 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.GetSMPipelineExecutionStepListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionSteps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListPipelineExecutionStepsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListPipelineExecutionStepsResponse 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.GetSMPipelineExecutionStepListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineExecutionStepListCmdlet.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.GetSMPipelineListCmdlet"> <summary> Gets a list of pipelines.<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.GetSMPipelineListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns the pipelines that were created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns the pipelines that were created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineListCmdlet.PipelineNamePrefix"> <summary> <para> <para>The prefix of the pipeline name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort results. The default is <c>CreatedTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of pipelines to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListPipelines</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of pipelines, 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.GetSMPipelineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListPipelinesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListPipelinesResponse 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.GetSMPipelineListCmdlet.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.GetSMPipelineParametersForExecutionListCmdlet"> <summary> Gets a list of parameters for a pipeline execution.<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.GetSMPipelineParametersForExecutionListCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineParametersForExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of parameters to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineParametersForExecutionListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListPipelineParametersForExecution</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of parameters, 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.GetSMPipelineParametersForExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineParameters'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListPipelineParametersForExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListPipelineParametersForExecutionResponse 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.GetSMPipelineParametersForExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMPipelineParametersForExecutionListCmdlet.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.GetSMProcessingJobCmdlet"> <summary> Returns a description of a processing job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobCmdlet.ProcessingJobName"> <summary> <para> <para>The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobCmdlet.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.DescribeProcessingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeProcessingJobResponse 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.GetSMProcessingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProcessingJobName parameter. The -PassThru parameter is deprecated, use -Select '^ProcessingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet"> <summary> Lists processing jobs that satisfy various filters.<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.GetSMProcessingJobListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only processing jobs created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only processing jobs created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.LastModifiedTimeAfter"> <summary> <para> <para>A filter that returns only processing jobs modified after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.LastModifiedTimeBefore"> <summary> <para> <para>A filter that returns only processing jobs modified before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.NameContain"> <summary> <para> <para>A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.StatusEqual"> <summary> <para> <para>A filter that retrieves only processing jobs with a specific status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProcessingJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of processing 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.GetSMProcessingJobListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListProcessingJobs</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of processing 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.GetSMProcessingJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProcessingJobSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListProcessingJobsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListProcessingJobsResponse 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.GetSMProcessingJobListCmdlet.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.GetSMProjectCmdlet"> <summary> Describes the details of a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectCmdlet.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.DescribeProjectResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeProjectResponse 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.GetSMProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet"> <summary> Gets a list of the projects in an Amazon Web Services 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.GetSMProjectListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns the projects that were created after a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns the projects that were created before a specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet.NameContain"> <summary> <para> <para>A filter that returns the projects whose name contains a specified string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet.SortBy"> <summary> <para> <para>The field by which to sort results. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of projects to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMProjectListCmdlet.NextToken"> <summary> <para> <para>If the result of the previous <c>ListProjects</c> request was truncated, the response includes a <c>NextToken</c>. To retrieve the next set of projects, 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.GetSMProjectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListProjectsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListProjectsResponse 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.GetSMProjectListCmdlet.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.GetSMResourceCatalogListCmdlet"> <summary> Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of <c>ResourceCatalog</c>s viewable is 1000.<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.GetSMResourceCatalogListCmdlet.CreationTimeAfter"> <summary> <para> <para> Use this parameter to search for <c>ResourceCatalog</c>s created after a specific date and time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceCatalogListCmdlet.CreationTimeBefore"> <summary> <para> <para> Use this parameter to search for <c>ResourceCatalog</c>s created before a specific date and time. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceCatalogListCmdlet.NameContain"> <summary> <para> <para> A string that partially matches one or more <c>ResourceCatalog</c>s names. Filters <c>ResourceCatalog</c> by name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceCatalogListCmdlet.SortBy"> <summary> <para> <para> The value on which the resource catalog list is sorted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceCatalogListCmdlet.SortOrder"> <summary> <para> <para> The order in which the resource catalogs are listed. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceCatalogListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results returned by <c>ListResourceCatalogs</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMResourceCatalogListCmdlet.NextToken"> <summary> <para> <para> A token to resume pagination of <c>ListResourceCatalogs</c> results. </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.GetSMResourceCatalogListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceCatalogs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListResourceCatalogsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListResourceCatalogsResponse 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.GetSMResourceCatalogListCmdlet.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.GetSMResourceCatalogListCmdlet.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 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 <c>ListTags</c> request is truncated, 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.GetSMSagemakerServicecatalogPortfolioStatusCmdlet"> <summary> Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSagemakerServicecatalogPortfolioStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.GetSagemakerServicecatalogPortfolioStatusResponse). Specifying the name of a property of type Amazon.SageMaker.Model.GetSagemakerServicecatalogPortfolioStatusResponse 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="T:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet"> <summary> Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.EndpointName"> <summary> <para> <para>The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the <c>InferenceRecommendationsJobName</c> field.</para><para>Specify either this field or the <c>RecommendationId</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.InferenceRecommendationsJobName"> <summary> <para> <para>The name of a previously completed Inference Recommender job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.ScalingPolicyObjective_MaxInvocationsPerMinute"> <summary> <para> <para>The maximum number of expected requests to your endpoint per minute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.ScalingPolicyObjective_MinInvocationsPerMinute"> <summary> <para> <para>The minimum number of expected requests to your endpoint per minute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.RecommendationId"> <summary> <para> <para>The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the <c>InferenceRecommendationsJobName</c> field.</para><para>Specify either this field or the <c>EndpointName</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.TargetCpuUtilizationPerCore"> <summary> <para> <para>The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMScalingConfigurationRecommendationCmdlet.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.GetScalingConfigurationRecommendationResponse). Specifying the name of a property of type Amazon.SageMaker.Model.GetScalingConfigurationRecommendationResponse 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.GetSMScalingConfigurationRecommendationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InferenceRecommendationsJobName parameter. The -PassThru parameter is deprecated, use -Select '^InferenceRecommendationsJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet"> <summary> An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in <c>Search</c> queries. Provides suggestions for <c>HyperParameters</c>, <c>Tags</c>, and <c>Metrics</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet.PropertyNameQuery_PropertyNameHint"> <summary> <para> <para>Text that begins a property's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSearchSuggestionCmdlet.Resource"> <summary> <para> <para>The name of the SageMaker resource to search for.</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.GetSMSpaceCmdlet"> <summary> Describes the space. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceCmdlet.DomainId"> <summary> <para> <para>The ID of the associated domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceCmdlet.SpaceName"> <summary> <para> <para>The name of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceCmdlet.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.DescribeSpaceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeSpaceResponse 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.GetSMSpaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpaceName parameter. The -PassThru parameter is deprecated, use -Select '^SpaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceListCmdlet"> <summary> Lists spaces.<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.GetSMSpaceListCmdlet.DomainIdEqual"> <summary> <para> <para>A parameter to search for the domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is <c>Ascending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceListCmdlet.SpaceNameContain"> <summary> <para> <para>A parameter by which to filter the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return in the response. If the total number of items available is more than the value specified, a <c>NextToken</c> is provided in the response. To resume pagination, provide the <c>NextToken</c> value in the as part of a subsequent call. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMSpaceListCmdlet.NextToken"> <summary> <para> <para>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</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.GetSMSpaceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Spaces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListSpacesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListSpacesResponse 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.GetSMSpaceListCmdlet.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.GetSMStageDeviceListCmdlet"> <summary> Lists devices allocated to the stage, containing detailed device information and deployment status.<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.GetSMStageDeviceListCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStageDeviceListCmdlet.ExcludeDevicesDeployedInOtherStage"> <summary> <para> <para>Toggle for excluding devices deployed in other stages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStageDeviceListCmdlet.StageName"> <summary> <para> <para>The name of the stage in the deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStageDeviceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of requests to select.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStageDeviceListCmdlet.NextToken"> <summary> <para> <para>The response from the last list when returning a list large enough to neeed tokening.</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.GetSMStageDeviceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DeviceDeploymentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListStageDevicesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListStageDevicesResponse 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.GetSMStageDeviceListCmdlet.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.GetSMStudioLifecycleConfigCmdlet"> <summary> Describes the Amazon SageMaker Studio Lifecycle Configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigCmdlet.StudioLifecycleConfigName"> <summary> <para> <para>The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigCmdlet.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.DescribeStudioLifecycleConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeStudioLifecycleConfigResponse 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.GetSMStudioLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^StudioLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet"> <summary> Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services 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.GetSMStudioLifecycleConfigListCmdlet.AppTypeEqual"> <summary> <para> <para>A parameter to search for the App Type to which the Lifecycle Configuration is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.CreationTimeAfter"> <summary> <para> <para>A filter that returns only Lifecycle Configurations created on or after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.CreationTimeBefore"> <summary> <para> <para>A filter that returns only Lifecycle Configurations created on or before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.ModifiedTimeAfter"> <summary> <para> <para>A filter that returns only Lifecycle Configurations modified after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.ModifiedTimeBefore"> <summary> <para> <para>A filter that returns only Lifecycle Configurations modified before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.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.GetSMStudioLifecycleConfigListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is CreationTime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is Descending.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return in the response. If the total number of items available is more than the value specified, a <c>NextToken</c> is provided in the response. To resume pagination, provide the <c>NextToken</c> value in the as part of a subsequent call. The default value is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMStudioLifecycleConfigListCmdlet.NextToken"> <summary> <para> <para>If the previous call to ListStudioLifecycleConfigs didn't return the full set of Lifecycle Configurations, the call returns a token for getting the next set of Lifecycle Configurations.</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.GetSMStudioLifecycleConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioLifecycleConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListStudioLifecycleConfigsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListStudioLifecycleConfigsResponse 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.GetSMStudioLifecycleConfigListCmdlet.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.GetSMSubscribedWorkteamCmdlet"> <summary> Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services 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 Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the <c>NameContains</c> 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 <c>ListSubscribedWorkteams</c> request was truncated, the response includes a <c>NextToken</c>. 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. <para> Some of the attributes below only appear if the training job successfully starts. If the training job fails, <c>TrainingJobStatus</c> is <c>Failed</c> and, depending on the <c>FailureReason</c>, attributes like <c>TrainingStartTime</c>, <c>TrainingTimeInSeconds</c>, <c>TrainingEndTime</c>, and <c>BillableTimeInSeconds</c> may not be present in the response. </para> </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. <note><para> When <c>StatusEquals</c> and <c>MaxResults</c> are set at the same time, the <c>MaxResults</c> number of training jobs are first retrieved ignoring the <c>StatusEquals</c> parameter and then they are filtered by the <c>StatusEquals</c> parameter, which is returned as a response. </para><para> For example, if <c>ListTrainingJobs</c> is invoked with the following parameters: </para><para><c>{ ... MaxResults: 100, StatusEquals: InProgress ... }</c></para><para> First, 100 trainings jobs with any status, including those other than <c>InProgress</c>, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of <c>InProgress</c> are returned. </para><para> You can quickly test the API using the following Amazon Web Services CLI code. </para><para><c>aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress</c></para></note><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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrainingJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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.WarmPoolStatusEqual"> <summary> <para> <para>A filter that retrieves only training jobs with a specific warm pool 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 <c>ListTrainingJobs</c> request was truncated, the response includes a <c>NextToken</c>. 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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">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 <c>Name</c>.</para><para>If the value of this field is <c>FinalObjectiveMetricValue</c>, 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 <c>Ascending</c>.</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 <c>ListTrainingJobsForHyperParameterTuningJob</c> request was truncated, the response includes a <c>NextToken</c>. 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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTransformJobListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Descending</c>.</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 <c>10</c>.</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 <c>ListTransformJobs</c> request was truncated, the response includes a <c>NextToken</c>. 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.GetSMTrialCmdlet"> <summary> Provides a list of a trial's properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialCmdlet.TrialName"> <summary> <para> <para>The name of the trial to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialCmdlet.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.DescribeTrialResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeTrialResponse 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.GetSMTrialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialName parameter. The -PassThru parameter is deprecated, use -Select '^TrialName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentCmdlet"> <summary> Provides a list of a trials component's properties. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentCmdlet.TrialComponentName"> <summary> <para> <para>The name of the trial component to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentCmdlet.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.DescribeTrialComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeTrialComponentResponse 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.GetSMTrialComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialComponentName parameter. The -PassThru parameter is deprecated, use -Select '^TrialComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet"> <summary> Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following: <ul><li><para><c>ExperimentName</c></para></li><li><para><c>SourceArn</c></para></li><li><para><c>TrialName</c></para></li></ul><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.GetSMTrialComponentListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only components created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only components created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.ExperimentName"> <summary> <para> <para>A filter that returns only components that are part of the specified experiment. If you specify <c>ExperimentName</c>, you can't filter by <c>SourceArn</c> or <c>TrialName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.SourceArn"> <summary> <para> <para>A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify <c>SourceArn</c>, you can't filter by <c>ExperimentName</c> or <c>TrialName</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.TrialName"> <summary> <para> <para>A filter that returns only components that are part of the specified trial. If you specify <c>TrialName</c>, you can't filter by <c>ExperimentName</c> or <c>SourceArn</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialComponentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of components to return in the response. 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.GetSMTrialComponentListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListTrialComponents</c> didn't return the full set of components, the call returns a token for getting the next set of components.</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.GetSMTrialComponentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialComponentSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTrialComponentsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListTrialComponentsResponse 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.GetSMTrialComponentListCmdlet.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.GetSMTrialListCmdlet"> <summary> Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.<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.GetSMTrialListCmdlet.CreatedAfter"> <summary> <para> <para>A filter that returns only trials created after the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialListCmdlet.CreatedBefore"> <summary> <para> <para>A filter that returns only trials created before the specified time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialListCmdlet.ExperimentName"> <summary> <para> <para>A filter that returns only trials that are part of the specified experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialListCmdlet.SortBy"> <summary> <para> <para>The property used to sort results. The default value is <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialListCmdlet.SortOrder"> <summary> <para> <para>The sort order. The default value is <c>Descending</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialListCmdlet.TrialComponentName"> <summary> <para> <para>A filter that returns only trials that are associated with the specified trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMTrialListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of trials to return in the response. 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.GetSMTrialListCmdlet.NextToken"> <summary> <para> <para>If the previous call to <c>ListTrials</c> didn't return the full set of trials, the call returns a token for getting the next set of trials.</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.GetSMTrialListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListTrialsResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListTrialsResponse 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.GetSMTrialListCmdlet.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.GetSMUserProfileCmdlet"> <summary> Describes a user profile. For more information, see <c>CreateUserProfile</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileCmdlet.UserProfileName"> <summary> <para> <para>The user profile name. This value is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileCmdlet.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.DescribeUserProfileResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeUserProfileResponse 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.GetSMUserProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserProfileName parameter. The -PassThru parameter is deprecated, use -Select '^UserProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileListCmdlet"> <summary> Lists user profiles.<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.GetSMUserProfileListCmdlet.DomainIdEqual"> <summary> <para> <para>A parameter by which to filter the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileListCmdlet.SortBy"> <summary> <para> <para>The parameter by which to sort the results. The default is CreationTime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileListCmdlet.SortOrder"> <summary> <para> <para>The sort order for the results. The default is Ascending.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileListCmdlet.UserProfileNameContain"> <summary> <para> <para>A parameter by which to filter the results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMUserProfileListCmdlet.MaxResult"> <summary> <para> <para>The total number of items to return in the response. If the total number of items available is more than the value specified, a <c>NextToken</c> is provided in the response. To resume pagination, provide the <c>NextToken</c> value in the as part of a subsequent call. 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.GetSMUserProfileListCmdlet.NextToken"> <summary> <para> <para>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</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.GetSMUserProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserProfiles'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListUserProfilesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListUserProfilesResponse 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.GetSMUserProfileListCmdlet.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.GetSMWorkforceCmdlet"> <summary> Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>). Allowable IP address ranges are the IP addresses that workers can use to access tasks. <important><para> This operation applies only to private workforces. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceCmdlet.WorkforceName"> <summary> <para> <para>The name of the private workforce whose access you want to restrict. <c>WorkforceName</c> is automatically set to <c>default</c> when a workforce is created and cannot be modified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workforce'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DescribeWorkforceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DescribeWorkforceResponse 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.GetSMWorkforceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkforceName parameter. The -PassThru parameter is deprecated, use -Select '^WorkforceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceListCmdlet"> <summary> Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services 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.GetSMWorkforceListCmdlet.NameContain"> <summary> <para> <para>A filter you can use to search for workforces using part of the workforce name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceListCmdlet.SortBy"> <summary> <para> <para>Sort workforces using the workforce name or creation date.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceListCmdlet.SortOrder"> <summary> <para> <para>Sort workforces in ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of workforces returned in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkforceListCmdlet.NextToken"> <summary> <para> <para>A token to resume pagination.</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.GetSMWorkforceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workforces'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.ListWorkforcesResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ListWorkforcesResponse 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.GetSMWorkforceListCmdlet.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 private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the <c>NameContains</c> 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 <c>CreationTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.GetSMWorkteamListCmdlet.SortOrder"> <summary> <para> <para>The sort order for results. The default is <c>Ascending</c>.</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 <c>ListWorkteams</c> request was truncated, the response includes a <c>NextToken</c>. 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.ImportSMHubContentCmdlet"> <summary> Import hub content. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.DocumentSchemaVersion"> <summary> <para> <para>The version of the hub content schema to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentDescription"> <summary> <para> <para>A description of the hub content to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentDisplayName"> <summary> <para> <para>The display name of the hub content to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentDocument"> <summary> <para> <para>The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentMarkdown"> <summary> <para> <para>A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentName"> <summary> <para> <para>The name of the hub content to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentSearchKeyword"> <summary> <para> <para>The searchable keywords of the hub content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentType"> <summary> <para> <para>The type of hub content to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubContentVersion"> <summary> <para> <para>The version of the hub content to import.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.HubName"> <summary> <para> <para>The name of the hub to import content into.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.Tag"> <summary> <para> <para>Any tags associated with the hub content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.ImportSMHubContentCmdlet.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.ImportHubContentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.ImportHubContentResponse 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.ImportSMHubContentCmdlet.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.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.HumanTaskUiArn"> <summary> <para> <para>The <c>HumanTaskUiArn</c> of the worker UI that you want to render. Do not provide a <c>HumanTaskUiArn</c> if you use the <c>UiTemplate</c> parameter.</para><para>See a list of available Human Ui Amazon Resource Names (ARNs) in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html">UiConfig</a>.</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 <c>task.input</c>. For example, if you define a variable <c>task.input.text</c> in your template, you can supply the variable in the JSON object as <c>"text": "sample text"</c>.</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.NewSMActionCmdlet"> <summary> Creates an <i>action</i>. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.ActionName"> <summary> <para> <para>The name of the action. Must be unique to your account in an Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.ActionType"> <summary> <para> <para>The action type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.MetadataProperties_CommitId"> <summary> <para> <para>The commit ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Description"> <summary> <para> <para>The description of the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.MetadataProperties_GeneratedBy"> <summary> <para> <para>The entity this entity was generated by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.MetadataProperties_ProjectId"> <summary> <para> <para>The project ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Property"> <summary> <para> <para>A list of properties to add to the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.MetadataProperties_Repository"> <summary> <para> <para>The repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Source_SourceId"> <summary> <para> <para>The ID of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Source_SourceType"> <summary> <para> <para>The type of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Source_SourceUri"> <summary> <para> <para>The URI of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Status"> <summary> <para> <para>The status of the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateActionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateActionResponse 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.NewSMActionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActionName parameter. The -PassThru parameter is deprecated, use -Select '^ActionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMActionCmdlet.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 SageMaker and list in the Amazon Web Services 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 Amazon Web Services Marketplace.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.AdditionalS3DataSource_CompressionType"> <summary> <para> <para>The type of compression used for an additional data source used in inference or training. Specify <c>None</c> if your additional data source is not compressed.</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 <c>MetricDefinition</c> objects, which are used for parsing metrics generated by the algorithm.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.AdditionalS3DataSource_S3DataType"> <summary> <para> <para>The data type of the additional data source that you specify for use in inference or training. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.AdditionalS3DataSource_S3Uri"> <summary> <para> <para>The uniform resource identifier (URI) used to identify an additional data source used in inference or training.</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 <c>HyperParameterSpecification</c> 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>This parameter is required for unversioned models, and optional for versioned models.</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>This parameter is required for unversioned models, and optional for versioned models.</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.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAlgorithmCmdlet.TrainingSpecification_TrainingChannel"> <summary> <para> <para>A list of <c>ChannelSpecification</c> 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 <c>AlgorithmValidationProfile</c> objects, each of which specifies a training job and batch transform job that 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 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.NewSMAppCmdlet"> <summary> Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.AppName"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.AppType"> <summary> <para> <para>The type of app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.ResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.ResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.ResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.ResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.ResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.SpaceName"> <summary> <para> <para>The name of the space. If this value is not set, then <c>UserProfileName</c> must be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.Tag"> <summary> <para> <para>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.UserProfileName"> <summary> <para> <para>The user profile name. If this value is not set, then <c>SpaceName</c> must be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAppResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAppResponse 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.NewSMAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppName parameter. The -PassThru parameter is deprecated, use -Select '^AppName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppCmdlet.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.NewSMAppImageConfigCmdlet"> <summary> Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.AppImageConfigName"> <summary> <para> <para>The name of the AppImageConfig. Must be unique to your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.CodeEditorAppImageConfig_ContainerConfig_ContainerArguments"> <summary> <para> <para>The arguments for the container when you're running the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.ContainerConfig_ContainerArgument"> <summary> <para> <para>The arguments for the container when you're running the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.CodeEditorAppImageConfig_ContainerConfig_ContainerEntrypoint"> <summary> <para> <para>The entrypoint used to run the application in the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.ContainerConfig_ContainerEntrypoint"> <summary> <para> <para>The entrypoint used to run the application in the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.CodeEditorAppImageConfig_ContainerConfig_ContainerEnvironmentVariables"> <summary> <para> <para>The environment variables to set in the container</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.ContainerConfig_ContainerEnvironmentVariable"> <summary> <para> <para>The environment variables to set in the container</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.CodeEditorAppImageConfig_FileSystemConfig_DefaultGid"> <summary> <para> <para>The default POSIX group ID (GID). If not specified, defaults to <c>100</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.JupyterLabAppImageConfig_FileSystemConfig_DefaultGid"> <summary> <para> <para>The default POSIX group ID (GID). If not specified, defaults to <c>100</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.FileSystemConfig_DefaultGid"> <summary> <para> <para>The default POSIX group ID (GID). If not specified, defaults to <c>100</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.CodeEditorAppImageConfig_FileSystemConfig_DefaultUid"> <summary> <para> <para>The default POSIX user ID (UID). If not specified, defaults to <c>1000</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.JupyterLabAppImageConfig_FileSystemConfig_DefaultUid"> <summary> <para> <para>The default POSIX user ID (UID). If not specified, defaults to <c>1000</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.FileSystemConfig_DefaultUid"> <summary> <para> <para>The default POSIX user ID (UID). If not specified, defaults to <c>1000</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.KernelGatewayImageConfig_KernelSpec"> <summary> <para> <para>The specification of the Jupyter kernels in the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.CodeEditorAppImageConfig_FileSystemConfig_MountPath"> <summary> <para> <para>The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to <i>/home/sagemaker-user</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.JupyterLabAppImageConfig_FileSystemConfig_MountPath"> <summary> <para> <para>The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to <i>/home/sagemaker-user</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.FileSystemConfig_MountPath"> <summary> <para> <para>The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to <i>/home/sagemaker-user</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the AppImageConfig.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppImageConfigArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAppImageConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAppImageConfigResponse 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.NewSMAppImageConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppImageConfigName parameter. The -PassThru parameter is deprecated, use -Select '^AppImageConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAppImageConfigCmdlet.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.NewSMArtifactCmdlet"> <summary> Creates an <i>artifact</i>. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.ArtifactName"> <summary> <para> <para>The name of the artifact. Must be unique to your account in an Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.ArtifactType"> <summary> <para> <para>The artifact type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.MetadataProperties_CommitId"> <summary> <para> <para>The commit ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.MetadataProperties_GeneratedBy"> <summary> <para> <para>The entity this entity was generated by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.MetadataProperties_ProjectId"> <summary> <para> <para>The project ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.Property"> <summary> <para> <para>A list of properties to add to the artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.MetadataProperties_Repository"> <summary> <para> <para>The repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.Source_SourceType"> <summary> <para> <para>A list of source types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.Source_SourceUri"> <summary> <para> <para>The URI of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMArtifactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ArtifactArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateArtifactResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateArtifactResponse 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.NewSMArtifactCmdlet.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.NewSMAutoMLJobCmdlet"> <summary> Creates an Autopilot job also referred to as Autopilot experiment or AutoML job. <note><para> We recommend using the new versions <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>, which offer backward compatibility. </para><para><c>CreateAutoMLJobV2</c> can manage tabular problem types identical to those of its previous version <c>CreateAutoMLJob</c>, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning). </para><para> Find guidelines about how to migrate a <c>CreateAutoMLJob</c> to <c>CreateAutoMLJobV2</c> in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2">Migrate a CreateAutoMLJob to CreateAutoMLJobV2</a>. </para></note><para> You can find the best-performing model after you run an AutoML job by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a> (recommended) or <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.CandidateGenerationConfig_AlgorithmsConfig"> <summary> <para> <para>Stores the configuration information for the selection of algorithms used to train the model candidates.</para><para>The list of available algorithms to choose from depends on the training mode set in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobConfig.html"><c>AutoMLJobConfig.Mode</c></a>.</para><ul><li><para><c>AlgorithmsConfig</c> should not be set in <c>AUTO</c> training mode.</para></li><li><para>When <c>AlgorithmsConfig</c> is provided, one <c>AutoMLAlgorithms</c> attribute must be set and one only.</para><para>If the list of algorithms provided as values for <c>AutoMLAlgorithms</c> is empty, <c>AutoMLCandidateGenerationConfig</c> uses the full set of algorithms for the given training mode.</para></li><li><para>When <c>AlgorithmsConfig</c> is not provided, <c>AutoMLCandidateGenerationConfig</c> uses the full set of algorithms for the given training mode.</para></li></ul><para>For the list of all algorithms per training mode, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html"> AutoMLAlgorithmConfig</a>.</para><para>For more information on each algorithm, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support">Algorithm support</a> section in Autopilot developer guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.ModelDeployConfig_AutoGenerateEndpointName"> <summary> <para> <para>Set to <c>True</c> to automatically generate an endpoint name for a one-click Autopilot model deployment; set to <c>False</c> otherwise. The default value is <c>False</c>.</para><note><para>If you set <c>AutoGenerateEndpointName</c> to <c>True</c>, do not specify the <c>EndpointName</c>; otherwise a 400 error is thrown.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.AutoMLJobName"> <summary> <para> <para>Identifies an Autopilot job. The name must be unique to your account and is case insensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.SecurityConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to use traffic encryption between the container layers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.ModelDeployConfig_EndpointName"> <summary> <para> <para>Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.</para><note><para>Specify the <c>EndpointName</c> if and only if you set <c>AutoGenerateEndpointName</c> to <c>False</c>; otherwise a 400 error is thrown.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.CandidateGenerationConfig_FeatureSpecificationS3Uri"> <summary> <para> <para>A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input <c>FeatureAttributeNames</c> (optional) in JSON format as shown below: </para><para><c>{ "FeatureAttributeNames":["col1", "col2", ...] }</c>.</para><para>You can also specify the data type of the feature (optional) in the format shown below:</para><para><c>{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }</c></para><note><para>These column keys may not include the target column.</para></note><para>In ensembling mode, Autopilot only supports the following data types: <c>numeric</c>, <c>categorical</c>, <c>text</c>, and <c>datetime</c>. In HPO mode, Autopilot can support <c>numeric</c>, <c>categorical</c>, <c>text</c>, <c>datetime</c>, and <c>sequence</c>.</para><para>If only <c>FeatureDataTypes</c> is provided, the column keys (<c>col1</c>, <c>col2</c>,..) should be a subset of the column names in the input data. </para><para>If both <c>FeatureDataTypes</c> and <c>FeatureAttributeNames</c> are provided, then the column keys should be a subset of the column names provided in <c>FeatureAttributeNames</c>. </para><para>The key name <c>FeatureAttributeNames</c> is fixed. The values listed in <c>["col1", "col2", ...]</c> are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.GenerateCandidateDefinitionsOnly"> <summary> <para> <para>Generates possible candidates without training the models. A candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.InputDataConfig"> <summary> <para> <para>An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to <c>InputDataConfig</c> supported by <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a>. Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>The Key Management Service encryption key ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.CompletionCriteria_MaxAutoMLJobRuntimeInSecond"> <summary> <para> <para>The maximum runtime, in seconds, an AutoML job has to complete.</para><para>If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.CompletionCriteria_MaxCandidate"> <summary> <para> <para>The maximum number of times a training job is allowed to run.</para><para>For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.CompletionCriteria_MaxRuntimePerTrainingJobInSecond"> <summary> <para> <para>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html">StoppingCondition</a> used by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> action.</para><para>For job V2s (jobs created by calling <c>CreateAutoMLJobV2</c>), this field controls the runtime of the job candidate.</para><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html">TextGenerationJobConfig</a> problem types, the maximum time defaults to 72 hours (259200 seconds).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.AutoMLJobObjective_MetricName"> <summary> <para> <para>The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model's parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.</para><para>The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.</para><ul><li><para>For tabular problem types:</para><ul><li><para>List of available metrics: </para><ul><li><para> Regression: <c>MAE</c>, <c>MSE</c>, <c>R2</c>, <c>RMSE</c></para></li><li><para> Binary classification: <c>Accuracy</c>, <c>AUC</c>, <c>BalancedAccuracy</c>, <c>F1</c>, <c>Precision</c>, <c>Recall</c></para></li><li><para> Multiclass classification: <c>Accuracy</c>, <c>BalancedAccuracy</c>, <c>F1macro</c>, <c>PrecisionMacro</c>, <c>RecallMacro</c></para></li></ul><para>For a description of each metric, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html#autopilot-metrics">Autopilot metrics for classification and regression</a>.</para></li><li><para>Default objective metrics:</para><ul><li><para>Regression: <c>MSE</c>.</para></li><li><para>Binary classification: <c>F1</c>.</para></li><li><para>Multiclass classification: <c>Accuracy</c>.</para></li></ul></li></ul></li><li><para>For image or text classification problem types:</para><ul><li><para>List of available metrics: <c>Accuracy</c></para><para>For a description of each metric, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/text-classification-data-format-and-metric.html">Autopilot metrics for text and image classification</a>.</para></li><li><para>Default objective metrics: <c>Accuracy</c></para></li></ul></li><li><para>For time-series forecasting problem types:</para><ul><li><para>List of available metrics: <c>RMSE</c>, <c>wQL</c>, <c>Average wQL</c>, <c>MASE</c>, <c>MAPE</c>, <c>WAPE</c></para><para>For a description of each metric, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/timeseries-objective-metric.html">Autopilot metrics for time-series forecasting</a>.</para></li><li><para>Default objective metrics: <c>AverageWeightedQuantileLoss</c></para></li></ul></li><li><para>For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the <c>AutoMLJobObjective</c> field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html">Metrics for fine-tuning LLMs in Autopilot</a>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.AutoMLJobConfig_Mode"> <summary> <para> <para>The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting <c>AUTO</c>. In <c>AUTO</c> mode, Autopilot chooses <c>ENSEMBLING</c> for datasets smaller than 100 MB, and <c>HYPERPARAMETER_TUNING</c> for larger ones.</para><para>The <c>ENSEMBLING</c> mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support">Autopilot algorithm support</a> for a list of algorithms supported by <c>ENSEMBLING</c> mode.</para><para>The <c>HYPERPARAMETER_TUNING</c> (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support">Autopilot algorithm support</a> for a list of algorithms supported by <c>HYPERPARAMETER_TUNING</c> mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.ProblemType"> <summary> <para> <para>Defines the type of supervised learning problem available for the candidates. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types"> SageMaker Autopilot problem types</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that is used to access the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.OutputDataConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 output path. Must be 128 characters or less.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web ServicesResources</a>. Tag keys must be unique per resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.DataSplitConfig_ValidationFraction"> <summary> <para> <para>The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.SecurityConfig_VolumeKmsKeyId"> <summary> <para> <para>The key used to encrypt stored data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoMLJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAutoMLJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAutoMLJobResponse 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.NewSMAutoMLJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobCmdlet.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.NewSMAutoMLJobV2Cmdlet"> <summary> Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2. <note><para><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html">CreateAutoMLJobV2</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a> are new versions of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html">CreateAutoMLJob</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html">DescribeAutoMLJob</a> which offer backward compatibility. </para><para><c>CreateAutoMLJobV2</c> can manage tabular problem types identical to those of its previous version <c>CreateAutoMLJob</c>, as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning). </para><para> Find guidelines about how to migrate a <c>CreateAutoMLJob</c> to <c>CreateAutoMLJobV2</c> in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2">Migrate a CreateAutoMLJob to CreateAutoMLJobV2</a>. </para></note><para> For the list of available problem types supported by <c>CreateAutoMLJobV2</c>, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLProblemTypeConfig.html">AutoMLProblemTypeConfig</a>. </para><para> You can find the best-performing model after you run an AutoML job V2 by calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html">DescribeAutoMLJobV2</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.ModelAccessConfig_AcceptEula"> <summary> <para> <para>Specifies agreement to the model end-user license agreement (EULA). The <c>AcceptEula</c> value must be explicitly defined as <c>True</c> in order to accept the EULA that this model requires. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.Transformations_Aggregation"> <summary> <para> <para>A key value pair defining the aggregation method for a column, where the key is the column name and the value is the aggregation method.</para><para>The supported aggregation methods are <c>sum</c> (default), <c>avg</c>, <c>first</c>, <c>min</c>, <c>max</c>.</para><note><para>Aggregation is only supported for the target column.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.CandidateGenerationConfig_AlgorithmsConfig"> <summary> <para> <para>Stores the configuration information for the selection of algorithms used to train model candidates on tabular data.</para><para>The list of available algorithms to choose from depends on the training mode set in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TabularJobConfig.html"><c>TabularJobConfig.Mode</c></a>.</para><ul><li><para><c>AlgorithmsConfig</c> should not be set in <c>AUTO</c> training mode.</para></li><li><para>When <c>AlgorithmsConfig</c> is provided, one <c>AutoMLAlgorithms</c> attribute must be set and one only.</para><para>If the list of algorithms provided as values for <c>AutoMLAlgorithms</c> is empty, <c>CandidateGenerationConfig</c> uses the full set of algorithms for the given training mode.</para></li><li><para>When <c>AlgorithmsConfig</c> is not provided, <c>CandidateGenerationConfig</c> uses the full set of algorithms for the given training mode.</para></li></ul><para>For the list of all algorithms per problem type and training mode, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html"> AutoMLAlgorithmConfig</a>.</para><para>For more information on each algorithm, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support">Algorithm support</a> section in Autopilot developer guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.ModelDeployConfig_AutoGenerateEndpointName"> <summary> <para> <para>Set to <c>True</c> to automatically generate an endpoint name for a one-click Autopilot model deployment; set to <c>False</c> otherwise. The default value is <c>False</c>.</para><note><para>If you set <c>AutoGenerateEndpointName</c> to <c>True</c>, do not specify the <c>EndpointName</c>; otherwise a 400 error is thrown.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLJobInputDataConfig"> <summary> <para> <para>An array of channel objects describing the input data and their location. Each channel is a named input source. Similar to the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig">InputDataConfig</a> attribute in the <c>CreateAutoMLJob</c> input parameters. The supported formats depend on the problem type:</para><ul><li><para>For tabular problem types: <c>S3Prefix</c>, <c>ManifestFile</c>.</para></li><li><para>For image classification: <c>S3Prefix</c>, <c>ManifestFile</c>, <c>AugmentedManifestFile</c>.</para></li><li><para>For text classification: <c>S3Prefix</c>.</para></li><li><para>For time-series forecasting: <c>S3Prefix</c>.</para></li><li><para>For text generation (LLMs fine-tuning): <c>S3Prefix</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLJobName"> <summary> <para> <para>Identifies an Autopilot job. The name must be unique to your account and is case insensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TextGenerationJobConfig_BaseModelName"> <summary> <para> <para>The name of the base model to fine-tune. Autopilot supports fine-tuning a variety of large language models. For information on the list of supported models, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-models.html#autopilot-llms-finetuning-supported-llms">Text generation models supporting fine-tuning in Autopilot</a>. If no <c>BaseModelName</c> is provided, the default model used is <b>Falcon7BInstruct</b>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TextClassificationJobConfig_ContentColumn"> <summary> <para> <para>The name of the column used to provide the sentences to be classified. It should not be the same as the target column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.SecurityConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to use traffic encryption between the container layers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.ModelDeployConfig_EndpointName"> <summary> <para> <para>Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.</para><note><para>Specify the <c>EndpointName</c> if and only if you set <c>AutoGenerateEndpointName</c> to <c>False</c>; otherwise a 400 error is thrown.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TabularJobConfig_FeatureSpecificationS3Uri"> <summary> <para> <para>A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job V2. You can input <c>FeatureAttributeNames</c> (optional) in JSON format as shown below: </para><para><c>{ "FeatureAttributeNames":["col1", "col2", ...] }</c>.</para><para>You can also specify the data type of the feature (optional) in the format shown below:</para><para><c>{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }</c></para><note><para>These column keys may not include the target column.</para></note><para>In ensembling mode, Autopilot only supports the following data types: <c>numeric</c>, <c>categorical</c>, <c>text</c>, and <c>datetime</c>. In HPO mode, Autopilot can support <c>numeric</c>, <c>categorical</c>, <c>text</c>, <c>datetime</c>, and <c>sequence</c>.</para><para>If only <c>FeatureDataTypes</c> is provided, the column keys (<c>col1</c>, <c>col2</c>,..) should be a subset of the column names in the input data. </para><para>If both <c>FeatureDataTypes</c> and <c>FeatureAttributeNames</c> are provided, then the column keys should be a subset of the column names provided in <c>FeatureAttributeNames</c>. </para><para>The key name <c>FeatureAttributeNames</c> is fixed. The values listed in <c>["col1", "col2", ...]</c> are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesForecastingJobConfig_FeatureSpecificationS3Uri"> <summary> <para> <para>A URL to the Amazon S3 data source containing additional selected features that complement the target, itemID, timestamp, and grouped columns set in <c>TimeSeriesConfig</c>. When not provided, the AutoML job V2 includes all the columns from the original dataset that are not already declared in <c>TimeSeriesConfig</c>. If provided, the AutoML job V2 only considers these additional columns as a complement to the ones declared in <c>TimeSeriesConfig</c>.</para><para>You can input <c>FeatureAttributeNames</c> (optional) in JSON format as shown below: </para><para><c>{ "FeatureAttributeNames":["col1", "col2", ...] }</c>.</para><para>You can also specify the data type of the feature (optional) in the format shown below:</para><para><c>{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }</c></para><para>Autopilot supports the following data types: <c>numeric</c>, <c>categorical</c>, <c>text</c>, and <c>datetime</c>.</para><note><para>These column keys must not include any column set in <c>TimeSeriesConfig</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.Transformations_Filling"> <summary> <para> <para>A key value pair defining the filling method for a column, where the key is the column name and the value is an object which defines the filling logic. You can specify multiple filling methods for a single column.</para><para>The supported filling methods and their corresponding options are:</para><ul><li><para><c>frontfill</c>: <c>none</c> (Supported only for target column)</para></li><li><para><c>middlefill</c>: <c>zero</c>, <c>value</c>, <c>median</c>, <c>mean</c>, <c>min</c>, <c>max</c></para></li><li><para><c>backfill</c>: <c>zero</c>, <c>value</c>, <c>median</c>, <c>mean</c>, <c>min</c>, <c>max</c></para></li><li><para><c>futurefill</c>: <c>zero</c>, <c>value</c>, <c>median</c>, <c>mean</c>, <c>min</c>, <c>max</c></para></li></ul><para>To set a filling method to a specific value, set the fill parameter to the chosen filling method value (for example <c>"backfill" : "value"</c>), and define the filling value in an additional parameter prefixed with "_value". For example, to set <c>backfill</c> to a value of <c>2</c>, you must include two parameters: <c>"backfill": "value"</c> and <c>"backfill_value":"2"</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesForecastingJobConfig_ForecastFrequency"> <summary> <para> <para>The frequency of predictions in a forecast.</para><para>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, <c>1D</c> indicates every day and <c>15min</c> indicates every 15 minutes. The value of a frequency must not overlap with the next larger frequency. For example, you must use a frequency of <c>1H</c> instead of <c>60min</c>.</para><para>The valid values for each frequency are the following:</para><ul><li><para>Minute - 1-59</para></li><li><para>Hour - 1-23</para></li><li><para>Day - 1-6</para></li><li><para>Week - 1-4</para></li><li><para>Month - 1-11</para></li><li><para>Year - 1</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesForecastingJobConfig_ForecastHorizon"> <summary> <para> <para>The number of time-steps that the model predicts. The forecast horizon is also called the prediction length. The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the time-steps in the dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesForecastingJobConfig_ForecastQuantile"> <summary> <para> <para>The quantiles used to train the model for forecasts at a specified quantile. You can specify quantiles from <c>0.01</c> (p1) to <c>0.99</c> (p99), by increments of 0.01 or higher. Up to five forecast quantiles can be specified. When <c>ForecastQuantiles</c> is not provided, the AutoML job uses the quantiles p10, p50, and p90 as default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TabularJobConfig_GenerateCandidateDefinitionsOnly"> <summary> <para> <para>Generates possible candidates without training the models. A model candidate is a combination of data preprocessors, algorithms, and algorithm parameter settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesConfig_GroupingAttributeName"> <summary> <para> <para>A set of columns names that can be grouped with the item identifier column to create a composite key for which a target value is predicted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesForecastingJobConfig_HolidayConfig"> <summary> <para> <para>The collection of holiday featurization attributes used to incorporate national holiday information into your forecasting model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesConfig_ItemIdentifierAttributeName"> <summary> <para> <para>The name of the column that represents the set of item identifiers for which you want to predict the target value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>The Key Management Service encryption key ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_ImageClassificationJobConfig_CompletionCriteria_MaxAutoMLJobRuntimeInSecond"> <summary> <para> <para>The maximum runtime, in seconds, an AutoML job has to complete.</para><para>If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.CompletionCriteria_MaxAutoMLJobRuntimeInSecond"> <summary> <para> <para>The maximum runtime, in seconds, an AutoML job has to complete.</para><para>If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TextClassificationJobConfig_CompletionCriteria_MaxAutoMLJobRuntimeInSecond"> <summary> <para> <para>The maximum runtime, in seconds, an AutoML job has to complete.</para><para>If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TextGenerationJobConfig_CompletionCriteria_MaxAutoMLJobRuntimeInSecond"> <summary> <para> <para>The maximum runtime, in seconds, an AutoML job has to complete.</para><para>If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TimeSeriesForecastingJobConfig_CompletionCriteria_MaxAutoMLJobRuntimeInSecond"> <summary> <para> <para>The maximum runtime, in seconds, an AutoML job has to complete.</para><para>If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_ImageClassificationJobConfig_CompletionCriteria_MaxCandidate"> <summary> <para> <para>The maximum number of times a training job is allowed to run.</para><para>For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.CompletionCriteria_MaxCandidate"> <summary> <para> <para>The maximum number of times a training job is allowed to run.</para><para>For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TextClassificationJobConfig_CompletionCriteria_MaxCandidate"> <summary> <para> <para>The maximum number of times a training job is allowed to run.</para><para>For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TextGenerationJobConfig_CompletionCriteria_MaxCandidate"> <summary> <para> <para>The maximum number of times a training job is allowed to run.</para><para>For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TimeSeriesForecastingJobConfig_CompletionCriteria_MaxCandidate"> <summary> <para> <para>The maximum number of times a training job is allowed to run.</para><para>For text and image classification, time-series forecasting, as well as text generation (LLMs fine-tuning) problem types, the supported value is 1. For tabular problem types, the maximum value is 750.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_ImageClassificationJobConfig_CompletionCriteria_MaxRuntimePerTrainingJobInSecond"> <summary> <para> <para>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html">StoppingCondition</a> used by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> action.</para><para>For job V2s (jobs created by calling <c>CreateAutoMLJobV2</c>), this field controls the runtime of the job candidate.</para><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html">TextGenerationJobConfig</a> problem types, the maximum time defaults to 72 hours (259200 seconds).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.CompletionCriteria_MaxRuntimePerTrainingJobInSecond"> <summary> <para> <para>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html">StoppingCondition</a> used by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> action.</para><para>For job V2s (jobs created by calling <c>CreateAutoMLJobV2</c>), this field controls the runtime of the job candidate.</para><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html">TextGenerationJobConfig</a> problem types, the maximum time defaults to 72 hours (259200 seconds).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TextClassificationJobConfig_CompletionCriteria_MaxRuntimePerTrainingJobInSecond"> <summary> <para> <para>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html">StoppingCondition</a> used by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> action.</para><para>For job V2s (jobs created by calling <c>CreateAutoMLJobV2</c>), this field controls the runtime of the job candidate.</para><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html">TextGenerationJobConfig</a> problem types, the maximum time defaults to 72 hours (259200 seconds).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TextGenerationJobConfig_CompletionCriteria_MaxRuntimePerTrainingJobInSecond"> <summary> <para> <para>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html">StoppingCondition</a> used by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> action.</para><para>For job V2s (jobs created by calling <c>CreateAutoMLJobV2</c>), this field controls the runtime of the job candidate.</para><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html">TextGenerationJobConfig</a> problem types, the maximum time defaults to 72 hours (259200 seconds).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLProblemTypeConfig_TimeSeriesForecastingJobConfig_CompletionCriteria_MaxRuntimePerTrainingJobInSecond"> <summary> <para> <para>The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StoppingCondition.html">StoppingCondition</a> used by the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html">CreateHyperParameterTuningJob</a> action.</para><para>For job V2s (jobs created by calling <c>CreateAutoMLJobV2</c>), this field controls the runtime of the job candidate.</para><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TextClassificationJobConfig.html">TextGenerationJobConfig</a> problem types, the maximum time defaults to 72 hours (259200 seconds).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.AutoMLJobObjective_MetricName"> <summary> <para> <para>The name of the objective metric used to measure the predictive quality of a machine learning system. During training, the model's parameters are updated iteratively to optimize its performance based on the feedback provided by the objective metric when evaluating the model on the validation dataset.</para><para>The list of available metrics supported by Autopilot and the default metric applied when you do not specify a metric name explicitly depend on the problem type.</para><ul><li><para>For tabular problem types:</para><ul><li><para>List of available metrics: </para><ul><li><para> Regression: <c>MAE</c>, <c>MSE</c>, <c>R2</c>, <c>RMSE</c></para></li><li><para> Binary classification: <c>Accuracy</c>, <c>AUC</c>, <c>BalancedAccuracy</c>, <c>F1</c>, <c>Precision</c>, <c>Recall</c></para></li><li><para> Multiclass classification: <c>Accuracy</c>, <c>BalancedAccuracy</c>, <c>F1macro</c>, <c>PrecisionMacro</c>, <c>RecallMacro</c></para></li></ul><para>For a description of each metric, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html#autopilot-metrics">Autopilot metrics for classification and regression</a>.</para></li><li><para>Default objective metrics:</para><ul><li><para>Regression: <c>MSE</c>.</para></li><li><para>Binary classification: <c>F1</c>.</para></li><li><para>Multiclass classification: <c>Accuracy</c>.</para></li></ul></li></ul></li><li><para>For image or text classification problem types:</para><ul><li><para>List of available metrics: <c>Accuracy</c></para><para>For a description of each metric, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/text-classification-data-format-and-metric.html">Autopilot metrics for text and image classification</a>.</para></li><li><para>Default objective metrics: <c>Accuracy</c></para></li></ul></li><li><para>For time-series forecasting problem types:</para><ul><li><para>List of available metrics: <c>RMSE</c>, <c>wQL</c>, <c>Average wQL</c>, <c>MASE</c>, <c>MAPE</c>, <c>WAPE</c></para><para>For a description of each metric, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/timeseries-objective-metric.html">Autopilot metrics for time-series forecasting</a>.</para></li><li><para>Default objective metrics: <c>AverageWeightedQuantileLoss</c></para></li></ul></li><li><para>For text generation problem types (LLMs fine-tuning): Fine-tuning language models in Autopilot does not require setting the <c>AutoMLJobObjective</c> field. Autopilot fine-tunes LLMs without requiring multiple candidates to be trained and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your target model to enhance a default objective metric, the cross-entropy loss. After fine-tuning a language model, you can evaluate the quality of its generated text using different metrics. For a list of the available metrics, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html">Metrics for fine-tuning LLMs in Autopilot</a>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TabularJobConfig_Mode"> <summary> <para> <para>The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting <c>AUTO</c>. In <c>AUTO</c> mode, Autopilot chooses <c>ENSEMBLING</c> for datasets smaller than 100 MB, and <c>HYPERPARAMETER_TUNING</c> for larger ones.</para><para>The <c>ENSEMBLING</c> mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support">Autopilot algorithm support</a> for a list of algorithms supported by <c>ENSEMBLING</c> mode.</para><para>The <c>HYPERPARAMETER_TUNING</c> (HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-model-support-validation.html#autopilot-algorithm-support">Autopilot algorithm support</a> for a list of algorithms supported by <c>HYPERPARAMETER_TUNING</c> mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TabularJobConfig_ProblemType"> <summary> <para> <para>The type of supervised learning problem available for the model candidates of the AutoML job V2. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types"> SageMaker Autopilot problem types</a>.</para><note><para>You must either specify the type of supervised learning problem in <c>ProblemType</c> and provide the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html#sagemaker-CreateAutoMLJobV2-request-AutoMLJobObjective">AutoMLJobObjective</a> metric, or none at all.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.RoleArn"> <summary> <para> <para>The ARN of the role that is used to access the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.OutputDataConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 output path. Must be 128 characters or less.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TabularJobConfig_SampleWeightAttributeName"> <summary> <para> <para>If specified, this column name indicates which column of the dataset should be treated as sample weights for use by the objective metric during the training, evaluation, and the selection of the best model. This column is not considered as a predictive feature. For more information on Autopilot metrics, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html">Metrics and validation</a>.</para><para>Sample weights should be numeric, non-negative, with larger values indicating which rows are more important than others. Data points that have invalid or no weight value are excluded.</para><para>Support for sample weights is available in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLAlgorithmConfig.html">Ensembling</a> mode only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, such as by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web ServicesResources</a>. Tag keys must be unique per resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TabularJobConfig_TargetAttributeName"> <summary> <para> <para>The name of the target variable in supervised learning, usually represented by 'y'.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesConfig_TargetAttributeName"> <summary> <para> <para>The name of the column representing the target variable that you want to predict for each item in your dataset. The data type of the target variable must be numerical.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TextClassificationJobConfig_TargetLabelColumn"> <summary> <para> <para>The name of the column used to provide the class labels. It should not be same as the content column.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TextGenerationJobConfig_TextGenerationHyperParameter"> <summary> <para> <para>The hyperparameters used to configure and optimize the learning process of the base model. You can set any combination of the following hyperparameters for all base models. For more information on each supported hyperparameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-set-hyperparameters.html">Optimize the learning process of your text generation models with hyperparameters</a>.</para><ul><li><para><c>"epochCount"</c>: The number of times the model goes through the entire training dataset. Its value should be a string containing an integer value within the range of "1" to "10".</para></li><li><para><c>"batchSize"</c>: The number of data samples used in each iteration of training. Its value should be a string containing an integer value within the range of "1" to "64".</para></li><li><para><c>"learningRate"</c>: The step size at which a model's parameters are updated during training. Its value should be a string containing a floating-point value within the range of "0" to "1".</para></li><li><para><c>"learningRateWarmupSteps"</c>: The number of training steps during which the learning rate gradually increases before reaching its target or maximum value. Its value should be a string containing an integer value within the range of "0" to "250".</para></li></ul><para>Here is an example where all four hyperparameters are configured.</para><para><c>{ "epochCount":"5", "learningRate":"0.5", "batchSize": "32", "learningRateWarmupSteps": "10" }</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.TimeSeriesConfig_TimestampAttributeName"> <summary> <para> <para>The name of the column indicating a point in time at which the target value of a given item is recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.DataSplitConfig_ValidationFraction"> <summary> <para> <para>The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.SecurityConfig_VolumeKmsKeyId"> <summary> <para> <para>The key used to encrypt stored data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutoMLJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAutoMLJobV2Response). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAutoMLJobV2Response 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.NewSMAutoMLJobV2Cmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMAutoMLJobV2Cmdlet.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.NewSMClusterCmdlet"> <summary> Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html">Amazon SageMaker HyperPod</a> in the <i>Amazon SageMaker Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.ClusterName"> <summary> <para> <para>The name for the new SageMaker HyperPod cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.InstanceGroup"> <summary> <para> <para>The instance groups to be created in the SageMaker HyperPod cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.Tag"> <summary> <para> <para>Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html">Tagging Amazon Web Services Resources User Guide</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateClusterResponse 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.NewSMClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMClusterCmdlet.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 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 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">Amazon Web Services 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 Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of <c>AWSCURRENT</c> and must be in the following format:</para><para><c>{"username": <i>UserName</i>, "password": <i>Password</i>}</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCodeRepositoryCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</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 Amazon Web Services 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> The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job. </para></li></ul><para> You can also provide a <c>Tag</c> to track the model compilation job's resource use and costs. The response body contains the <c>CompilationJobArn</c> for the compiled job. </para><para> To stop a model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html">StopCompilationJob</a>. To get information about a particular model compilation job, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html">DescribeCompilationJob</a>. To get information about multiple model compilation jobs, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html">ListCompilationJobs</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.TargetPlatform_Accelerator"> <summary> <para> <para>Specifies a target platform accelerator (optional).</para><ul><li><para><c>NVIDIA</c>: Nvidia graphics processing unit. It also requires <c>gpu-code</c>, <c>trt-ver</c>, <c>cuda-ver</c> compiler options</para></li><li><para><c>MALI</c>: ARM Mali graphics processor</para></li><li><para><c>INTEL_GRAPHICS</c>: Integrated Intel graphics</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.TargetPlatform_Arch"> <summary> <para> <para>Specifies a target platform architecture.</para><ul><li><para><c>X86_64</c>: 64-bit version of the x86 instruction set.</para></li><li><para><c>X86</c>: 32-bit version of the x86 instruction set.</para></li><li><para><c>ARM64</c>: ARMv8 64-bit CPU.</para></li><li><para><c>ARM_EABIHF</c>: ARMv7 32-bit, Hard Float.</para></li><li><para><c>ARM_EABI</c>: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.</para></li></ul> </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 Amazon Web Services Region and within your Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.OutputConfig_CompilerOption"> <summary> <para> <para>Specifies additional parameters for compiler options in JSON format. The compiler options are <c>TargetPlatform</c> specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify <c>CompilerOptions.</c></para><ul><li><para><c>DTYPE</c>: Specifies the data type for the input. When compiling for <c>ml_*</c> (except for <c>ml_inf</c>) instances using PyTorch framework, provide the data type (dtype) of the model's input. <c>"float32"</c> is used if <c>"DTYPE"</c> is not specified. Options for data type are:</para><ul><li><para>float32: Use either <c>"float"</c> or <c>"float32"</c>.</para></li><li><para>int64: Use either <c>"int64"</c> or <c>"long"</c>.</para></li></ul><para> For example, <c>{"dtype" : "float32"}</c>.</para></li><li><para><c>CPU</c>: Compilation for CPU supports the following compiler options.</para><ul><li><para><c>mcpu</c>: CPU micro-architecture. For example, <c>{'mcpu': 'skylake-avx512'}</c></para></li><li><para><c>mattr</c>: CPU flags. For example, <c>{'mattr': ['+neon', '+vfpv4']}</c></para></li></ul></li><li><para><c>ARM</c>: Details of ARM CPU compilations.</para><ul><li><para><c>NEON</c>: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.</para><para>For example, add <c>{'mattr': ['+neon']}</c> to the compiler options if compiling for ARM 32-bit platform with the NEON support.</para></li></ul></li><li><para><c>NVIDIA</c>: Compilation for NVIDIA GPU supports the following compiler options.</para><ul><li><para><c>gpu_code</c>: Specifies the targeted architecture.</para></li><li><para><c>trt-ver</c>: Specifies the TensorRT versions in x.y.z. format.</para></li><li><para><c>cuda-ver</c>: Specifies the CUDA version in x.y format.</para></li></ul><para>For example, <c>{'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}</c></para></li><li><para><c>ANDROID</c>: Compilation for the Android OS supports the following compiler options:</para><ul><li><para><c>ANDROID_PLATFORM</c>: Specifies the Android API levels. Available levels range from 21 to 29. For example, <c>{'ANDROID_PLATFORM': 28}</c>.</para></li><li><para><c>mattr</c>: Add <c>{'mattr': ['+neon']}</c> to compiler options if compiling for ARM 32-bit platform with NEON support.</para></li></ul></li><li><para><c>INFERENTIA</c>: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, <c>"CompilerOptions": "\"--verbose 1 --num-neuroncores 2 -O2\""</c>. </para><para>For information about supported compiler options, see <a href="https://awsdocs-neuron.readthedocs-hosted.com/en/latest/compiler/neuronx-cc/api-reference-guide/neuron-compiler-cli-reference-guide.html"> Neuron Compiler CLI Reference Guide</a>. </para></li><li><para><c>CoreML</c>: Compilation for the CoreML <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html">OutputConfig</a><c>TargetDevice</c> supports the following compiler options:</para><ul><li><para><c>class_labels</c>: Specifies the classification labels file name inside input tar.gz file. For example, <c>{"class_labels": "imagenet_labels_1000.txt"}</c>. Labels inside the txt file should be separated by newlines.</para></li></ul></li><li><para><c>EIA</c>: Compilation for the Elastic Inference Accelerator supports the following compiler options:</para><ul><li><para><c>precision_mode</c>: Specifies the precision of compiled artifacts. Supported values are <c>"FP16"</c> and <c>"FP32"</c>. Default is <c>"FP32"</c>.</para></li><li><para><c>signature_def_key</c>: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow's default signature def key.</para></li><li><para><c>output_names</c>: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: <c>signature_def_key</c> or <c>output_names</c>.</para></li></ul><para>For example: <c>{"precision_mode": "FP32", "output_names": ["output:0"]}</c></para></li></ul> </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 <c>Framework</c> specific. </para><ul><li><para><c>TensorFlow</c>: 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, <c>{"input":[1,1024,1024,3]}</c></para></li><li><para>If using the CLI, <c>{\"input\":[1,1024,1024,3]}</c></para></li></ul></li><li><para>Examples for two inputs:</para><ul><li><para>If using the console, <c>{"data1": [1,28,28,1], "data2":[1,28,28,1]}</c></para></li><li><para>If using the CLI, <c>{\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}</c></para></li></ul></li></ul></li><li><para><c>KERAS</c>: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, <c>DataInputConfig</c> should be specified in NCHW (channel-first) format. 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, <c>{"input_1":[1,3,224,224]}</c></para></li><li><para>If using the CLI, <c>{\"input_1\":[1,3,224,224]}</c></para></li></ul></li><li><para>Examples for two inputs:</para><ul><li><para>If using the console, <c>{"input_1": [1,3,224,224], "input_2":[1,3,224,224]} </c></para></li><li><para>If using the CLI, <c>{\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}</c></para></li></ul></li></ul></li><li><para><c>MXNET/ONNX/DARKNET</c>: 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, <c>{"data":[1,3,1024,1024]}</c></para></li><li><para>If using the CLI, <c>{\"data\":[1,3,1024,1024]}</c></para></li></ul></li><li><para>Examples for two inputs:</para><ul><li><para>If using the console, <c>{"var1": [1,1,28,28], "var2":[1,1,28,28]} </c></para></li><li><para>If using the CLI, <c>{\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}</c></para></li></ul></li></ul></li><li><para><c>PyTorch</c>: 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, <c>{"input0":[1,3,224,224]}</c></para></li><li><para>If using the CLI, <c>{\"input0\":[1,3,224,224]}</c></para></li></ul></li><li><para>Example for one input in list format: <c>[[1,3,224,224]]</c></para></li><li><para>Examples for two inputs in dictionary format:</para><ul><li><para>If using the console, <c>{"input0":[1,3,224,224], "input1":[1,3,224,224]}</c></para></li><li><para>If using the CLI, <c>{\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]} </c></para></li></ul></li><li><para>Example for two inputs in list format: <c>[[1,3,224,224], [1,3,224,224]]</c></para></li></ul></li><li><para><c>XGBOOST</c>: input data name and shape are not needed.</para></li></ul><para><c>DataInputConfig</c> supports the following parameters for <c>CoreML</c><c>TargetDevice</c> (ML Model format):</para><ul><li><para><c>shape</c>: Input shape, for example <c>{"input_1": {"shape": [1,224,224,3]}}</c>. In addition to static input shapes, CoreML converter supports Flexible input shapes:</para><ul><li><para>Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: <c>{"input_1": {"shape": ["1..10", 224, 224, 3]}}</c></para></li><li><para>Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: <c>{"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}</c></para></li></ul></li><li><para><c>default_shape</c>: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example <c>{"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}</c></para></li><li><para><c>type</c>: Input type. Allowed values: <c>Image</c> and <c>Tensor</c>. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as <c>bias</c> and <c>scale</c>.</para></li><li><para><c>bias</c>: If the input type is an Image, you need to provide the bias vector.</para></li><li><para><c>scale</c>: If the input type is an Image, you need to provide a scale factor.</para></li></ul><para>CoreML <c>ClassifierConfig</c> parameters can be specified using <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html">OutputConfig</a><c>CompilerOptions</c>. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:</para><ul><li><para>Tensor type input:</para><ul><li><para><c>"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}</c></para></li></ul></li><li><para>Tensor type input without input name (PyTorch):</para><ul><li><para><c>"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]</c></para></li></ul></li><li><para>Image type input:</para><ul><li><para><c>"DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}</c></para></li><li><para><c>"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}</c></para></li></ul></li><li><para>Image type input without input name (PyTorch):</para><ul><li><para><c>"DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]</c></para></li><li><para><c>"CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}</c></para></li></ul></li></ul><para>Depending on the model format, <c>DataInputConfig</c> requires the following parameters for <c>ml_eia2</c><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-TargetDevice">OutputConfig:TargetDevice</a>.</para><ul><li><para>For TensorFlow models saved in the SavedModel format, specify the input names from <c>signature_def_key</c> and the input model shapes for <c>DataInputConfig</c>. Specify the <c>signature_def_key</c> in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions"><c>OutputConfig:CompilerOptions</c></a> if the model does not use TensorFlow's default signature def key. For example:</para><ul><li><para><c>"DataInputConfig": {"inputs": [1, 224, 224, 3]}</c></para></li><li><para><c>"CompilerOptions": {"signature_def_key": "serving_custom"}</c></para></li></ul></li><li><para>For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in <c>DataInputConfig</c> and the output tensor names for <c>output_names</c> in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OutputConfig.html#sagemaker-Type-OutputConfig-CompilerOptions"><c>OutputConfig:CompilerOptions</c></a>. For example:</para><ul><li><para><c>"DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]}</c></para></li><li><para><c>"CompilerOptions": {"output_names": ["output_tensor:0"]}</c></para></li></ul></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.InputConfig_FrameworkVersion"> <summary> <para> <para>Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.</para><para>For information about framework versions supported for cloud targets and edge devices, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html">Cloud Supported Instance Types and Frameworks</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-devices-edge-frameworks.html">Edge Supported Frameworks</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. 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/userguide/UsingKMSEncryption.html">KMS-Managed Encryption Keys</a> in the <i>Amazon Simple Storage Service Developer Guide.</i></para><para>The KmsKeyId can be any of the following formats: </para><ul><li><para>Key ID: <c>1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Key ARN: <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Alias name: <c>alias/ExampleAlias</c></para></li><li><para>Alias name ARN: <c>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.StoppingCondition_MaxPendingTimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.</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 a training or compilation job can run before it is stopped.</para><para>For compilation jobs, if the job does not complete during this time, a <c>TimeOut</c> error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.</para><para>For all other jobs, if the job does not complete during this time, SageMaker ends the job. When <c>RetryStrategy</c> is specified in the job request, <c>MaxRuntimeInSeconds</c> specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.</para><para>The maximum time that a <c>TrainingJob</c> can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 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, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than <c>MaxRuntimeInSeconds</c>. If the job does not complete during this time, SageMaker ends the job.</para><para>When <c>RetryStrategy</c> is specified in the job request, <c>MaxWaitTimeInSeconds</c> specifies the maximum time for all of the attempts in total, not each individual attempt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.ModelPackageVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a versioned model package. Provide either a <c>ModelPackageVersionArn</c> or an <c>InputConfig</c> object in the request syntax. The presence of both objects in the <c>CreateCompilationJob</c> request will return an exception.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.TargetPlatform_Os"> <summary> <para> <para>Specifies a target platform OS.</para><ul><li><para><c>LINUX</c>: Linux-based operating systems.</para></li><li><para><c>ANDROID</c>: Android operating systems. Android API level can be specified using the <c>ANDROID_PLATFORM</c> compiler option. For example, <c>"CompilerOptions": {'ANDROID_PLATFORM': 28}</c></para></li></ul> </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 <c>iam:PassRole</c> 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 bucket where you want Amazon SageMaker to store the model artifacts. For example, <c>s3://bucket-name/key-name-prefix</c>.</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.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs. IDs have the form of <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMCompilationJobCmdlet.OutputConfig_TargetDevice"> <summary> <para> <para>Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TargetPlatform.html">TargetPlatform</a> fields. It can be used instead of <c>TargetPlatform</c>.</para><note><para>Currently <c>ml_trn1</c> is available only in US East (N. Virginia) Region, and <c>ml_inf2</c> is available only in US East (Ohio) Region.</para></note> </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.NewSMContextCmdlet"> <summary> Creates a <i>context</i>. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html">Amazon SageMaker ML Lineage Tracking</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.ContextName"> <summary> <para> <para>The name of the context. Must be unique to your account in an Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.ContextType"> <summary> <para> <para>The context type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Description"> <summary> <para> <para>The description of the context.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Property"> <summary> <para> <para>A list of properties to add to the context.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Source_SourceId"> <summary> <para> <para>The ID of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Source_SourceType"> <summary> <para> <para>The type of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Source_SourceUri"> <summary> <para> <para>The URI of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the context.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContextArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateContextResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateContextResponse 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.NewSMContextCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContextName parameter. The -PassThru parameter is deprecated, use -Select '^ContextName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMContextCmdlet.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.NewSMDataQualityJobDefinitionCmdlet"> <summary> Creates a definition for a job that monitors data quality and drift. For information about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityBaselineConfig_BaseliningJobName"> <summary> <para> <para>The name of the job that performs baselining for the data quality monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityAppSpecification_ContainerArgument"> <summary> <para> <para>The arguments to send to the container that the monitoring job runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityAppSpecification_ContainerEntrypoint"> <summary> <para> <para>The entrypoint for a container used to run a monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_DataCapturedDestinationS3Uri"> <summary> <para> <para>The Amazon S3 location being used to capture the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.NetworkConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to encrypt all communications between the instances used for the monitoring jobs. Choose <c>True</c> to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.NetworkConfig_EnableNetworkIsolation"> <summary> <para> <para>Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_EndpointName"> <summary> <para> <para>An endpoint in customer's account which has enabled <c>DataCaptureConfig</c> enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityAppSpecification_Environment"> <summary> <para> <para>Sets the environment variables in the container that the monitoring job runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.Csv_Header"> <summary> <para> <para>Indicates if the CSV data has a header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityAppSpecification_ImageUri"> <summary> <para> <para>The container image that the data quality monitoring job runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The ML compute instance type for the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name for the monitoring job definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityJobOutputConfig_KmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.Json_Line"> <summary> <para> <para>Indicates if the file should be read as a JSON object per line. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the batch transform data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the endpoint data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum runtime allowed in seconds.</para><note><para>The <c>MaxRuntimeInSeconds</c> cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityJobOutputConfig_MonitoringOutput"> <summary> <para> <para>Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DatasetFormat_Parquet"> <summary> <para> <para>The Parquet dataset used in the monitoring job</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityAppSpecification_PostAnalyticsProcessorSourceUri"> <summary> <para> <para>An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.DataQualityAppSpecification_RecordPreprocessorSourceUri"> <summary> <para> <para>An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.ConstraintsResource_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the constraints resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.StatisticsResource_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the statistics resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.BatchTransformInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.EndpointInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.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-whatURL"> Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.ClusterConfig_VolumeKmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.ClusterConfig_VolumeSizeInGB"> <summary> <para> <para>The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateDataQualityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateDataQualityJobDefinitionResponse 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.NewSMDataQualityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDataQualityJobDefinitionCmdlet.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.NewSMDeviceFleetCmdlet"> <summary> Creates a device fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.Description"> <summary> <para> <para>A description of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet that the device belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.EnableIotRoleAlias"> <summary> <para> <para>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".</para><para>For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.OutputConfig_PresetDeploymentConfig"> <summary> <para> <para>The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:</para><ul><li><para><c>ComponentName</c> (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.</para></li><li><para><c>ComponentDescription</c> (optional) - Description of the component.</para></li><li><para><c>ComponentVersion</c> (optional) - The version of the component.</para><note><para>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> major.minor.patch</i> number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</para></note></li><li><para><c>PlatformOS</c> (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.</para></li><li><para><c>PlatformArchitecture</c> (optional) - The processor architecture for the platform. </para><para>Supported architectures Windows include: Windows32_x86, Windows64_x64.</para><para>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.OutputConfig_PresetDeploymentType"> <summary> <para> <para>The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet of Things (IoT).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.OutputConfig_S3OutputLocation"> <summary> <para> <para>The Amazon Simple Storage (S3) bucker URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.Tag"> <summary> <para> <para>Creates tags for the specified fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.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.CreateDeviceFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDeviceFleetCmdlet.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.NewSMDomainCmdlet"> <summary> Creates a <c>Domain</c>. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other. <para><b>EFS storage</b></para><para> When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. </para><para> SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html">Protect Data at Rest Using Encryption</a>. </para><para><b>VPC configuration</b></para><para> All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the <c>AppNetworkAccessType</c> parameter. <c>AppNetworkAccessType</c> corresponds to the network access type that you choose when you onboard to the domain. The following options are available: </para><ul><li><para><c>PublicInternetOnly</c> - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value. </para></li><li><para><c>VpcOnly</c> - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. </para><para> When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections. </para></li></ul><important><para> NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully. </para></important><para> For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html">Connect Amazon SageMaker Studio Notebooks to Resources in a VPC</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.AppNetworkAccessType"> <summary> <para> <para>Specifies the VPC used for non-EFS traffic. The default value is <c>PublicInternetOnly</c>.</para><ul><li><para><c>PublicInternetOnly</c> - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access</para></li><li><para><c>VpcOnly</c> - All traffic is through the specified VPC and subnets</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.AppSecurityGroupManagement"> <summary> <para> <para>The entity that creates and manages the required security groups for inter-app communication in <c>VPCOnly</c> mode. Required when <c>CreateDomain.AppNetworkAccessType</c> is <c>VPCOnly</c> and <c>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</c> is provided. If setting up the domain for use with RStudio, this value must be set to <c>Service</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.AuthMode"> <summary> <para> <para>The mode of authentication that members use to access the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.JupyterLabAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.JupyterServerAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_CustomFileSystemConfig"> <summary> <para> <para>The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.JupyterLabAppSettings_CustomImage"> <summary> <para> <para>A list of custom SageMaker images that are configured to run as a JupyterLab app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.KernelGatewayAppSettings_CustomImage"> <summary> <para> <para>A list of custom SageMaker images that are configured to run as a KernelGateway app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultEbsStorageSettings_DefaultEbsVolumeSizeInGb"> <summary> <para> <para>The default size of the EBS storage volume for a space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultUserSetting"> <summary> <para> <para>The default settings to use to create a user profile when <c>UserSettings</c> isn't specified in the call to the <c>CreateUserProfile</c> API.</para><para><c>SecurityGroups</c> is aggregated when specified in both calls. For all other settings in <c>UserSettings</c>, the values specified in <c>CreateUserProfile</c> take precedence over those specified in <c>CreateDomain</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.RStudioServerProDomainSettings_DomainExecutionRoleArn"> <summary> <para> <para>The ARN of the execution role for the <c>RStudioServerPro</c> Domain-level app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DomainName"> <summary> <para> <para>A name for the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DockerSettings_EnableDockerAccess"> <summary> <para> <para>Indicates whether the domain can access Docker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_ExecutionRole"> <summary> <para> <para>The ARN of the execution role for the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DomainSettings_ExecutionRoleIdentityConfig"> <summary> <para> <para>The configuration for attaching a SageMaker user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.CustomPosixUserConfig_Gid"> <summary> <para> <para>The POSIX group ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.KmsKeyId"> <summary> <para> <para>SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.JupyterLabAppSettings_LifecycleConfigArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set <c>LifecycleConfigArns</c> to an empty list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.JupyterServerAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the <c>DefaultResourceSpec</c> parameter is also required.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.KernelGatewayAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultEbsStorageSettings_MaximumEbsVolumeSizeInGb"> <summary> <para> <para>The maximum size of the EBS storage volume for a space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.RStudioServerProDomainSettings_RStudioConnectUrl"> <summary> <para> <para>A URL pointing to an RStudio Connect server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.RStudioServerProDomainSettings_RStudioPackageManagerUrl"> <summary> <para> <para>A URL pointing to an RStudio Package Manager server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DomainSettings_RStudioServerProDomainSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DomainSettings_SecurityGroupId"> <summary> <para> <para>The security groups for the Amazon Virtual Private Cloud that the <c>Domain</c> uses for communication between Domain-level apps and user apps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DefaultSpaceSettings_SecurityGroup"> <summary> <para> <para>The security group IDs for the Amazon VPC that the space uses for communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.SubnetId"> <summary> <para> <para>The VPC subnets that the domain uses for communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.Tag"> <summary> <para> <para>Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the <c>Search</c> API.</para><para>Tags that you specify for the Domain are also added to all Apps that the Domain launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.CustomPosixUserConfig_Uid"> <summary> <para> <para>The POSIX user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.VpcId"> <summary> <para> <para>The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.DockerSettings_VpcOnlyTrustedAccount"> <summary> <para> <para>The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.HomeEfsFileSystemKmsKeyId"> <summary> <para> <para>Use <c>KmsKeyId</c>.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.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.CreateDomainResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateDomainResponse 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.NewSMDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMDomainCmdlet.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.NewSMEdgeDeploymentPlanCmdlet"> <summary> Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentPlanCmdlet.DeviceFleetName"> <summary> <para> <para>The device fleet used for this edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentPlanCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentPlanCmdlet.ModelConfig"> <summary> <para> <para>List of models associated with the edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentPlanCmdlet.Stage"> <summary> <para> <para>List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentPlanCmdlet.Tag"> <summary> <para> <para>List of tags with which to tag the edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EdgeDeploymentPlanArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateEdgeDeploymentPlanResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateEdgeDeploymentPlanResponse 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.NewSMEdgeDeploymentPlanCmdlet.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.NewSMEdgeDeploymentStageCmdlet"> <summary> Creates a new stage in an existing edge deployment plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentStageCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentStageCmdlet.Stage"> <summary> <para> <para>List of stages to be added to the edge deployment plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentStageCmdlet.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.CreateEdgeDeploymentStageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentStageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EdgeDeploymentPlanName parameter. The -PassThru parameter is deprecated, use -Select '^EdgeDeploymentPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgeDeploymentStageCmdlet.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.NewSMEdgePackagingJobCmdlet"> <summary> Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.CompilationJobName"> <summary> <para> <para>The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.EdgePackagingJobName"> <summary> <para> <para>The name of the edge packaging job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.ModelName"> <summary> <para> <para>The name of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.ModelVersion"> <summary> <para> <para>The version of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.OutputConfig_PresetDeploymentConfig"> <summary> <para> <para>The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:</para><ul><li><para><c>ComponentName</c> (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.</para></li><li><para><c>ComponentDescription</c> (optional) - Description of the component.</para></li><li><para><c>ComponentVersion</c> (optional) - The version of the component.</para><note><para>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> major.minor.patch</i> number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</para></note></li><li><para><c>PlatformOS</c> (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.</para></li><li><para><c>PlatformArchitecture</c> (optional) - The processor architecture for the platform. </para><para>Supported architectures Windows include: Windows32_x86, Windows64_x64.</para><para>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.OutputConfig_PresetDeploymentType"> <summary> <para> <para>The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.ResourceKey"> <summary> <para> <para>The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.OutputConfig_S3OutputLocation"> <summary> <para> <para>The Amazon Simple Storage (S3) bucker URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.Tag"> <summary> <para> <para>Creates tags for the packaging job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.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.CreateEdgePackagingJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EdgePackagingJobName parameter. The -PassThru parameter is deprecated, use -Select '^EdgePackagingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEdgePackagingJobCmdlet.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. 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/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> API. <para> Use this API to deploy models using SageMaker hosting services. </para><note><para> You must not delete an <c>EndpointConfig</c> that is in use by an endpoint that is live or while the <c>UpdateEndpoint</c> or <c>CreateEndpoint</c> operations are being performed on the endpoint. To update an endpoint, you must create a new <c>EndpointConfig</c>. </para></note><para> The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. </para><para> When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. </para><note><para> When you call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a>, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html"><c>Eventually Consistent Reads</c></a>, the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html">DescribeEndpointConfig</a> before calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> to minimize the potential impact of a DynamoDB eventually consistent read. </para></note><para> When SageMaker receives the request, it sets the endpoint status to <c>Creating</c>. After it creates the endpoint, it sets the status to <c>InService</c>. 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/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> API. </para><para> If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>. </para><note><para> To add the IAM role policies for using this API operation, go to the <a href="https://console.aws.amazon.com/iam/">IAM console</a>, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html">CreateEndpointConfig</a> API operations, add the following policies to the role. </para><ul><li><para> Option 1: For a full SageMaker access, search and attach the <c>AmazonSageMakerFullAccess</c> policy. </para></li><li><para> Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: </para><para><c>"Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]</c></para><para><c>"Resource": [</c></para><para><c>"arn:aws:sagemaker:region:account-id:endpoint/endpointName"</c></para><para><c>"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"</c></para><para><c>]</c></para><para> For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html">SageMaker API Permissions: Actions, Permissions, and Resources Reference</a>. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.AutoRollbackConfiguration_Alarm"> <summary> <para> <para>List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.</para> </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/APIReference/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 Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in <c>CreateEndpoint</c>, but the case is preserved and must be matched in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html">InvokeEndpoint</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.BlueGreenUpdatePolicy_MaximumExecutionTimeoutInSecond"> <summary> <para> <para>Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in <c>TerminationWaitInSeconds</c> and <c>WaitIntervalInSeconds</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.RollingUpdatePolicy_MaximumExecutionTimeoutInSecond"> <summary> <para> <para>The time limit for the total deployment. Exceeding this limit causes a timeout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.BlueGreenUpdatePolicy_TerminationWaitInSecond"> <summary> <para> <para>Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.CanarySize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.LinearStepSize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.TrafficRoutingConfiguration_Type"> <summary> <para> <para>Traffic routing strategy type.</para><ul><li><para><c>ALL_AT_ONCE</c>: Endpoint traffic shifts to the new fleet in a single step. </para></li><li><para><c>CANARY</c>: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic. </para></li><li><para><c>LINEAR</c>: Endpoint traffic shifts to the new fleet in n steps of a configurable size. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.MaximumBatchSize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.RollbackMaximumBatchSize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.CanarySize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.LinearStepSize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.MaximumBatchSize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.RollbackMaximumBatchSize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.TrafficRoutingConfiguration_WaitIntervalInSecond"> <summary> <para> <para>The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointCmdlet.RollingUpdatePolicy_WaitIntervalInSecond"> <summary> <para> <para>The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.</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 SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the <c>CreateModel</c> API, to deploy and the resources that you want SageMaker to provision. Then you call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> API. <note><para> Use this API if you want to use SageMaker hosting services to deploy models into production. </para></note><para> In the request, you define a <c>ProductionVariant</c>, for each model that you want to deploy. Each <c>ProductionVariant</c> parameter also describes the resources that you want 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 <c>VariantWeight</c> 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. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. </para><note><para> When you call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a>, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html"><c>Eventually Consistent Reads</c></a>, the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html">DescribeEndpointConfig</a> before calling <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> to minimize the potential impact of a DynamoDB eventually consistent read. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.DataCaptureConfig_CaptureOption"> <summary> <para> <para>Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_ContentTemplate"> <summary> <para> <para>A template string used to format a JSON record into an acceptable model container input. For example, a <c>ContentTemplate</c> string <c>'{"myfeatures":$features}'</c> will format a list of features <c>[1,2,3]</c> into the record string <c>'{"myfeatures":[1,2,3]}'</c>. Required only when the model container input is in JSON Lines format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.CaptureContentTypeHeader_CsvContentType"> <summary> <para> <para>The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.DataCaptureConfig_DestinationS3Uri"> <summary> <para> <para>The Amazon S3 location used to capture the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.DataCaptureConfig_EnableCapture"> <summary> <para> <para>Whether data capture should be enabled or disabled (defaults to enabled).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ClarifyExplainerConfig_EnableExplanation"> <summary> <para> <para>A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-enable"><c>EnableExplanations</c></a>for additional information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.EnableNetworkIsolation"> <summary> <para> <para>Sets whether all model containers deployed to the endpoint are isolated. If they are, no inbound or outbound network calls can be made to or from the model containers.</para> </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/APIReference/API_CreateEndpoint.html">CreateEndpoint</a> request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.NotificationConfig_ErrorTopic"> <summary> <para> <para>Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ExecutionRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform actions on your behalf. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </para><note><para>To be able to pass this role to Amazon SageMaker, the caller of this action must have the <c>iam:PassRole</c> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_FeatureHeader"> <summary> <para> <para>The names of the features. If provided, these are included in the endpoint response payload to help readability of the <c>InvokeEndpoint</c> output. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response">Response</a> section under <b>Invoke the endpoint</b> in the Developer Guide for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_FeaturesAttribute"> <summary> <para> <para>Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if <c>FeaturesAttribute</c> is the JMESPath expression <c>'myfeatures'</c>, it extracts a list of features <c>[1,2,3]</c> from request data <c>'{"myfeatures":[1,2,3]}'</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_FeatureType"> <summary> <para> <para>A list of data types of the features (optional). Applicable only to NLP explainability. If provided, <c>FeatureTypes</c> must have at least one <c>'text'</c> string (for example, <c>['text']</c>). If <c>FeatureTypes</c> is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response">response</a> section under <b>Invoke the endpoint</b> in the Developer Guide for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.TextConfig_Granularity"> <summary> <para> <para>The unit of granularity for the analysis of text features. For example, if the unit is <c>'token'</c>, then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.NotificationConfig_IncludeInferenceResponseIn"> <summary> <para> <para>The Amazon SNS topics where you want the inference response to be included.</para><note><para>The inference response is included only if the response size is less than or equal to 128 KB.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.DataCaptureConfig_InitialSamplingPercentage"> <summary> <para> <para>The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.CaptureContentTypeHeader_JsonContentType"> <summary> <para> <para>The list of all content type headers that SageMaker will treat as JSON and capture accordingly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.DataCaptureConfig_KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.</para><para>The KmsKeyId can be any of the following formats: </para><ul><li><para>Key ID: <c>1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Key ARN: <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Alias name: <c>alias/ExampleAlias</c></para></li><li><para>Alias name ARN: <c>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.</para><para>The KmsKeyId can be any of the following formats: </para><ul><li><para>Key ID: <c>1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Key ARN: <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Alias name: <c>alias/ExampleAlias</c></para></li><li><para>Alias name ARN: <c>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</c></para></li></ul><para>The KMS key policy must grant permission to the IAM role that you specify in your <c>CreateEndpoint</c>, <c>UpdateEndpoint</c> requests. For more information, refer to the Amazon Web Services Key Management Service section<a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html"> Using Key Policies in Amazon Web Services KMS </a></para><note><para>Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a <c>KmsKeyId</c> when using an instance type with local storage. If any of the models that you specify in the <c>ProductionVariants</c> parameter use nitro-based instances with local storage, do not specify a value for the <c>KmsKeyId</c> parameter. If you specify a value for <c>KmsKeyId</c> when using any nitro-based instances with local storage, the call to <c>CreateEndpointConfig</c> fails.</para><para>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</para><para>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD Instance Store Volumes</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_LabelAttribute"> <summary> <para> <para>A JMESPath expression used to locate the list of label headers in the model container output.</para><para><b>Example</b>: If the model container output of a batch request is <c>'{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}'</c>, then set <c>LabelAttribute</c> to <c>'labels'</c> to extract the list of label headers <c>["cat","dog","fish"]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_LabelHeader"> <summary> <para> <para>For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the <c>InvokeEndpoint</c> API. See the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response">response</a> section under <b>Invoke the endpoint</b> in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_LabelIndex"> <summary> <para> <para>A zero-based index used to extract a label header or list of label headers from model container output in CSV format.</para><para><b>Example for a multiclass model:</b> If the model container output consists of label headers followed by probabilities: <c>'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'</c>, set <c>LabelIndex</c> to <c>0</c> to select the label headers <c>['cat','dog','fish']</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.TextConfig_Language"> <summary> <para> <para>Specifies the language of the text features in <a href=" https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO 639-1</a> or <a href="https://en.wikipedia.org/wiki/ISO_639-3">ISO 639-3</a> code of a supported language. </para><note><para>For a mix of multiple languages, use code <c>'xx'</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ClientConfig_MaxConcurrentInvocationsPerInstance"> <summary> <para> <para>The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_MaxPayloadInMB"> <summary> <para> <para>The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to <c>6</c> MB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_MaxRecordCount"> <summary> <para> <para>The maximum number of records in a request that the model container can process when querying the model container for the predictions of a <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html#clarify-online-explainability-create-endpoint-synthetic">synthetic dataset</a>. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If <c>MaxRecordCount</c> is <c>1</c>, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShapBaselineConfig_MimeType"> <summary> <para> <para>The MIME type of the baseline data. Choose from <c>'text/csv'</c> or <c>'application/jsonlines'</c>. Defaults to <c>'text/csv'</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShapConfig_NumberOfSample"> <summary> <para> <para>The number of samples to be used for analysis by the Kernal SHAP algorithm. </para><note><para>The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the <b>Synthetic data</b> of <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-create-endpoint.html">Configure and create an endpoint</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_ProbabilityAttribute"> <summary> <para> <para>A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.</para><para><b>Example</b>: If the model container output of a single request is <c>'{"predicted_label":1,"probability":0.6}'</c>, then set <c>ProbabilityAttribute</c> to <c>'probability'</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.InferenceConfig_ProbabilityIndex"> <summary> <para> <para>A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.</para><para><b>Example for a single class model:</b> If the model container output consists of a string-formatted prediction label followed by its probability: <c>'1,0.6'</c>, set <c>ProbabilityIndex</c> to <c>1</c> to select the probability value <c>0.6</c>.</para><para><b>Example for a multiclass model:</b> If the model container output consists of a string-formatted prediction label followed by its probability: <c>'"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"'</c>, set <c>ProbabilityIndex</c> to <c>1</c> to select the probability values <c>[0.1,0.6,0.3]</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ProductionVariant"> <summary> <para> <para>An array of <c>ProductionVariant</c> 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.OutputConfig_S3FailurePath"> <summary> <para> <para>The Amazon S3 location to upload failure inference responses to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.OutputConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 location to upload inference responses to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShapConfig_Seed"> <summary> <para> <para>The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShadowProductionVariant"> <summary> <para> <para>An array of <c>ProductionVariant</c> objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on <c>ProductionVariants</c>. If you use this field, you can only specify one variant for <c>ProductionVariants</c> and one variant for <c>ShadowProductionVariants</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShapBaselineConfig_ShapBaseline"> <summary> <para> <para>The inline SHAP baseline data in string format. <c>ShapBaseline</c> can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the <c>Granularity</c> of the <c>TextConfig</c> parameter. The size limit for <c>ShapBasline</c> is 4 KB. Use the <c>ShapBaselineUri</c> parameter if you want to provide more than 4 KB of baseline data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShapBaselineConfig_ShapBaselineUri"> <summary> <para> <para>The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the <c>ShapBaselineUri</c> should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker access to Resources in your Amazon Virtual Private Cloud</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.NotificationConfig_SuccessTopic"> <summary> <para> <para>Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMEndpointConfigCmdlet.ShapConfig_UseLogit"> <summary> <para> <para>A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.</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.NewSMExperimentCmdlet"> <summary> Creates a SageMaker <i>experiment</i>. An experiment is a collection of <i>trials</i> that are observed, compared and evaluated as a group. A trial is a set of steps, called <i>trial components</i>, that produce a machine learning model. <note><para> In the Studio UI, trials are referred to as <i>run groups</i> and trial components are referred to as <i>runs</i>. </para></note><para> The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. </para><para> When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. </para><para> You can add tags to experiments, trials, trial components and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for the tags. </para><para> To add a description to an experiment, specify the optional <c>Description</c> parameter. To add a description later, or to change the description, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html">UpdateExperiment</a> API. </para><para> To get a list of all your experiments, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html">ListExperiments</a> API. To view an experiment's properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html">DescribeExperiment</a> API. To get a list of all the trials associated with an experiment, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API. To create a trial call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html">CreateTrial</a> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMExperimentCmdlet.Description"> <summary> <para> <para>The description of the experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMExperimentCmdlet.DisplayName"> <summary> <para> <para>The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify <c>DisplayName</c>, the value in <c>ExperimentName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMExperimentCmdlet.ExperimentName"> <summary> <para> <para>The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMExperimentCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the experiment. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateExperimentResponse 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.NewSMExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExperimentName parameter. The -PassThru parameter is deprecated, use -Select '^ExperimentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMExperimentCmdlet.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.NewSMFeatureGroupCmdlet"> <summary> Create a new <c>FeatureGroup</c>. A <c>FeatureGroup</c> is a group of <c>Features</c> defined in the <c>FeatureStore</c> to describe a <c>Record</c>. <para> The <c>FeatureGroup</c> defines the schema and features contained in the <c>FeatureGroup</c>. A <c>FeatureGroup</c> definition is composed of a list of <c>Features</c>, a <c>RecordIdentifierFeatureName</c>, an <c>EventTimeFeatureName</c> and configurations for its <c>OnlineStore</c> and <c>OfflineStore</c>. Check <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">Amazon Web Services service quotas</a> to see the <c>FeatureGroup</c>s quota for your Amazon Web Services account. </para><para> Note that it can take approximately 10-15 minutes to provision an <c>OnlineStore</c><c>FeatureGroup</c> with the <c>InMemory</c><c>StorageType</c>. </para><important><para> You must include at least one of <c>OnlineStoreConfig</c> and <c>OfflineStoreConfig</c> to create a <c>FeatureGroup</c>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.DataCatalogConfig_Catalog"> <summary> <para> <para>The name of the Glue table catalog.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.DataCatalogConfig_Database"> <summary> <para> <para>The name of the Glue table database.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.Description"> <summary> <para> <para>A free-form description of a <c>FeatureGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.OfflineStoreConfig_DisableGlueTableCreation"> <summary> <para> <para>Set to <c>True</c> to disable the automatic creation of an Amazon Web Services Glue table when configuring an <c>OfflineStore</c>. If set to <c>False</c>, Feature Store will name the <c>OfflineStore</c> Glue table following <a href="https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html">Athena's naming recommendations</a>.</para><para>The default value is <c>False</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.OnlineStoreConfig_EnableOnlineStore"> <summary> <para> <para>Turn <c>OnlineStore</c> off by specifying <c>False</c> for the <c>EnableOnlineStore</c> flag. Turn <c>OnlineStore</c> on by specifying <c>True</c> for the <c>EnableOnlineStore</c> flag. </para><para>The default value is <c>False</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.EventTimeFeatureName"> <summary> <para> <para>The name of the feature that stores the <c>EventTime</c> of a <c>Record</c> in a <c>FeatureGroup</c>.</para><para>An <c>EventTime</c> is a point in time when a new event occurs that corresponds to the creation or update of a <c>Record</c> in a <c>FeatureGroup</c>. All <c>Records</c> in the <c>FeatureGroup</c> must have a corresponding <c>EventTime</c>.</para><para>An <c>EventTime</c> can be a <c>String</c> or <c>Fractional</c>. </para><ul><li><para><c>Fractional</c>: <c>EventTime</c> feature values must be a Unix timestamp in seconds.</para></li><li><para><c>String</c>: <c>EventTime</c> feature values must be an ISO-8601 string in the format. The following formats are supported <c>yyyy-MM-dd'T'HH:mm:ssZ</c> and <c>yyyy-MM-dd'T'HH:mm:ss.SSSZ</c> where <c>yyyy</c>, <c>MM</c>, and <c>dd</c> represent the year, month, and day respectively and <c>HH</c>, <c>mm</c>, <c>ss</c>, and if applicable, <c>SSS</c> represent the hour, month, second and milliseconds respsectively. <c>'T'</c> and <c>Z</c> are constants.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.FeatureDefinition"> <summary> <para> <para>A list of <c>Feature</c> names and types. <c>Name</c> and <c>Type</c> is compulsory per <c>Feature</c>. </para><para>Valid feature <c>FeatureType</c>s are <c>Integral</c>, <c>Fractional</c> and <c>String</c>.</para><para><c>FeatureName</c>s cannot be any of the following: <c>is_deleted</c>, <c>write_time</c>, <c>api_invocation_time</c></para><para>You can create up to 2,500 <c>FeatureDefinition</c>s per <c>FeatureGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.FeatureGroupName"> <summary> <para> <para>The name of the <c>FeatureGroup</c>. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.</para><para>The name:</para><ul><li><para>Must start with an alphanumeric character.</para></li><li><para>Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.S3StorageConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the <c>OfflineStore</c> S3 location.</para><para>The IAM <c>roleARN</c> that is passed as a parameter to <c>CreateFeatureGroup</c> must have below permissions to the <c>KmsKeyId</c>:</para><ul><li><para><c>"kms:GenerateDataKey"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.SecurityConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.</para><para>The caller (either user or IAM role) of <c>CreateFeatureGroup</c> must have below permissions to the <c>OnlineStore</c><c>KmsKeyId</c>:</para><ul><li><para><c>"kms:Encrypt"</c></para></li><li><para><c>"kms:Decrypt"</c></para></li><li><para><c>"kms:DescribeKey"</c></para></li><li><para><c>"kms:CreateGrant"</c></para></li><li><para><c>"kms:RetireGrant"</c></para></li><li><para><c>"kms:ReEncryptFrom"</c></para></li><li><para><c>"kms:ReEncryptTo"</c></para></li><li><para><c>"kms:GenerateDataKey"</c></para></li><li><para><c>"kms:ListAliases"</c></para></li><li><para><c>"kms:ListGrants"</c></para></li><li><para><c>"kms:RevokeGrant"</c></para></li></ul><para>The caller (either user or IAM role) to all DataPlane operations (<c>PutRecord</c>, <c>GetRecord</c>, <c>DeleteRecord</c>) must have the following permissions to the <c>KmsKeyId</c>:</para><ul><li><para><c>"kms:Decrypt"</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.ThroughputConfig_ProvisionedReadCapacityUnit"> <summary> <para> <para> For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. </para><para>This field is not applicable for on-demand feature groups. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.ThroughputConfig_ProvisionedWriteCapacityUnit"> <summary> <para> <para> For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. </para><para>This field is not applicable for on-demand feature groups. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.RecordIdentifierFeatureName"> <summary> <para> <para>The name of the <c>Feature</c> whose value uniquely identifies a <c>Record</c> defined in the <c>FeatureStore</c>. Only the latest record per identifier value will be stored in the <c>OnlineStore</c>. <c>RecordIdentifierFeatureName</c> must be one of feature definitions' names.</para><para>You use the <c>RecordIdentifierFeatureName</c> to access data in a <c>FeatureStore</c>.</para><para>This name:</para><ul><li><para>Must start with an alphanumeric character.</para></li><li><para>Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.S3StorageConfig_ResolvedOutputS3Uri"> <summary> <para> <para>The S3 path where offline records are written.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the <c>OfflineStore</c> if an <c>OfflineStoreConfig</c> is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.S3StorageConfig_S3Uri"> <summary> <para> <para>The S3 URI, or location in Amazon S3, of <c>OfflineStore</c>.</para><para>S3 URIs have a format similar to the following: <c>s3://example-bucket/prefix/</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.OnlineStoreConfig_StorageType"> <summary> <para> <para>Option for different tiers of low latency storage for real-time data retrieval.</para><ul><li><para><c>Standard</c>: A managed low latency data store for feature groups.</para></li><li><para><c>InMemory</c>: A managed data store for feature groups that supports very low latency retrieval. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.OfflineStoreConfig_TableFormat"> <summary> <para> <para>Format for the offline store table. Supported formats are Glue (Default) and <a href="https://iceberg.apache.org/">Apache Iceberg</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.DataCatalogConfig_TableName"> <summary> <para> <para>The name of the Glue table.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.Tag"> <summary> <para> <para>Tags used to identify <c>Features</c> in each <c>FeatureGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.ThroughputConfig_ThroughputMode"> <summary> <para> <para>The mode used for your feature group throughput: <c>ON_DEMAND</c> or <c>PROVISIONED</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.TtlDuration_Unit"> <summary> <para> <para><c>TtlDuration</c> time unit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.TtlDuration_Value"> <summary> <para> <para><c>TtlDuration</c> time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeatureGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateFeatureGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateFeatureGroupResponse 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.NewSMFeatureGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFeatureGroupCmdlet.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.NewSMFlowDefinitionCmdlet"> <summary> Creates a flow definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopRequestSource_AwsManagedHumanLoopRequestSource"> <summary> <para> <para>Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.AmountInUsd_Cent"> <summary> <para> <para>The fractional portion, in cents, of the amount. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.AmountInUsd_Dollar"> <summary> <para> <para>The whole number of dollars in the amount.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.FlowDefinitionName"> <summary> <para> <para>The name of your flow definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopActivationConditionsConfig_HumanLoopActivationCondition"> <summary> <para> <para>JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-human-fallback-conditions-json-schema.html">JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI</a> in the <i>Amazon SageMaker Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_HumanTaskUiArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the human task user interface.</para><para>You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.</para><para>To learn how to create a custom HTML template, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html">Create Custom Worker Task Template</a>.</para><para>To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-worker-template-console.html">Create and Delete a Worker Task Templates</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Key Management Service (KMS) key ID for server-side encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, <c>arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.OutputConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 path where the object containing human output will be made available.</para><para>To learn more about the format of Amazon A2I output data, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-output-data.html">Amazon A2I Output Data</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_TaskAvailabilityLifetimeInSecond"> <summary> <para> <para>The length of time that a task remains available for review by human workers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_TaskCount"> <summary> <para> <para>The number of distinct workers who will perform the same task on each object. For example, if <c>TaskCount</c> is set to <c>3</c> for an image classification labeling job, three workers will classify each input image. Increasing <c>TaskCount</c> can improve label accuracy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_TaskDescription"> <summary> <para> <para>A description for the human worker task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_TaskKeyword"> <summary> <para> <para>Keywords used to describe the task so that workers can discover the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_TaskTimeLimitInSecond"> <summary> <para> <para>The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_TaskTitle"> <summary> <para> <para>A title for the human worker task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.AmountInUsd_TenthFractionsOfACent"> <summary> <para> <para>Fractions of a cent, in tenths.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.HumanLoopConfig_WorkteamArn"> <summary> <para> <para>Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-management.html">Create and Manage Workforces</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowDefinitionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateFlowDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateFlowDefinitionResponse 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.NewSMFlowDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^FlowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMFlowDefinitionCmdlet.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.NewSMHubCmdlet"> <summary> Create a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.HubDescription"> <summary> <para> <para>A description of the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.HubDisplayName"> <summary> <para> <para>The display name of the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.HubName"> <summary> <para> <para>The name of the hub to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.HubSearchKeyword"> <summary> <para> <para>The searchable keywords for the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.S3StorageConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 bucket prefix for hosting hub content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.Tag"> <summary> <para> <para>Any tags to associate with the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HubArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateHubResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateHubResponse 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.NewSMHubCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HubName parameter. The -PassThru parameter is deprecated, use -Select '^HubName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHubCmdlet.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.NewSMHumanTaskUiCmdlet"> <summary> Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHumanTaskUiCmdlet.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.NewSMHumanTaskUiCmdlet.HumanTaskUiName"> <summary> <para> <para>The name of the user interface you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHumanTaskUiCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHumanTaskUiCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HumanTaskUiArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateHumanTaskUiResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateHumanTaskUiResponse 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.NewSMHumanTaskUiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HumanTaskUiName parameter. The -PassThru parameter is deprecated, use -Select '^HumanTaskUiName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHumanTaskUiCmdlet.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. <para> A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/experiments-view-compare.html#experiments-view">View Experiments, Trials, and Trial Components</a>. </para><important><para> Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error. </para></important> </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 <c>TrainingImage</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningResourceConfig_AllocationStrategy"> <summary> <para> <para>The strategy that determines the order of preference for resources specified in <c>InstanceConfigs</c> used in hyperparameter optimization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_AutoParameter"> <summary> <para> <para>A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterRanges_AutoParameter"> <summary> <para> <para>A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_CategoricalParameterRange"> <summary> <para> <para>The array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CategoricalParameterRange.html">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.HyperParameterRanges_CategoricalParameterRange"> <summary> <para> <para>The array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CategoricalParameterRange.html">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.ConvergenceDetected_CompleteOnConvergence"> <summary> <para> <para>A flag to stop a tuning job once AMT has detected that the job has converged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_ContinuousParameterRange"> <summary> <para> <para>The array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContinuousParameterRange.html">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.HyperParameterRanges_ContinuousParameterRange"> <summary> <para> <para>The array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ContinuousParameterRange.html">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_DefinitionName"> <summary> <para> <para>The job definition name.</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 <c>True</c>. 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 (<c>True</c>) or not (<c>False</c>).</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, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition_Environment"> <summary> <para> <para>An environment variable that you can pass into the SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a> API. You can use an existing <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-Environment">environment variable from the training container</a> or use your own. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html">Define metrics and variables</a> for more information.</para><note><para>The maximum number of items specified for <c>Map Entries</c> refers to the maximum number of environment variables for each <c>TrainingJobDefinition</c> and also the maximum for the hyperparameter tuning job itself. That is, the sum of the number of environment variables for all the training job definitions can't exceed the maximum number specified.</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 Amazon Web Services account and Amazon Web Services Region. The name must have 1 to 32 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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Channel.html">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.HyperParameterTuningResourceConfig_InstanceConfig"> <summary> <para> <para>A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The <c>AllocationStrategy</c> controls the order in which multiple configurations provided in <c>InstanceConfigs</c> are used.</para><note><para>If you only want to use a single instance configuration inside the <c>HyperParameterTuningResourceConfig</c> API, do not provide a value for <c>InstanceConfigs</c>. Instead, use <c>InstanceType</c>, <c>VolumeSizeInGB</c> and <c>InstanceCount</c>. If you use <c>InstanceConfigs</c>, do not provide values for <c>InstanceType</c>, <c>VolumeSizeInGB</c> or <c>InstanceCount</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningResourceConfig_InstanceCount"> <summary> <para> <para>The number of compute instances of type <c>InstanceType</c> to use. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/data-parallel-use-api.html">distributed training</a>, select a value greater than 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningResourceConfig_InstanceType"> <summary> <para> <para>The instance type used to run hyperparameter optimization tuning jobs. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/notebooks-available-instance-types.html"> descriptions of instance types</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ParameterRanges_IntegerParameterRange"> <summary> <para> <para>The array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_IntegerParameterRange.html">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.HyperParameterRanges_IntegerParameterRange"> <summary> <para> <para>The array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_IntegerParameterRange.html">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 <c>/opt/ml/checkpoints/</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.RetryStrategy_MaximumRetryAttempt"> <summary> <para> <para>The number of times to retry the job. When the job is retried, it's <c>SecondaryStatus</c> is changed to <c>STARTING</c>.</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.BestObjectiveNotImproving_MaxNumberOfTrainingJobsNotImproving"> <summary> <para> <para>The number of training jobs that have failed to improve model performance by 1% or greater over prior training jobs as evaluated against an objective function.</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_MaxPendingTimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperbandStrategyConfig_MaxResource"> <summary> <para> <para>The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the <c>MaxResource</c> value, it is stopped. If a value for <c>MaxResource</c> is not provided, and <c>Hyperband</c> is selected as the hyperparameter tuning strategy, <c>HyperbandTraining</c> attempts to infer <c>MaxResource</c> from the following keys (if present) in <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-StaticHyperParameters">StaticsHyperParameters</a>:</para><ul><li><para><c>epochs</c></para></li><li><para><c>numepochs</c></para></li><li><para><c>n-epochs</c></para></li><li><para><c>n_epochs</c></para></li><li><para><c>num_epochs</c></para></li></ul><para>If <c>HyperbandStrategyConfig</c> is unable to infer a value for <c>MaxResource</c>, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html">early stopping decisions</a>. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/distributed-training.html">distributed</a> training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.ResourceLimits_MaxRuntimeInSecond"> <summary> <para> <para>The maximum time in seconds that a hyperparameter tuning job can run.</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 a training or compilation job can run before it is stopped.</para><para>For compilation jobs, if the job does not complete during this time, a <c>TimeOut</c> error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.</para><para>For all other jobs, if the job does not complete during this time, SageMaker ends the job. When <c>RetryStrategy</c> is specified in the job request, <c>MaxRuntimeInSeconds</c> specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.</para><para>The maximum time that a <c>TrainingJob</c> can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 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, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than <c>MaxRuntimeInSeconds</c>. If the job does not complete during this time, SageMaker ends the job.</para><para>When <c>RetryStrategy</c> is specified in the job request, <c>MaxWaitTimeInSeconds</c> specifies the maximum time for all of the attempts in total, not each individual attempt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.AlgorithmSpecification_MetricDefinition"> <summary> <para> <para>An array of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html">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.TuningObjective_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.HyperbandStrategyConfig_MinResource"> <summary> <para> <para>The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for <c>MinResource</c> has not been reached, the training job is not stopped by <c>Hyperband</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.Autotune_Mode"> <summary> <para> <para>Set <c>Mode</c> to <c>Enabled</c> if you want to use Autotune.</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.HyperParameterTuningJobConfig_RandomSeed"> <summary> <para> <para>A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.</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 SageMaker to use the storage volume to store the training data, choose <c>File</c> as the <c>TrainingInputMode</c> in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.</para><note><para>If you want to use hyperparameter optimization with instance type flexibility, use <c>HyperParameterTuningResourceConfig</c> instead.</para></note> </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 SageMaker to store checkpoints. For example, <c>s3://bucket-name/key-name-prefix</c>.</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 <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> 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. 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. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </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 Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</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.TuningJobCompletionCriteria_TargetObjectiveMetricValue"> <summary> <para> <para>The value of the objective metric.</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>. SageMaker supports both <c>registry/repository[:tag]</c> and <c>registry/repository[@digest]</c> 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> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.TrainingJobDefinition"> <summary> <para> <para>A list of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> objects launched for this tuning job.</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. Because the <c>Hyperband</c> strategy has its own advanced internal early stopping mechanism, <c>TrainingJobEarlyStoppingType</c> must be <c>OFF</c> to use <c>Hyperband</c>. This parameter can take on one of the following values (the default value is <c>OFF</c>):</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>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.TuningObjective_Type"> <summary> <para> <para>Whether to minimize or maximize the objective metric.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningResourceConfig_VolumeKmsKeyId"> <summary> <para> <para>A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.</para><para>KMS Key ID:</para><para><c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para><para>Amazon Resource Name (ARN) of a KMS key:</para><para><c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para><para>Some instances use local storage, which use a <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">hardware module to encrypt</a> storage volumes. If you choose one of these instance types, you cannot request a <c>VolumeKmsKeyId</c>. For a list of instance types that use local storage, see <a href="http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/">instance store volumes</a>. For more information about Amazon Web Services Key Management Service, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-kms-permissions.html">KMS encryption</a> for more information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMHyperParameterTuningJobCmdlet.HyperParameterTuningResourceConfig_VolumeSizeInGB"> <summary> <para> <para>The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for <c>InstanceConfigs</c> is also specified.</para><para>Some instance types have a fixed total local storage size. If you select one of these instances for training, <c>VolumeSizeInGB</c> cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see <a href="http://aws.amazon.com/releasenotes/host-instance-storage-volumes-table/">instance store volumes</a>.</para><note><para>SageMaker supports only the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html">General Purpose SSD (gp2)</a> storage volume type.</para></note> </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.NewSMImageCmdlet"> <summary> Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html">Bring your own SageMaker image</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageCmdlet.Description"> <summary> <para> <para>The description of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageCmdlet.DisplayName"> <summary> <para> <para>The display name of the image. If not provided, <c>ImageName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageCmdlet.ImageName"> <summary> <para> <para>The name of the image. Must be unique to your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageCmdlet.RoleArn"> <summary> <para> <para>The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateImageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateImageResponse 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.NewSMImageCmdlet.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.NewSMImageVersionCmdlet"> <summary> Creates a version of the SageMaker image specified by <c>ImageName</c>. The version represents the Amazon ECR container image specified by <c>BaseImage</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.Alias"> <summary> <para> <para>A list of aliases created with the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.BaseImage"> <summary> <para> <para>The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:</para><para><c><acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]></c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.Horovod"> <summary> <para> <para>Indicates Horovod compatibility.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.ImageName"> <summary> <para> <para>The <c>ImageName</c> of the <c>Image</c> to create a version of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.JobType"> <summary> <para> <para>Indicates SageMaker job type compatibility.</para><ul><li><para><c>TRAINING</c>: The image version is compatible with SageMaker training jobs.</para></li><li><para><c>INFERENCE</c>: The image version is compatible with SageMaker inference jobs.</para></li><li><para><c>NOTEBOOK_KERNEL</c>: The image version is compatible with SageMaker notebook kernels.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.MLFramework"> <summary> <para> <para>The machine learning framework vended in the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.Processor"> <summary> <para> <para>Indicates CPU or GPU compatibility.</para><ul><li><para><c>CPU</c>: The image version is compatible with CPU.</para></li><li><para><c>GPU</c>: The image version is compatible with GPU.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.ProgrammingLang"> <summary> <para> <para>The supported programming language and its version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.ReleaseNote"> <summary> <para> <para>The maintainer description of the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.VendorGuidance"> <summary> <para> <para>The stability of the image version, specified by the maintainer.</para><ul><li><para><c>NOT_PROVIDED</c>: The maintainers did not provide a status for image version stability.</para></li><li><para><c>STABLE</c>: The image version is stable.</para></li><li><para><c>TO_BE_ARCHIVED</c>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</para></li><li><para><c>ARCHIVED</c>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.ClientToken"> <summary> <para> <para>A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMImageVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateImageVersionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateImageVersionResponse 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.NewSMImageVersionCmdlet.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.NewSMInferenceComponentCmdlet"> <summary> Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.Container_ArtifactUrl"> <summary> <para> <para>The Amazon 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.NewSMInferenceComponentCmdlet.StartupParameters_ContainerStartupHealthCheckTimeoutInSecond"> <summary> <para> <para>The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests">How Your Container Should Respond to Health Check (Ping) Requests</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.RuntimeConfig_CopyCount"> <summary> <para> <para>The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.EndpointName"> <summary> <para> <para>The name of an existing endpoint where you host the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.Container_Environment"> <summary> <para> <para>The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.Container_Image"> <summary> <para> <para>The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.InferenceComponentName"> <summary> <para> <para>A unique name to assign to the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.ComputeResourceRequirements_MaxMemoryRequiredInMb"> <summary> <para> <para>The maximum MB of memory to allocate to run a model that you assign to an inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.ComputeResourceRequirements_MinMemoryRequiredInMb"> <summary> <para> <para>The minimum MB of memory to allocate to run a model that you assign to an inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.StartupParameters_ModelDataDownloadTimeoutInSecond"> <summary> <para> <para>The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.Specification_ModelName"> <summary> <para> <para>The name of an existing SageMaker model object in your account that you want to deploy with the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.ComputeResourceRequirements_NumberOfAcceleratorDevicesRequired"> <summary> <para> <para>The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.ComputeResourceRequirements_NumberOfCpuCoresRequired"> <summary> <para> <para>The number of CPU cores to allocate to run a model that you assign to an inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.Tag"> <summary> <para> <para>A list of key-value pairs associated with the model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.VariantName"> <summary> <para> <para>The name of an existing production variant where you host the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceComponentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateInferenceComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateInferenceComponentResponse 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.NewSMInferenceComponentCmdlet.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.NewSMInferenceExperimentCmdlet"> <summary> Creates an inference experiment using the configurations specified in the request. <para> Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html">Shadow tests</a>. </para><para> Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration. </para><para> While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html">View, monitor, and edit shadow tests</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.ContentType_CsvContentType"> <summary> <para> <para>The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Description"> <summary> <para> <para>A description for the inference experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.DataStorageConfig_Destination"> <summary> <para> <para>The Amazon S3 bucket where the inference request and response data is stored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.EndpointName"> <summary> <para> <para> The name of the Amazon SageMaker endpoint on which you want to run the inference experiment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Schedule_EndTime"> <summary> <para> <para>The timestamp at which the inference experiment ended or will end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.ContentType_JsonContentType"> <summary> <para> <para>The list of all content type headers that SageMaker will treat as JSON and capture accordingly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.DataStorageConfig_KmsKey"> <summary> <para> <para> The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.KmsKey"> <summary> <para> <para> The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The <c>KmsKey</c> can be any of the following formats: </para><ul><li><para>KMS key ID</para><para><c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS key</para><para><c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>KMS key Alias</para><para><c>"alias/ExampleAlias"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS key Alias</para><para><c>"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"</c></para></li></ul><para> If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call <c>kms:Encrypt</c>. 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 <c>OutputDataConfig</c>. If you use a bucket policy with an <c>s3:PutObject</c> permission that only allows objects with server-side encryption, set the condition key of <c>s3:x-amz-server-side-encryption</c> to <c>"aws:kms"</c>. 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 <c>CreateEndpoint</c> and <c>UpdateEndpoint</c> requests. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Using Key Policies in Amazon Web Services KMS</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.ModelVariant"> <summary> <para> <para> An array of <c>ModelVariantConfig</c> objects. There is one for each variant in the inference experiment. Each <c>ModelVariantConfig</c> object in the array describes the infrastructure configuration for the corresponding variant. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Name"> <summary> <para> <para>The name for the inference experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.RoleArn"> <summary> <para> <para> The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.ShadowModeConfig_ShadowModelVariant"> <summary> <para> <para>List of shadow variant configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.ShadowModeConfig_SourceModelVariantName"> <summary> <para> <para> The name of the production variant, which takes all the inference requests. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Schedule_StartTime"> <summary> <para> <para>The timestamp at which the inference experiment started or will start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Tag"> <summary> <para> <para> Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/tagging.html">Tagging your Amazon Web Services Resources</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Type"> <summary> <para> <para> The type of the inference experiment that you want to run. The following types of experiments are possible: </para><ul><li><para><c>ShadowMode</c>: You can use this type to validate a shadow variant. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html">Shadow tests</a>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateInferenceExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateInferenceExperimentResponse 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.NewSMInferenceExperimentCmdlet.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.NewSMInferenceRecommendationsJobCmdlet"> <summary> Starts a recommendation job. You can create either an instance recommendation or load test job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_DataInputConfig"> <summary> <para> <para>Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_InputConfig.html#sagemaker-Type-InputConfig-DataInputConfig">DataInputConfig</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_Domain"> <summary> <para> <para>The machine learning domain of the model and its components.</para><para>Valid Values: <c>COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.Stairs_DurationInSecond"> <summary> <para> <para>Defines how long each traffic step should be.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.InputConfig_EndpointConfiguration"> <summary> <para> <para>Specifies the endpoint configuration to use for a job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.InputConfig_Endpoint"> <summary> <para> <para>Existing customer endpoints on which to run an Inference Recommender job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.StoppingConditions_FlatInvocation"> <summary> <para> <para>Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is <c>Stop</c>. If you want the load test to continue after invocations have flattened, set the value to <c>Continue</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_Framework"> <summary> <para> <para>The machine learning framework of the container image.</para><para>Valid Values: <c>TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_FrameworkVersion"> <summary> <para> <para>The framework version of the container image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.JobDescription"> <summary> <para> <para>Description of the recommendation job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.InputConfig_JobDurationInSecond"> <summary> <para> <para>Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.JobName"> <summary> <para> <para>A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.JobType"> <summary> <para> <para>Defines the type of recommendation job. Specify <c>Default</c> to initiate an instance recommendation and <c>Advanced</c> to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (<c>DEFAULT</c>) job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have <c>kms:GenerateDataKey</c> permission.</para><para>The <c>KmsKeyId</c> can be any of the following formats:</para><ul><li><para>// KMS Key ID</para><para><c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key</para><para><c>"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"</c></para></li><li><para>// KMS Key Alias</para><para><c>"alias/ExampleAlias"</c></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key Alias</para><para><c>"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"</c></para></li></ul><para>For more information about key identifiers, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">Key identifiers (KeyID)</a> in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.StoppingConditions_MaxInvocation"> <summary> <para> <para>The maximum number of requests per minute expected for the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ResourceLimit_MaxNumberOfTest"> <summary> <para> <para>Defines the maximum number of load tests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ResourceLimit_MaxParallelOfTest"> <summary> <para> <para>Defines the maximum number of parallel load tests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.StoppingConditions_ModelLatencyThreshold"> <summary> <para> <para>The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.InputConfig_ModelName"> <summary> <para> <para>The name of the created model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.InputConfig_ModelPackageVersionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a versioned model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_NearestModelName"> <summary> <para> <para>The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.</para><para>Valid Values: <c>efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.Stairs_NumberOfStep"> <summary> <para> <para>Specifies how many steps to perform during traffic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.TrafficPattern_Phase"> <summary> <para> <para>Defines the phases traffic specification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.CompiledOutputConfig_S3OutputUri"> <summary> <para> <para>Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.PayloadConfig_SamplePayloadUrl"> <summary> <para> <para>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is 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.NewSMInferenceRecommendationsJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs. IDs have the form of <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.PayloadConfig_SupportedContentType"> <summary> <para> <para>The supported MIME types for the input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_SupportedEndpointType"> <summary> <para> <para>The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_SupportedInstanceType"> <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.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_SupportedResponseMIMEType"> <summary> <para> <para>The supported MIME types for the output data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.Tag"> <summary> <para> <para>The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.ContainerConfig_Task"> <summary> <para> <para>The machine learning task that the model accomplishes.</para><para>Valid Values: <c>IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.TrafficPattern_TrafficType"> <summary> <para> <para>Defines the traffic patterns. Choose either <c>PHASES</c> or <c>STAIRS</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.Stairs_UsersPerStep"> <summary> <para> <para>Specifies how many new users to spawn in each step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.InputConfig_VolumeKmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation. </para><para>The SageMaker execution role must have <c>kms:CreateGrant</c> permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have <c>kms:CreateGrant</c> permission.</para><para>The <c>KmsKeyId</c> can be any of the following formats:</para><ul><li><para>// KMS Key ID</para><para><c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key</para><para><c>"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"</c></para></li><li><para>// KMS Key Alias</para><para><c>"alias/ExampleAlias"</c></para></li><li><para>// Amazon Resource Name (ARN) of a KMS Key Alias</para><para><c>"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"</c></para></li></ul><para>For more information about key identifiers, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">Key identifiers (KeyID)</a> in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateInferenceRecommendationsJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateInferenceRecommendationsJobResponse 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.NewSMInferenceRecommendationsJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobName parameter. The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMInferenceRecommendationsJobCmdlet.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 Amazon Web Services 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><para> You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in <c>ManifestS3Uri</c> have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (<c>InProgress</c>) streaming labeling job in real time. To learn how to create a static labeling job, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-create-labeling-job-api.html">Create a Labeling Job (API) </a> in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-create-job.html">Create a Streaming Labeling Job</a>. </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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html">annotation consolidation</a> and to process output data.</para><para>This parameter is required for all labeling jobs. For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task types</a>, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for <c>AnnotationConsolidationLambdaArn</c>. For custom labeling workflows, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-postlambda">Post-annotation Lambda</a>. </para><para><b>Bounding box</b> - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox</c></para></li></ul><para><b>Image classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass</c></para></li></ul><para><b>Multi-label image classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel</c></para></li></ul><para><b>Semantic segmentation</b> - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation</c></para></li></ul><para><b>Text classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass</c></para></li></ul><para><b>Multi-label text classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel</c></para></li></ul><para><b>Named entity recognition</b> - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition</c></para></li></ul><para><b>Video Classification</b> - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass</c></para></li></ul><para><b>Video Frame Object Detection</b> - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection</c></para></li></ul><para><b>Video Frame Object Tracking</b> - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking</c></para></li></ul><para><b>3D Point Cloud Object Detection</b> - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection</c></para></li></ul><para><b>3D Point Cloud Object Tracking</b> - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking</c></para></li></ul><para><b>3D Point Cloud Semantic Segmentation</b> - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation</c></para></li></ul><para><b>Use the following ARNs for Label Verification and Adjustment Jobs</b></para><para>Use label verification and adjustment jobs to review and adjust labels. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html">Verify and Adjust Labels </a>.</para><para><b>Semantic Segmentation Adjustment</b> - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation</c></para></li></ul><para><b>Semantic Segmentation Verification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation</c></para></li></ul><para><b>Bounding Box Adjustment</b> - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox</c></para></li></ul><para><b>Bounding Box Verification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox</c></para></li></ul><para><b>Video Frame Object Detection Adjustment</b> - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection</c></para></li></ul><para><b>Video Frame Object Tracking Adjustment</b> - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking</c></para></li></ul><para><b>3D Point Cloud Object Detection Adjustment</b> - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection</c></para></li></ul><para><b>3D Point Cloud Object Tracking Adjustment</b> - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking</c></para></li></ul><para><b>3D Point Cloud Semantic Segmentation Adjustment</b> - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation</c></para></li></ul> </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. 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.UiConfig_HumanTaskUiArn"> <summary> <para> <para>The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.</para><para>Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace <c>aws-region</c> with the Amazon Web Services Region you are creating your labeling job in. For example, replace <c>aws-region</c> with <c>us-west-1</c> if you create a labeling job in US West (N. California).</para><para><b>Named Entity Recognition</b></para><para>Use the following <c>HumanTaskUiArn</c> for named entity recognition labeling jobs:</para><para><c>arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition</c></para><para><b>3D Point Cloud HumanTaskUiArns</b></para><para>Use this <c>HumanTaskUiArn</c> for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs. </para><ul><li><para><c>arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection</c></para></li></ul><para> Use this <c>HumanTaskUiArn</c> for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs. </para><ul><li><para><c>arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking</c></para></li></ul><para> Use this <c>HumanTaskUiArn</c> for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.</para><ul><li><para><c>arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation</c></para></li></ul><para><b>Video Frame HumanTaskUiArns</b></para><para>Use this <c>HumanTaskUiArn</c> for video frame object detection and video frame object detection adjustment labeling jobs. </para><ul><li><para><c>arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection</c></para></li></ul><para> Use this <c>HumanTaskUiArn</c> for video frame object tracking and video frame object tracking adjustment labeling jobs. </para><ul><li><para><c>arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelingJobAlgorithmsConfig_InitialActiveLearningModelArn"> <summary> <para> <para>At the end of an auto-label job Ground Truth sends the Amazon Resource Name (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 Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.</para><para>If you provide your own KMS key ID, you must add the required permissions to your KMS key described in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security-permission.html#sms-security-kms-permissions">Encrypt Output Data and Storage Volume with Amazon Web Services KMS</a>.</para><para>If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.</para><para>If you use a bucket policy with an <c>s3:PutObject</c> permission that only allows objects with server-side encryption, set the condition key of <c>s3:x-amz-server-side-encryption</c> to <c>"aws:kms"</c>. 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> </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 <c>LabelAttributeName</c> must meet the following requirements.</para><ul><li><para>The name can't end with "-metadata". </para></li><li><para>If you are using one of the following <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task types</a>, the attribute name <i>must</i> end with "-ref". If the task type you are using is not listed below, the attribute name <i>must not</i> end with "-ref".</para><ul><li><para>Image semantic segmentation (<c>SemanticSegmentation)</c>, and adjustment (<c>AdjustmentSemanticSegmentation</c>) and verification (<c>VerificationSemanticSegmentation</c>) labeling jobs for this task type.</para></li><li><para>Video frame object detection (<c>VideoObjectDetection</c>), and adjustment and verification (<c>AdjustmentVideoObjectDetection</c>) labeling jobs for this task type.</para></li><li><para>Video frame object tracking (<c>VideoObjectTracking</c>), and adjustment and verification (<c>AdjustmentVideoObjectTracking</c>) labeling jobs for this task type.</para></li><li><para>3D point cloud semantic segmentation (<c>3DPointCloudSemanticSegmentation</c>), and adjustment and verification (<c>Adjustment3DPointCloudSemanticSegmentation</c>) labeling jobs for this task type. </para></li><li><para>3D point cloud object tracking (<c>3DPointCloudObjectTracking</c>), and adjustment and verification (<c>Adjustment3DPointCloudObjectTracking</c>) labeling jobs for this task type. </para></li></ul></li></ul><important><para>If you are creating an adjustment or verification labeling job, you must use a <i>different</i><c>LabelAttributeName</c> than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html">Verify and Adjust Labels</a>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.LabelCategoryConfigS3Uri"> <summary> <para> <para>The S3 URI of the file, referred to as a <i>label category configuration file</i>, that defines the categories used to label the data objects.</para><para>For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html">Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs</a>. </para><para>For named entity recognition jobs, in addition to <c>"labels"</c>, you must provide worker instructions in the label category configuration file using the <c>"instructions"</c> parameter: <c>"instructions": {"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"}</c>. For details and an example, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api">Create a Named Entity Recognition Labeling Job (API) </a>.</para><para>For all other <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task types</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html">custom tasks</a>, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing <c>label_1</c>, <c>label_2</c>,<c>...</c>,<c>label_n</c> with your label categories.</para><para><c>{ </c></para><para><c>"document-version": "2018-11-28",</c></para><para><c>"labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]</c></para><para><c>}</c></para><para>Note the following about the label category configuration file:</para><ul><li><para>For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one. </para></li><li><para>Each label category must be unique, you cannot specify duplicate label categories.</para></li><li><para>If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include <c>auditLabelAttributeName</c> in the label category configuration. Use this parameter to enter the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName"><c>LabelAttributeName</c></a> of the labeling job you want to adjust or verify annotations of.</para></li></ul> </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><c>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/image-classification</c></para></li><li><para><i>Text classification</i></para><para><c>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/text-classification</c></para></li><li><para><i>Object detection</i></para><para><c>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/object-detection</c></para></li><li><para><i>Semantic Segmentation</i></para><para><c>arn:aws:sagemaker:<i>region</i>:027400017018:labeling-job-algorithm-specification/semantic-segmentation</c></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. Labeling job names must be unique within an Amazon Web Services account and region. <c>LabelingJobName</c> is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.</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>The input manifest file referenced in <c>ManifestS3Uri</c> must contain one of the following keys: <c>source-ref</c> or <c>source</c>. The value of the keys are interpreted as follows:</para><ul><li><para><c>source-ref</c>: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.</para></li><li><para><c>source</c>: The source of the object is the value. Use this value when the object is a text value.</para></li></ul><para>If you are a new user of Ground Truth, it is recommended you review <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-input-data-input-manifest.html">Use an Input Manifest File </a> in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.</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. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.</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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task types</a>, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for <c>PreHumanTaskLambdaArn</c>. For custom labeling workflows, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates-step3.html#sms-custom-templates-step3-prelambda">Pre-annotation Lambda</a>. </para><para><b>Bounding box</b> - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox</c></para></li></ul><para><b>Image classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass</c></para></li></ul><para><b>Multi-label image classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel</c></para></li></ul><para><b>Semantic segmentation</b> - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation</c></para></li></ul><para><b>Text classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass</c></para></li></ul><para><b>Multi-label text classification</b> - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel</c></para></li></ul><para><b>Named entity recognition</b> - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition</c></para></li></ul><para><b>Video Classification</b> - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass</c></para></li></ul><para><b>Video Frame Object Detection</b> - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection</c></para></li></ul><para><b>Video Frame Object Tracking</b> - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking</c></para></li></ul><para><b>3D Point Cloud Modalities</b></para><para>Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-task-types.html">3D Point Cloud Task types </a> to learn more. </para><para><b>3D Point Cloud Object Detection</b> - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection</c></para></li></ul><para><b>3D Point Cloud Object Tracking</b> - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking</c></para></li></ul><para><b>3D Point Cloud Semantic Segmentation</b> - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation</c></para></li></ul><para><b>Use the following ARNs for Label Verification and Adjustment Jobs</b></para><para>Use label verification and adjustment jobs to review and adjust labels. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html">Verify and Adjust Labels </a>.</para><para><b>Bounding box verification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox</c></para></li></ul><para><b>Bounding box adjustment</b> - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox</c></para></li></ul><para><b>Semantic segmentation verification</b> - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation</c></para></li></ul><para><b>Semantic segmentation adjustment</b> - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation</c></para></li></ul><para><b>Video Frame Object Detection Adjustment</b> - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection</c></para></li></ul><para><b>Video Frame Object Tracking Adjustment</b> - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.</para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking</c></para></li></ul><para><b>3D point cloud object detection adjustment</b> - Adjust 3D cuboids in a point cloud frame. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection</c></para></li></ul><para><b>3D point cloud object tracking adjustment</b> - Adjust 3D cuboids across a sequence of point cloud frames. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking</c></para></li></ul><para><b>3D point cloud semantic segmentation adjustment</b> - Adjust semantic segmentation masks in a 3D point cloud. </para><ul><li><para><c>arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></para></li><li><para><c>arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation</c></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.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.SnsDataSource_SnsTopicArn"> <summary> <para> <para>The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.OutputConfig_SnsTopicArn"> <summary> <para> <para>An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a <c>SnsTopicArn</c> if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.</para><para>If you provide an <c>SnsTopicArn</c> in <c>OutputConfig</c>, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here. </para><para>To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-labeling-job.html#sms-streaming-how-it-works-output-data">Receive Output Data from a Streaming Labeling Job</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMLabelingJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</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>Amazon Web Services 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. The default and maximum values for this parameter depend on the type of workforce you use.</para><ul><li><para>If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).</para></li><li><para>If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.</para></li></ul> </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>If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).</para><para>If you create a labeling job using a <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html">built-in task type</a> the maximum for this parameter depends on the task type you use:</para><ul><li><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-images.html">image</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-label-text.html">text</a> labeling jobs, the maximum is 8 hours (28,800 seconds).</para></li><li><para>For <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud.html">3D point cloud</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-video.html">video frame</a> labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.</para></li></ul> </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, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. 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 Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling. </para><para>You can only specify a <c>VolumeKmsKeyId</c> when you create a labeling job with automated data labeling enabled using the API operation <c>CreateLabelingJob</c>. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-security.html">Output Data and Storage Volume Encryption</a>.</para><para>The <c>VolumeKmsKeyId</c> can be any of the following formats:</para><ul><li><para>KMS Key ID</para><para><c>"1234abcd-12ab-34cd-56ef-1234567890ab"</c></para></li><li><para>Amazon Resource Name (ARN) of a KMS Key</para><para><c>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</c></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 SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a 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 SageMaker hosting services or run a batch transform job. </para><para> To host your model, you create an endpoint configuration with the <c>CreateEndpointConfig</c> API, and then create an endpoint with the <c>CreateEndpoint</c> API. 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 <c>CreateTransformJob</c> API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. </para><para> In the request, you also provide an IAM role that 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 Amazon Web Services 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> </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 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">SageMaker Roles</a>. </para><note><para>To be able to pass this role to SageMaker, the caller of this API must have the <c>iam:PassRole</c> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.InferenceExecutionConfig_Mode"> <summary> <para> <para>How containers in a multi-container are run. The following values are valid.</para><ul><li><para><c>SERIAL</c> - Containers run as a serial pipeline.</para></li><li><para><c>DIRECT</c> - Only the individual container that you specify is run.</para></li></ul> </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 <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> 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. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</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.NewSMModelBiasJobDefinitionCmdlet"> <summary> Creates the definition for a model bias job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ModelBiasBaselineConfig_BaseliningJobName"> <summary> <para> <para>The name of the baseline model bias job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ModelBiasAppSpecification_ConfigUri"> <summary> <para> <para>JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-bias-parameters.html">Configure bias parameters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_DataCapturedDestinationS3Uri"> <summary> <para> <para>The Amazon S3 location being used to capture the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.NetworkConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to encrypt all communications between the instances used for the monitoring jobs. Choose <c>True</c> to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.NetworkConfig_EnableNetworkIsolation"> <summary> <para> <para>Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_EndpointName"> <summary> <para> <para>An endpoint in customer's account which has enabled <c>DataCaptureConfig</c> enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ModelBiasAppSpecification_Environment"> <summary> <para> <para>Sets the environment variables in the Docker container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.Csv_Header"> <summary> <para> <para>Indicates if the CSV data has a header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ModelBiasAppSpecification_ImageUri"> <summary> <para> <para>The container image to be run by the model bias job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The ML compute instance type for the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ModelBiasJobOutputConfig_KmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.Json_Line"> <summary> <para> <para>Indicates if the file should be read as a JSON object per line. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the batch transform data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the endpoint data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum runtime allowed in seconds.</para><note><para>The <c>MaxRuntimeInSeconds</c> cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ModelBiasJobOutputConfig_MonitoringOutput"> <summary> <para> <para>Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.DatasetFormat_Parquet"> <summary> <para> <para>The Parquet dataset used in the monitoring job</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ConstraintsResource_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the constraints resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.GroundTruthS3Input_S3Uri"> <summary> <para> <para>The address of the Amazon S3 location of the ground truth labels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.BatchTransformInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.EndpointInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.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-whatURL"> Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ClusterConfig_VolumeKmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.ClusterConfig_VolumeSizeInGB"> <summary> <para> <para>The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelBiasJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelBiasJobDefinitionResponse 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.NewSMModelBiasJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelBiasJobDefinitionCmdlet.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.NewSMModelCardCmdlet"> <summary> Creates an Amazon SageMaker Model Card. <para> For information about how to use model cards, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html">Amazon SageMaker Model Card</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.Content"> <summary> <para> <para>The content of the model card. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.SecurityConfig_KmsKeyId"> <summary> <para> <para>A Key Management Service <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a> to use for encrypting a model card.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.ModelCardName"> <summary> <para> <para>The unique name of the model card.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.ModelCardStatus"> <summary> <para> <para>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</para><ul><li><para><c>Draft</c>: The model card is a work in progress.</para></li><li><para><c>PendingReview</c>: The model card is pending review.</para></li><li><para><c>Approved</c>: The model card is approved.</para></li><li><para><c>Archived</c>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.Tag"> <summary> <para> <para>Key-value pairs used to manage metadata for model cards.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelCardArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelCardResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelCardResponse 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.NewSMModelCardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardCmdlet.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.NewSMModelCardExportJobCmdlet"> <summary> Creates an Amazon SageMaker Model Card export job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardExportJobCmdlet.ModelCardExportJobName"> <summary> <para> <para>The name of the model card export job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardExportJobCmdlet.ModelCardName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the model card to export.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardExportJobCmdlet.ModelCardVersion"> <summary> <para> <para>The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardExportJobCmdlet.OutputConfig_S3OutputPath"> <summary> <para> <para>The Amazon S3 output path to export your model card PDF.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardExportJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelCardExportJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelCardExportJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelCardExportJobResponse 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.NewSMModelCardExportJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelCardExportJobCmdlet.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.NewSMModelExplainabilityJobDefinitionCmdlet"> <summary> Creates the definition for a model explainability job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ModelExplainabilityBaselineConfig_BaseliningJobName"> <summary> <para> <para>The name of the baseline model explainability job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ModelExplainabilityAppSpecification_ConfigUri"> <summary> <para> <para>JSON formatted Amazon S3 file that defines explainability parameters. For more information on this JSON configuration file, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/clarify-config-json-monitor-model-explainability-parameters.html">Configure model explainability parameters</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_DataCapturedDestinationS3Uri"> <summary> <para> <para>The Amazon S3 location being used to capture the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.NetworkConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to encrypt all communications between the instances used for the monitoring jobs. Choose <c>True</c> to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.NetworkConfig_EnableNetworkIsolation"> <summary> <para> <para>Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_EndpointName"> <summary> <para> <para>An endpoint in customer's account which has enabled <c>DataCaptureConfig</c> enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ModelExplainabilityAppSpecification_Environment"> <summary> <para> <para>Sets the environment variables in the Docker container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.Csv_Header"> <summary> <para> <para>Indicates if the CSV data has a header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ModelExplainabilityAppSpecification_ImageUri"> <summary> <para> <para>The container image to be run by the model explainability job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The ML compute instance type for the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para> The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ModelExplainabilityJobOutputConfig_KmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.Json_Line"> <summary> <para> <para>Indicates if the file should be read as a JSON object per line. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the batch transform data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the endpoint data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum runtime allowed in seconds.</para><note><para>The <c>MaxRuntimeInSeconds</c> cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ModelExplainabilityJobOutputConfig_MonitoringOutput"> <summary> <para> <para>Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.DatasetFormat_Parquet"> <summary> <para> <para>The Parquet dataset used in the monitoring job</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ConstraintsResource_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the constraints resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.BatchTransformInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.EndpointInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.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-whatURL"> Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ClusterConfig_VolumeKmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.ClusterConfig_VolumeSizeInGB"> <summary> <para> <para>The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelExplainabilityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelExplainabilityJobDefinitionResponse 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.NewSMModelExplainabilityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelExplainabilityJobDefinitionCmdlet.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 SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in 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 <c>InferenceSpecification</c>. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for <c>SourceAlgorithmSpecification</c>. </para><note><para> There are two types of model packages: </para><ul><li><para> Versioned - a model that is part of a model group in the model registry. </para></li><li><para> Unversioned - a model package that is not part of a model group. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.AdditionalInferenceSpecification"> <summary> <para> <para>An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.CertifyForMarketplace"> <summary> <para> <para>Whether to certify the model package for listing on Amazon Web Services Marketplace.</para><para>This parameter is optional for unversioned models, and does not apply to versioned models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.MetadataProperties_CommitId"> <summary> <para> <para>The commit ID.</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.DriftCheckBaselines_Bias_ConfigFile_ContentDigest"> <summary> <para> <para>The digest of the file source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PostTrainingConstraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PreTrainingConstraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Explainability_ConfigFile_ContentDigest"> <summary> <para> <para>The digest of the file source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Explainability_Constraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelDataQuality_Constraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelDataQuality_Statistics_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelQuality_Constraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelQuality_Statistics_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PostTrainingReport_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PreTrainingReport_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_Bias_Report_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_Explainability_Report_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelDataQuality_Constraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelDataQuality_Statistics_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelQuality_Constraints_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelQuality_Statistics_ContentDigest"> <summary> <para> <para>The hash key used for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Bias_ConfigFile_ContentType"> <summary> <para> <para>The type of content stored in the file source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PostTrainingConstraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PreTrainingConstraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Explainability_ConfigFile_ContentType"> <summary> <para> <para>The type of content stored in the file source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Explainability_Constraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelDataQuality_Constraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelDataQuality_Statistics_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelQuality_Constraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelQuality_Statistics_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PostTrainingReport_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PreTrainingReport_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_Bias_Report_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_Explainability_Report_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelDataQuality_Constraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelDataQuality_Statistics_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelQuality_Constraints_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelQuality_Statistics_ContentType"> <summary> <para> <para>The metric source content type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.CustomerMetadataProperty"> <summary> <para> <para>The metadata properties associated with the model package versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.Domain"> <summary> <para> <para>The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.MetadataProperties_GeneratedBy"> <summary> <para> <para>The entity this entity was generated by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelApprovalStatus"> <summary> <para> <para>Whether the model is approved for deployment.</para><para>This parameter is optional for versioned models, and does not apply to unversioned models.</para><para>For versioned models, the value of this parameter must be set to <c>Approved</c> to deploy the model.</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.ModelPackageGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.</para><para>This parameter is required for versioned models, and does not apply to unversioned models.</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>This parameter is required for unversioned models. It is not applicable to versioned models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.MetadataProperties_ProjectId"> <summary> <para> <para>The project ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.MetadataProperties_Repository"> <summary> <para> <para>The repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Bias_ConfigFile_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the file source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PostTrainingConstraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PreTrainingConstraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Explainability_ConfigFile_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the file source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_Explainability_Constraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelDataQuality_Constraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelDataQuality_Statistics_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelQuality_Constraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.DriftCheckBaselines_ModelQuality_Statistics_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PostTrainingReport_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.PreTrainingReport_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_Bias_Report_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_Explainability_Report_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelDataQuality_Constraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelDataQuality_Statistics_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelQuality_Constraints_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ModelMetrics_ModelQuality_Statistics_S3Uri"> <summary> <para> <para>The S3 URI for the metrics source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.SamplePayloadUrl"> <summary> <para> <para>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax">InvokeEndpoint</a> call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.SkipModelValidation"> <summary> <para> <para>Indicates if you want to skip model validation.</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.SourceUri"> <summary> <para> <para>The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.</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>This parameter is required for unversioned models, and optional for versioned models.</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>This parameter is required for unversioned models, and optional for versioned models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.Tag"> <summary> <para> <para>A list of key value pairs associated with the model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</para><para>If you supply <c>ModelPackageGroupName</c>, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a <c>tag</c> argument. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.Task"> <summary> <para> <para>The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: <c>"IMAGE_CLASSIFICATION"</c> | <c>"OBJECT_DETECTION"</c> | <c>"TEXT_GENERATION"</c> |<c>"IMAGE_SEGMENTATION"</c> | <c>"FILL_MASK"</c> | <c>"CLASSIFICATION"</c> | <c>"REGRESSION"</c> | <c>"OTHER"</c>.</para><para>Specify "OTHER" if none of the tasks listed fit your use case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageCmdlet.ValidationSpecification_ValidationProfile"> <summary> <para> <para>An array of <c>ModelPackageValidationProfile</c> objects, each of which specifies a batch transform job that 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.ClientToken"> <summary> <para> <para>A unique token that guarantees that the call to this API is idempotent.</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.NewSMModelPackageGroupCmdlet"> <summary> Creates a model group. A model group contains a group of model versions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageGroupCmdlet.ModelPackageGroupDescription"> <summary> <para> <para>A description for the model group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageGroupCmdlet.ModelPackageGroupName"> <summary> <para> <para>The name of the model group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageGroupCmdlet.Tag"> <summary> <para> <para>A list of key value pairs associated with the model group. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelPackageGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelPackageGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelPackageGroupResponse 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.NewSMModelPackageGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelPackageGroupCmdlet.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.NewSMModelQualityJobDefinitionCmdlet"> <summary> Creates a definition for a job that monitors model quality and drift. For information about model monitor, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityBaselineConfig_BaseliningJobName"> <summary> <para> <para>The name of the job that performs baselining for the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_ContainerArgument"> <summary> <para> <para>An array of arguments for the container used to run the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_ContainerEntrypoint"> <summary> <para> <para>Specifies the entrypoint for a container that the monitoring job runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_DataCapturedDestinationS3Uri"> <summary> <para> <para>The Amazon S3 location being used to capture the data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.NetworkConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to encrypt all communications between the instances used for the monitoring jobs. Choose <c>True</c> to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.NetworkConfig_EnableNetworkIsolation"> <summary> <para> <para>Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_EndpointName"> <summary> <para> <para>An endpoint in customer's account which has enabled <c>DataCaptureConfig</c> enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs subtract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_EndTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_Environment"> <summary> <para> <para>Sets the environment variables in the container that the monitoring job runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_ExcludeFeaturesAttribute"> <summary> <para> <para>The attributes of the input data to exclude from the analysis.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_FeaturesAttribute"> <summary> <para> <para>The attributes of the input data that are the input features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.Csv_Header"> <summary> <para> <para>Indicates if the CSV data has a header.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_ImageUri"> <summary> <para> <para>The address of the container image that the monitoring job runs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_InferenceAttribute"> <summary> <para> <para>The attribute of the input data that represents the ground truth label.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The ML compute instance type for the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the monitoring job definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityJobOutputConfig_KmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.Json_Line"> <summary> <para> <para>Indicates if the file should be read as a JSON object per line. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the batch transform data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_LocalPath"> <summary> <para> <para>Path to the filesystem where the endpoint data is available to the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum runtime allowed in seconds.</para><note><para>The <c>MaxRuntimeInSeconds</c> cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityJobOutputConfig_MonitoringOutput"> <summary> <para> <para>Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.DatasetFormat_Parquet"> <summary> <para> <para>The Parquet dataset used in the monitoring job</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_PostAnalyticsProcessorSourceUri"> <summary> <para> <para>An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_ProbabilityAttribute"> <summary> <para> <para>In a classification problem, the attribute that represents the class probability.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_ProbabilityThresholdAttribute"> <summary> <para> <para>The threshold for the class probability to be evaluated as a positive result.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_ProblemType"> <summary> <para> <para>The machine learning problem type of the model that the monitoring job monitors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ModelQualityAppSpecification_RecordPreprocessorSourceUri"> <summary> <para> <para>An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flattened JSON so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_S3DataDistributionType"> <summary> <para> <para>Whether input data distributed in Amazon S3 is fully replicated or sharded by an Amazon S3 key. Defaults to <c>FullyReplicated</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_S3InputMode"> <summary> <para> <para>Whether the <c>Pipe</c> or <c>File</c> is used as the input mode for transferring data for the monitoring job. <c>Pipe</c> mode is recommended for large datasets. <c>File</c> mode is useful for small files that fit in memory. Defaults to <c>File</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ConstraintsResource_S3Uri"> <summary> <para> <para>The Amazon S3 URI for the constraints resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.GroundTruthS3Input_S3Uri"> <summary> <para> <para>The address of the Amazon S3 location of the ground truth labels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.BatchTransformInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.EndpointInput_StartTimeOffset"> <summary> <para> <para>If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-model-quality-schedule.html">Schedule Model Quality Monitoring Jobs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.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-whatURL"> Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ClusterConfig_VolumeKmsKeyId"> <summary> <para> <para>The Key Management Service (KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.ClusterConfig_VolumeSizeInGB"> <summary> <para> <para>The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobDefinitionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateModelQualityJobDefinitionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateModelQualityJobDefinitionResponse 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.NewSMModelQualityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMModelQualityJobDefinitionCmdlet.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.NewSMMonitoringScheduleCmdlet"> <summary> Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMMonitoringScheduleCmdlet.MonitoringScheduleConfig"> <summary> <para> <para>The configuration object that specifies the monitoring schedule and defines the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMMonitoringScheduleCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMMonitoringScheduleCmdlet.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-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMMonitoringScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringScheduleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateMonitoringScheduleResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateMonitoringScheduleResponse 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.NewSMMonitoringScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMMonitoringScheduleCmdlet.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 SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. <para> In a <c>CreateNotebookInstance</c> request, specify the type of ML compute instance that you want to run. 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> SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework. </para><para> After receiving the request, SageMaker does the following: </para><ol><li><para> Creates a network interface in the SageMaker VPC. </para></li><li><para> (Option) If you specified <c>SubnetId</c>, 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, 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 SageMaker VPC. If you specified <c>SubnetId</c> of your VPC, 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, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. </para><para> After 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 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="https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html">Amazon Web Services 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 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">Amazon Web Services 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 SageMaker Notebook Instances</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.DirectInternetAccess"> <summary> <para> <para>Sets whether SageMaker provides internet access to the notebook instance. If you set this to <c>Disabled</c> this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you 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 <c>Disabled</c> only if you set a value for the <c>SubnetId</c> 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 Amazon Web Services Key Management Service key that 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>Amazon Web Services 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.InstanceMetadataServiceConfiguration_MinimumInstanceMetadataServiceVersion"> <summary> <para> <para>Indicates the minimum IMDS version that the notebook instance supports. When passed as part of <c>CreateNotebookInstance</c>, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of <c>UpdateNotebookInstance</c>, there is no default.</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.PlatformIdentifier"> <summary> <para> <para>The platform identifier of the notebook instance runtime environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMNotebookInstanceCmdlet.RoleArn"> <summary> <para> <para> When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html">SageMaker Roles</a>. </para><note><para>To be able to pass this role to SageMaker, the caller of this API must have the <c>iam:PassRole</c> 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 <c>Enabled</c>.</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>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</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 <c>$PATH</c> environment variable that is available to both scripts is <c>/sbin:bin:/usr/sbin:/usr/bin</c>. </para><para> View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group <c>/aws/sagemaker/NotebookInstances</c> in log stream <c>[notebook-instance-name]/[LifecycleConfigHook]</c>. </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.NewSMPipelineCmdlet"> <summary> Creates a pipeline using a JSON pipeline definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineDefinitionS3Location_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.ParallelismConfiguration_MaxParallelExecutionStep"> <summary> <para> <para>The max number of steps that can be executed in parallel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineDefinitionS3Location_ObjectKey"> <summary> <para> <para>The object key (or key name) uniquely identifies the object in an S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineDefinition"> <summary> <para> <para>The <a href="https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/">JSON pipeline definition</a> of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineDescription"> <summary> <para> <para>A description of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineDisplayName"> <summary> <para> <para>The display name of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the created pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.PipelineDefinitionS3Location_VersionId"> <summary> <para> <para>Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreatePipelineResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreatePipelineResponse 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.NewSMPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPipelineCmdlet.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.NewSMPresignedDomainUrlCmdlet"> <summary> Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM. <para> The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app. </para><para> You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html">Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint</a> . </para><note><para> The URL that you get from a call to <c>CreatePresignedDomainUrl</c> has a default timeout of 5 minutes. You can configure this value using <c>ExpiresInSeconds</c>. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.ExpiresInSecond"> <summary> <para> <para>The number of seconds until the pre-signed URL expires. This value defaults to 300.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.LandingUri"> <summary> <para> <para>The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:</para><ul><li><para><c>studio::relative/path</c>: Directs users to the relative path in Studio.</para></li><li><para><c>app:JupyterServer:relative/path</c>: Directs users to the relative path in the Studio Classic application.</para></li><li><para><c>app:JupyterLab:relative/path</c>: Directs users to the relative path in the JupyterLab application.</para></li><li><para><c>app:RStudioServerPro:relative/path</c>: Directs users to the relative path in the RStudio application.</para></li><li><para><c>app:CodeEditor:relative/path</c>: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.</para></li><li><para><c>app:Canvas:relative/path</c>: Directs users to the relative path in the Canvas application.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.SessionExpirationDurationInSecond"> <summary> <para> <para>The session expiration duration in seconds. This value defaults to 43200.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.SpaceName"> <summary> <para> <para>The name of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.UserProfileName"> <summary> <para> <para>The name of the UserProfile to sign-in as.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.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.CreatePresignedDomainUrlResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreatePresignedDomainUrlResponse 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.NewSMPresignedDomainUrlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMPresignedDomainUrlCmdlet.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 SageMaker console, when you choose <c>Open</c> next to a notebook instance, 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> The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance. </para><para> 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 <c>NotIpAddress</c> condition operator and the <c>aws:SourceIP</c> 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/security_iam_id-based-policy-examples.html#nbi-ip-filter">Limit Access to a Notebook Instance by IP Address</a>. </para><note><para> The URL that you get from a call to <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html">CreatePresignedNotebookInstanceUrl</a> is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services 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.NewSMProcessingJobCmdlet"> <summary> Creates a processing job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.AppSpecification_ContainerArgument"> <summary> <para> <para>The arguments for a container used to run a processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.AppSpecification_ContainerEntrypoint"> <summary> <para> <para>The entrypoint for a container used to run a processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.NetworkConfig_EnableInterContainerTrafficEncryption"> <summary> <para> <para>Whether to encrypt all communications between distributed processing jobs. Choose <c>True</c> to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.NetworkConfig_EnableNetworkIsolation"> <summary> <para> <para>Whether to allow inbound and outbound network calls to and from the containers used for the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.Environment"> <summary> <para> <para>The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ExperimentConfig_ExperimentName"> <summary> <para> <para>The name of an existing experiment to associate with the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.AppSpecification_ImageUri"> <summary> <para> <para>The container image to be run by the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ClusterConfig_InstanceCount"> <summary> <para> <para>The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ClusterConfig_InstanceType"> <summary> <para> <para>The ML compute instance type for the processing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ProcessingOutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. <c>KmsKeyId</c> can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The <c>KmsKeyId</c> is applied to all outputs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>Specifies the maximum runtime in seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ProcessingOutputConfig_Output"> <summary> <para> <para>An array of outputs configuring the data to upload from the processing container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ProcessingInput"> <summary> <para> <para>An array of inputs configuring the data to download into the processing container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ProcessingJobName"> <summary> <para> <para> The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ExperimentConfig_RunName"> <summary> <para> <para>The name of the experiment run to associate with the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>The VPC security group IDs, in the form <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.VpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.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-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ExperimentConfig_TrialComponentDisplayName"> <summary> <para> <para>The display name for the trial component. If this key isn't specified, the display name is the trial component name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ExperimentConfig_TrialName"> <summary> <para> <para>The name of an existing trial to associate the trial component with. If not specified, a new trial is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ClusterConfig_VolumeKmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job. </para><note><para>Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a <c>VolumeKmsKeyId</c> when using an instance type with local storage.</para><para>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</para><para>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD Instance Store Volumes</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.ClusterConfig_VolumeSizeInGB"> <summary> <para> <para>The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.</para><note><para>Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a <c>VolumeSizeInGB</c> greater than the total size of the local instance storage.</para><para>For a list of instance types that support local instance storage, including the total size per instance type, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProcessingJobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateProcessingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateProcessingJobResponse 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.NewSMProcessingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProcessingJobName parameter. The -PassThru parameter is deprecated, use -Select '^ProcessingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProcessingJobCmdlet.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.NewSMProjectCmdlet"> <summary> Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.ServiceCatalogProvisioningDetails_PathId"> <summary> <para> <para>The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.ServiceCatalogProvisioningDetails_ProductId"> <summary> <para> <para>The ID of the product to provision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.ProjectDescription"> <summary> <para> <para>A description for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.ServiceCatalogProvisioningDetails_ProvisioningArtifactId"> <summary> <para> <para>The ID of the provisioning artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.ServiceCatalogProvisioningDetails_ProvisioningParameter"> <summary> <para> <para>A list of key value pairs that you specify when you provision a product.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.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.CreateProjectResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateProjectResponse 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.NewSMProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMProjectCmdlet.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.NewSMSpaceCmdlet"> <summary> Creates a space used for real time collaboration in a domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_AppType"> <summary> <para> <para>The type of app created within the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.JupyterLabAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.JupyterServerAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_CustomFileSystem"> <summary> <para> <para>A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.KernelGatewayAppSettings_CustomImage"> <summary> <para> <para>A list of custom SageMaker images that are configured to run as a KernelGateway app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.DomainId"> <summary> <para> <para>The ID of the associated domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.EbsStorageSettings_EbsVolumeSizeInGb"> <summary> <para> <para>The size of an EBS storage volume for a space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.JupyterServerAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the <c>DefaultResourceSpec</c> parameter is also required.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.KernelGatewayAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.OwnershipSettings_OwnerUserProfileName"> <summary> <para> <para>The user profile who is the owner of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceSharingSettings_SharingType"> <summary> <para> <para>Specifies the sharing type of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceDisplayName"> <summary> <para> <para>The name of the space that appears in the SageMaker Studio UI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.SpaceName"> <summary> <para> <para>The name of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.Tag"> <summary> <para> <para>Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the <c>Search</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SpaceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateSpaceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateSpaceResponse 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.NewSMSpaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpaceName parameter. The -PassThru parameter is deprecated, use -Select '^SpaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMSpaceCmdlet.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.NewSMStudioLifecycleConfigCmdlet"> <summary> Creates a new Amazon SageMaker Studio Lifecycle Configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMStudioLifecycleConfigCmdlet.StudioLifecycleConfigAppType"> <summary> <para> <para>The App type that the Lifecycle Configuration is attached to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMStudioLifecycleConfigCmdlet.StudioLifecycleConfigContent"> <summary> <para> <para>The content of your Amazon SageMaker Studio Lifecycle Configuration script. This content must be base64 encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMStudioLifecycleConfigCmdlet.StudioLifecycleConfigName"> <summary> <para> <para>The name of the Amazon SageMaker Studio Lifecycle Configuration to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMStudioLifecycleConfigCmdlet.Tag"> <summary> <para> <para>Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMStudioLifecycleConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioLifecycleConfigArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateStudioLifecycleConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateStudioLifecycleConfigResponse 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.NewSMStudioLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^StudioLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMStudioLifecycleConfigCmdlet.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, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. <para> If you choose to host your model using 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 SageMaker, provided that you know how to use them for inference. </para><para> In the request body, you provide the following: </para><ul><li><para><c>AlgorithmSpecification</c> - Identifies the training algorithm to use. </para></li><li><para><c>HyperParameters</c> - 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 SageMaker, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html">Algorithms</a>. </para><important><para> Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error. </para></important></li><li><para><c>InputDataConfig</c> - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored. </para></li><li><para><c>OutputDataConfig</c> - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training. </para></li><li><para><c>ResourceConfig</c> - 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><c>EnableManagedSpotTraining</c> - 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><c>RoleArn</c> - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training. </para></li><li><para><c>StoppingCondition</c> - To help cap training costs, use <c>MaxRuntimeInSeconds</c> to set a time limit for training. Use <c>MaxWaitTimeInSeconds</c> to specify how long a managed spot training job has to complete. </para></li><li><para><c>Environment</c> - The environment variables to set in the Docker container. </para></li><li><para><c>RetryStrategy</c> - The number of times to retry the job when the job fails due to an <c>InternalServerError</c>. </para></li></ul><para> For more information about 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 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.DebugHookConfig_CollectionConfiguration"> <summary> <para> <para>Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the <c>CollectionConfiguration</c> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.DebugRuleConfiguration"> <summary> <para> <para>Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ProfilerConfig_DisableProfiler"> <summary> <para> <para>Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to <c>True</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.InfraCheckConfig_EnableInfraCheck"> <summary> <para> <para>Enables an infrastructure health check.</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 <c>True</c>. 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 <c>True</c>. 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, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.RemoteDebugConfig_EnableRemoteDebug"> <summary> <para> <para>If set to True, enables remote debugging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.SessionChainingConfig_EnableSessionTagChaining"> <summary> <para> <para>Set to <c>True</c> to allow SageMaker to extract session tags from a training job creation role and reuse these tags when assuming the training job execution role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.Environment"> <summary> <para> <para>The environment variables to set in the Docker container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ExperimentConfig_ExperimentName"> <summary> <para> <para>The name of an existing experiment to associate with the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.DebugHookConfig_HookParameter"> <summary> <para> <para>Configuration information for the Amazon SageMaker Debugger hook parameters.</para> </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 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 <c>Length Constraint</c>. </para><important><para>Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.InputDataConfig"> <summary> <para> <para>An array of <c>Channel</c> objects. Each channel is a named input source. <c>InputDataConfig</c> 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, <c>training_data</c> and <c>validation_data</c>. 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, 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 are available as input streams. They do not need to be downloaded.</para><para>Your input must be in the same Amazon Web Services region as your training job.</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 <c>/opt/ml/checkpoints/</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.DebugHookConfig_LocalPath"> <summary> <para> <para>Path to local storage location for metrics and tensors. Defaults to <c>/opt/ml/output/tensors/</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.TensorBoardOutputConfig_LocalPath"> <summary> <para> <para>Path to local storage location for tensorBoard output. Defaults to <c>/opt/ml/output/tensorboard</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.RetryStrategy_MaximumRetryAttempt"> <summary> <para> <para>The number of times to retry the job. When the job is retried, it's <c>SecondaryStatus</c> is changed to <c>STARTING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.StoppingCondition_MaxPendingTimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that a training or compilation job can be pending before it is stopped.</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 a training or compilation job can run before it is stopped.</para><para>For compilation jobs, if the job does not complete during this time, a <c>TimeOut</c> error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.</para><para>For all other jobs, if the job does not complete during this time, SageMaker ends the job. When <c>RetryStrategy</c> is specified in the job request, <c>MaxRuntimeInSeconds</c> specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.</para><para>The maximum time that a <c>TrainingJob</c> can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 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, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than <c>MaxRuntimeInSeconds</c>. If the job does not complete during this time, SageMaker ends the job.</para><para>When <c>RetryStrategy</c> is specified in the job request, <c>MaxWaitTimeInSeconds</c> specifies the maximum time for all of the attempts in total, not each individual attempt.</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. SageMaker creates subfolders for the artifacts. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ProfilerRuleConfiguration"> <summary> <para> <para>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ProfilerConfig_ProfilingIntervalInMillisecond"> <summary> <para> <para>A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ProfilerConfig_ProfilingParameter"> <summary> <para> <para>Configuration information for capturing framework metrics. Available key strings for different profiling options are <c>DetailedProfilingConfig</c>, <c>PythonProfilingConfig</c>, and <c>DataLoaderProfilingConfig</c>. The following codes are configuration structures for the <c>ProfilingParameters</c> parameter. To learn more about how to configure the <c>ProfilingParameters</c> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>. </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 SageMaker to use the ML storage volume to store the training data, choose <c>File</c> as the <c>TrainingInputMode</c> 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 SageMaker can assume to perform tasks on your behalf. </para><para>During model training, 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">SageMaker Roles</a>. </para><note><para>To be able to pass this role to SageMaker, the caller of this API must have the <c>iam:PassRole</c> permission.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ExperimentConfig_RunName"> <summary> <para> <para>The name of the experiment run to associate with the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.DebugHookConfig_S3OutputPath"> <summary> <para> <para>Path to Amazon S3 storage location for metrics and tensors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ProfilerConfig_S3OutputPath"> <summary> <para> <para>Path to Amazon S3 storage location for system and framework metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.TensorBoardOutputConfig_S3OutputPath"> <summary> <para> <para>Path to Amazon S3 storage location for TensorBoard output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.CheckpointConfig_S3Uri"> <summary> <para> <para>Identifies the S3 path where you want SageMaker to store checkpoints. For example, <c>s3://bucket-name/key-name-prefix</c>.</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 <c>sg-xxxxxxxx</c>. Specify the security groups for the VPC that is specified in the <c>Subnets</c> 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. For information about the availability of specific instance types, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/instance-types-az.html">Supported Instance Types and Availability Zones</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</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 Amazon Web Services Region in an Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ExperimentConfig_TrialComponentDisplayName"> <summary> <para> <para>The display name for the trial component. If this key isn't specified, the display name is the trial component name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrainingJobCmdlet.ExperimentConfig_TrialName"> <summary> <para> <para>The name of an existing trial to associate the trial component with. If not specified, a new trial is created.</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><c>TransformJobName</c> - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. </para></li><li><para><c>ModelName</c> - Identifies the model to use. <c>ModelName</c> must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html">CreateModel</a>. </para></li><li><para><c>TransformInput</c> - Describes the dataset to be transformed and the Amazon S3 location where it is stored. </para></li><li><para><c>TransformOutput</c> - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. </para></li><li><para><c>TransformResources</c> - Identifies the ML compute instances for the transform job. </para></li></ul><para> For more information about how batch transformation works, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html">Batch Transform</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 <c>None</c>. To add a newline character at the end of every transformed record, specify <c>Line</c>.</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 the <c>SplitType</c> property to <c>Line</c>, <c>RecordIO</c>, or <c>TFRecord</c>.</para><para>To use only one record when making an HTTP invocation request to a container, set <c>BatchStrategy</c> to <c>SingleRecord</c> and <c>SplitType</c> to <c>Line</c>.</para><para>To fit as many records in a mini-batch as can fit within the <c>MaxPayloadInMB</c> limit, set <c>BatchStrategy</c> to <c>MultiRecord</c> and <c>SplitType</c> to <c>Line</c>.</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 <c>None</c>.</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.DataCaptureConfig_DestinationS3Uri"> <summary> <para> <para>The Amazon S3 location being used to capture the data.</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.ExperimentConfig_ExperimentName"> <summary> <para> <para>The name of an existing experiment to associate with the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.DataCaptureConfig_GenerateInferenceId"> <summary> <para> <para>Flag that indicates whether to append inference id to the output.</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 <c>InputFilter</c> parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value <c>$</c>.</para><para>Examples: <c>"$"</c>, <c>"$[1:]"</c>, <c>"$.features"</c></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. The default value is <c>1</c>, and the maximum is <c>100</c>. For distributed transform jobs, specify a value greater than <c>1</c>.</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 <c>ml.m5.large</c>instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.ModelClientConfig_InvocationsMaxRetry"> <summary> <para> <para>The maximum number of retries when invocation requests are failing. The default value is 3.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.ModelClientConfig_InvocationsTimeoutInSecond"> <summary> <para> <para>The timeout value in seconds for an invocation request. The default value is 600.</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 <c>None</c> and <c>Input</c>. The default value is <c>None</c>, 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 <c>JoinSource</c> to <c>Input</c>. You can specify <c>OutputFilter</c> as an additional filter to select a portion of the joined dataset and store it in the output file.</para><para>For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called <c>SageMakerOutput</c>. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the <c>SageMakerInput</c> key and the results are stored in <c>SageMakerOutput</c>.</para><para>For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.</para><para>For information on how joining in applied, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#batch-transform-data-processing-workflow">Workflow for Associating Inferences with Input Records</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.DataCaptureConfig_KmsKeyId"> <summary> <para> <para>The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.</para><para>The KmsKeyId can be any of the following formats: </para><ul><li><para>Key ID: <c>1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Key ARN: <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Alias name: <c>alias/ExampleAlias</c></para></li><li><para>Alias name ARN: <c>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformOutput_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The <c>KmsKeyId</c> can be any of the following formats: </para><ul><li><para>Key ID: <c>1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Key ARN: <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Alias name: <c>alias/ExampleAlias</c></para></li><li><para>Alias name ARN: <c>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</c></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 <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html">CreateModel</a> request. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Using Key Policies in Amazon Web Services KMS</a> in the <i>Amazon Web Services 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 <c>MaxConcurrentTransforms</c> is set to <c>0</c> or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is <c>1</c>. 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 <c>MaxConcurrentTransforms</c>.</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 <c>MaxPayloadInMB</c> 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 <c>6</c> MB. </para><para>The value of <c>MaxPayloadInMB</c> cannot be greater than 100 MB. If you specify the <c>MaxConcurrentTransforms</c> parameter, the value of <c>(MaxConcurrentTransforms * MaxPayloadInMB)</c> also cannot exceed 100 MB.</para><para>For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to <c>0</c>. 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. <c>ModelName</c> must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services 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 SageMaker to store the entire input dataset in the output file, leave the default value, <c>$</c>. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.</para><para>Examples: <c>"$"</c>, <c>"$[0,5:]"</c>, <c>"$['id','SageMakerOutput']"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.ExperimentConfig_RunName"> <summary> <para> <para>The name of the experiment run to associate with the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.S3DataSource_S3DataType"> <summary> <para> <para>If you choose <c>S3Prefix</c>, <c>S3Uri</c> identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform. </para><para>If you choose <c>ManifestFile</c>, <c>S3Uri</c> 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: <c>ManifestFile</c>, <c>S3Prefix</c></para><para>The following value is not compatible: <c>AugmentedManifestFile</c></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, <c>s3://bucket-name/key-name-prefix</c>.</para><para>For every S3 object used as input for the transform job, batch transform stores the transformed data with an .<c>out</c> suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at <c>s3://bucket-name/input-name-prefix/dataset01/data.csv</c>, batch transform stores the transformed data at <c>s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out</c>. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .<c>out</c> 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 <c>S3DataType</c>, identifies either a key name prefix or a manifest. For example:</para><ul><li><para> A key name prefix might look like this: <c>s3://bucketname/exampleprefix/</c>. </para></li><li><para> A manifest might look like this: <c>s3://bucketname/example.manifest</c></para><para> The manifest is an S3 object which is a JSON file with the following format: </para><para><c>[ {"prefix": "s3://customer_bucket/some/prefix/"},</c></para><para><c>"relative/path/to/custdata-1",</c></para><para><c>"relative/path/custdata-2",</c></para><para><c>...</c></para><para><c>"relative/path/custdata-N"</c></para><para><c>]</c></para><para> The preceding JSON matches the following <c>S3Uris</c>: </para><para><c>s3://customer_bucket/some/prefix/relative/path/to/custdata-1</c></para><para><c>s3://customer_bucket/some/prefix/relative/path/custdata-2</c></para><para><c>...</c></para><para><c>s3://customer_bucket/some/prefix/relative/path/custdata-N</c></para><para> The complete set of <c>S3Uris</c> in this manifest constitutes the input data for the channel for this datasource. The object that each <c>S3Uris</c> 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 <c>SplitType</c> is <c>None</c>, 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 <c>Line</c> to split records on a newline character boundary. <c>SplitType</c> also supports a number of record-oriented binary data formats. Currently, the supported record formats are:</para><ul><li><para>RecordIO</para></li><li><para>TFRecord</para></li></ul><para>When splitting is enabled, the size of a mini-batch depends on the values of the <c>BatchStrategy</c> and <c>MaxPayloadInMB</c> parameters. When the value of <c>BatchStrategy</c> is <c>MultiRecord</c>, Amazon SageMaker sends the maximum number of records in each request, up to the <c>MaxPayloadInMB</c> limit. If the value of <c>BatchStrategy</c> is <c>SingleRecord</c>, 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 <c>BatchStrategy</c> is set to <c>SingleRecord</c>. Padding is not removed if the value of <c>BatchStrategy</c> is set to <c>MultiRecord</c>.</para><para>For more information about <c>RecordIO</c>, see <a href="https://mxnet.apache.org/api/faq/recordio">Create a Dataset Using RecordIO</a> in the MXNet documentation. For more information about <c>TFRecord</c>, see <a href="https://www.tensorflow.org/guide/data#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>Amazon Web Services 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 Amazon Web Services Region in an Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.ExperimentConfig_TrialComponentDisplayName"> <summary> <para> <para>The display name for the trial component. If this key isn't specified, the display name is the trial component name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.ExperimentConfig_TrialName"> <summary> <para> <para>The name of an existing trial to associate the trial component with. If not specified, a new trial is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTransformJobCmdlet.TransformResources_VolumeKmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.</para><note><para>Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a <c>VolumeKmsKeyId</c> when using an instance type with local storage.</para><para>For a list of instance types that support local instance storage, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes">Instance Store Volumes</a>.</para><para>For more information about local instance storage encryption, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html">SSD Instance Store Volumes</a>.</para></note><para> The <c>VolumeKmsKeyId</c> can be any of the following formats:</para><ul><li><para>Key ID: <c>1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Key ARN: <c>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</c></para></li><li><para>Alias name: <c>alias/ExampleAlias</c></para></li><li><para>Alias name ARN: <c>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</c></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.NewSMTrialCmdlet"> <summary> Creates an SageMaker <i>trial</i>. A trial is a set of steps called <i>trial components</i> that produce a machine learning model. A trial is part of a single SageMaker <i>experiment</i>. <para> When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. </para><para> You can add tags to a trial and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for the tags. </para><para> To get a list of all your trials, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API. To view a trial's properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html">DescribeTrial</a> API. To create a trial component, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> API. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.MetadataProperties_CommitId"> <summary> <para> <para>The commit ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.DisplayName"> <summary> <para> <para>The name of the trial as displayed. The name doesn't need to be unique. If <c>DisplayName</c> isn't specified, <c>TrialName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.ExperimentName"> <summary> <para> <para>The name of the experiment to associate the trial with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.MetadataProperties_GeneratedBy"> <summary> <para> <para>The entity this entity was generated by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.MetadataProperties_ProjectId"> <summary> <para> <para>The project ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.MetadataProperties_Repository"> <summary> <para> <para>The repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.TrialName"> <summary> <para> <para>The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateTrialResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateTrialResponse 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.NewSMTrialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialName parameter. The -PassThru parameter is deprecated, use -Select '^TrialName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialCmdlet.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.NewSMTrialComponentCmdlet"> <summary> Creates a <i>trial component</i>, which is a stage of a machine learning <i>trial</i>. A trial is composed of one or more trial components. A trial component can be used in multiple trials. <para> Trial components include pre-processing jobs, training jobs, and batch transform jobs. </para><para> When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. </para><para> You can add tags to a trial component and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for the tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.MetadataProperties_CommitId"> <summary> <para> <para>The commit ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.DisplayName"> <summary> <para> <para>The name of the component as displayed. The name doesn't need to be unique. If <c>DisplayName</c> isn't specified, <c>TrialComponentName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.EndTime"> <summary> <para> <para>When the component ended.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.MetadataProperties_GeneratedBy"> <summary> <para> <para>The entity this entity was generated by.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.InputArtifact"> <summary> <para> <para>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.Status_Message"> <summary> <para> <para>If the component failed, a message describing why.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.OutputArtifact"> <summary> <para> <para>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.Parameter"> <summary> <para> <para>The hyperparameters for the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.Status_PrimaryStatus"> <summary> <para> <para>The status of the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.MetadataProperties_ProjectId"> <summary> <para> <para>The project ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.MetadataProperties_Repository"> <summary> <para> <para>The repository.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.StartTime"> <summary> <para> <para>When the component started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.TrialComponentName"> <summary> <para> <para>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialComponentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateTrialComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateTrialComponentResponse 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.NewSMTrialComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialComponentName parameter. The -PassThru parameter is deprecated, use -Select '^TrialComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMTrialComponentCmdlet.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.NewSMUserProfileCmdlet"> <summary> Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.DomainId"> <summary> <para> <para>The ID of the associated Domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.SingleSignOnUserIdentifier"> <summary> <para> <para>A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.SingleSignOnUserValue"> <summary> <para> <para>The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.Tag"> <summary> <para> <para>Each tag consists of a key and an optional value. Tag keys must be unique per resource.</para><para>Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.UserProfileName"> <summary> <para> <para>A name for the UserProfile. This value is not case sensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.UserSetting"> <summary> <para> <para>A collection of settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserProfileArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateUserProfileResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateUserProfileResponse 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.NewSMUserProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserProfileName parameter. The -PassThru parameter is deprecated, use -Select '^UserProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMUserProfileCmdlet.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.NewSMWorkforceCmdlet"> <summary> Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account. <para> If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html">DeleteWorkforce</a> API operation to delete the existing workforce and then use <c>CreateWorkforce</c> to create a new workforce. </para><para> To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in <c>CognitoConfig</c>. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html"> Create a Private Workforce (Amazon Cognito)</a>. </para><para> To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in <c>OidcConfig</c>. Your OIDC IdP must support <i>groups</i> because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html"> Create a Private Workforce (OIDC IdP)</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_AuthorizationEndpoint"> <summary> <para> <para>The OIDC IdP authorization endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.SourceIpConfig_Cidr"> <summary> <para> <para>A list of one to ten <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Classless Inter-Domain Routing</a> (CIDR) values.</para><para>Maximum: Ten CIDR values</para><note><para>The following Length Constraints apply to individual CIDR values in the CIDR value list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.CognitoConfig_ClientId"> <summary> <para> <para>The client ID for your Amazon Cognito user pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_ClientId"> <summary> <para> <para>The OIDC IdP client ID used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_ClientSecret"> <summary> <para> <para>The OIDC IdP client secret used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_Issuer"> <summary> <para> <para>The OIDC IdP issuer used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_JwksUri"> <summary> <para> <para>The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_LogoutEndpoint"> <summary> <para> <para>The OIDC IdP logout endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.WorkforceVpcConfig_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.NewSMWorkforceCmdlet.WorkforceVpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC that you want to connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_TokenEndpoint"> <summary> <para> <para>The OIDC IdP token endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.OidcConfig_UserInfoEndpoint"> <summary> <para> <para>The OIDC IdP user information endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.CognitoConfig_UserPool"> <summary> <para> <para>A <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> user pool</a> is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.WorkforceVpcConfig_VpcId"> <summary> <para> <para>The ID of the VPC that the workforce uses for communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.WorkforceName"> <summary> <para> <para>The name of the private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WorkforceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateWorkforceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateWorkforceResponse 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.NewSMWorkforceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkforceName parameter. The -PassThru parameter is deprecated, use -Select '^WorkforceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkforceCmdlet.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 <c>MemberDefinition</c> objects that contains objects that identify the workers that make up the work team. </para><para>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <c>CognitoMemberDefinition</c>. For workforces created using your own OIDC identity provider (IdP) use <c>OidcMemberDefinition</c>. Do not provide input for both of these parameters in a single request.</para><para>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <c>CognitoMemberDefinition</c> objects that make up the member definition must have the same <c>ClientId</c> and <c>UserPool</c> values. To add a Amazon Cognito user group to an existing worker pool, see <a href="">Adding groups to a User Pool</a>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</para><para>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <c>OidcMemberDefinition</c> by listing those groups in <c>Groups</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.NotificationConfiguration_NotificationTopicArn"> <summary> <para> <para>The ARN for the Amazon 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> Amazon Web Services Billing and Cost Management User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.NewSMWorkteamCmdlet.WorkforceName"> <summary> <para> <para>The name of the workforce.</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.RegisterSMDeviceCmdlet"> <summary> Register devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMDeviceCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMDeviceCmdlet.Device"> <summary> <para> <para>A list of devices to register with SageMaker Edge Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMDeviceCmdlet.Tag"> <summary> <para> <para>The tags associated with devices.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMDeviceCmdlet.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.RegisterDevicesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMDeviceCmdlet.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.RegisterSMTrialComponentCmdlet"> <summary> Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html">DisassociateTrialComponent</a> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMTrialComponentCmdlet.TrialComponentName"> <summary> <para> <para>The name of the component to associated with the trial.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMTrialComponentCmdlet.TrialName"> <summary> <para> <para>The name of the trial to associate with.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMTrialComponentCmdlet.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.AssociateTrialComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.AssociateTrialComponentResponse 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.RegisterSMTrialComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialComponentName parameter. The -PassThru parameter is deprecated, use -Select '^TrialComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RegisterSMTrialComponentCmdlet.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.RemoveSMActionCmdlet"> <summary> Deletes an action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMActionCmdlet.ActionName"> <summary> <para> <para>The name of the action to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteActionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteActionResponse 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.RemoveSMActionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActionName parameter. The -PassThru parameter is deprecated, use -Select '^ActionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMActionCmdlet.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.RemoveSMAppCmdlet"> <summary> Used to stop and delete an app. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.AppName"> <summary> <para> <para>The name of the app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.AppType"> <summary> <para> <para>The type of app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.SpaceName"> <summary> <para> <para>The name of the space. If this value is not set, then <c>UserProfileName</c> must be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.UserProfileName"> <summary> <para> <para>The user profile name. If this value is not set, then <c>SpaceName</c> must be set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.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.DeleteAppResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppName parameter. The -PassThru parameter is deprecated, use -Select '^AppName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppCmdlet.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.RemoveSMAppImageConfigCmdlet"> <summary> Deletes an AppImageConfig. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppImageConfigCmdlet.AppImageConfigName"> <summary> <para> <para>The name of the AppImageConfig to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppImageConfigCmdlet.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.DeleteAppImageConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppImageConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppImageConfigName parameter. The -PassThru parameter is deprecated, use -Select '^AppImageConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAppImageConfigCmdlet.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.RemoveSMArtifactCmdlet"> <summary> Deletes an artifact. Either <c>ArtifactArn</c> or <c>Source</c> must be specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMArtifactCmdlet.ArtifactArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the artifact to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMArtifactCmdlet.Source_SourceType"> <summary> <para> <para>A list of source types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMArtifactCmdlet.Source_SourceUri"> <summary> <para> <para>The URI of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMArtifactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ArtifactArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteArtifactResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteArtifactResponse 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.RemoveSMArtifactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ArtifactArn parameter. The -PassThru parameter is deprecated, use -Select '^ArtifactArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMArtifactCmdlet.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.RemoveSMAssociationCmdlet"> <summary> Deletes an association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAssociationCmdlet.DestinationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the destination.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAssociationCmdlet.SourceArn"> <summary> <para> <para>The ARN of the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMAssociationCmdlet.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.DeleteAssociationResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteAssociationResponse 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.RemoveSMAssociationCmdlet.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.RemoveSMClusterCmdlet"> <summary> Delete a SageMaker HyperPod cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMClusterCmdlet.ClusterName"> <summary> <para> <para>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteClusterResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteClusterResponse 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.RemoveSMClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMClusterCmdlet.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.RemoveSMCompilationJobCmdlet"> <summary> Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role. <para> You can delete a compilation job only if its current status is <c>COMPLETED</c>, <c>FAILED</c>, or <c>STOPPED</c>. If the job status is <c>STARTING</c> or <c>INPROGRESS</c>, stop the job, and then delete it after its status becomes <c>STOPPED</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCompilationJobCmdlet.CompilationJobName"> <summary> <para> <para>The name of the compilation job to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCompilationJobCmdlet.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.DeleteCompilationJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMCompilationJobCmdlet.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.RemoveSMCompilationJobCmdlet.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.RemoveSMContextCmdlet"> <summary> Deletes an context. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMContextCmdlet.ContextName"> <summary> <para> <para>The name of the context to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMContextCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContextArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteContextResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteContextResponse 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.RemoveSMContextCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContextName parameter. The -PassThru parameter is deprecated, use -Select '^ContextName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMContextCmdlet.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.RemoveSMDataQualityJobDefinitionCmdlet"> <summary> Deletes a data quality monitoring job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDataQualityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the data quality monitoring job definition to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDataQualityJobDefinitionCmdlet.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.DeleteDataQualityJobDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDataQualityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDataQualityJobDefinitionCmdlet.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.RemoveSMDeviceCmdlet"> <summary> Deregisters the specified devices. After you deregister a device, you will need to re-register the devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet the devices belong to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceCmdlet.DeviceName"> <summary> <para> <para>The unique IDs of the devices.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceCmdlet.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.DeregisterDevicesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceCmdlet.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.RemoveSMDeviceFleetCmdlet"> <summary> Deletes a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceFleetCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceFleetCmdlet.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.DeleteDeviceFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDeviceFleetCmdlet.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.RemoveSMDomainCmdlet"> <summary> Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDomainCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDomainCmdlet.RetentionPolicy_HomeEfsFileSystem"> <summary> <para> <para>The default is <c>Retain</c>, which specifies to keep the data stored on the Amazon EFS volume.</para><para>Specify <c>Delete</c> to delete the data stored on the Amazon EFS volume.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDomainCmdlet.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.DeleteDomainResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMDomainCmdlet.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.RemoveSMEdgeDeploymentPlanCmdlet"> <summary> Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentPlanCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentPlanCmdlet.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.DeleteEdgeDeploymentPlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EdgeDeploymentPlanName parameter. The -PassThru parameter is deprecated, use -Select '^EdgeDeploymentPlanName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentPlanCmdlet.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.RemoveSMEdgeDeploymentStageCmdlet"> <summary> Delete a stage in an edge deployment plan if (and only if) the stage is inactive. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentStageCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan from which the stage will be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentStageCmdlet.StageName"> <summary> <para> <para>The name of the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentStageCmdlet.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.DeleteEdgeDeploymentStageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMEdgeDeploymentStageCmdlet.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. SageMaker frees up all of the resources that were deployed when the endpoint was created. <para> 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><para> When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your <c><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn">ExecutionRoleArn</a></c>, otherwise SageMaker cannot delete these resources. </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 <c>DeleteEndpointConfig</c> API deletes only the specified configuration. It does not delete endpoints created using the configuration. <para> You must not delete an <c>EndpointConfig</c> in use by an endpoint that is live or while the <c>UpdateEndpoint</c> or <c>CreateEndpoint</c> operations are being performed on the endpoint. If you delete the <c>EndpointConfig</c> of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges. </para> </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.RemoveSMExperimentCmdlet"> <summary> Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API to get a list of the trials associated with the experiment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMExperimentCmdlet.ExperimentName"> <summary> <para> <para>The name of the experiment to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteExperimentResponse 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.RemoveSMExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExperimentName parameter. The -PassThru parameter is deprecated, use -Select '^ExperimentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMExperimentCmdlet.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.RemoveSMFeatureGroupCmdlet"> <summary> Delete the <c>FeatureGroup</c> and any data that was written to the <c>OnlineStore</c> of the <c>FeatureGroup</c>. Data cannot be accessed from the <c>OnlineStore</c> immediately after <c>DeleteFeatureGroup</c> is called. <para> Data written into the <c>OfflineStore</c> will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your <c>OfflineStore</c> are not deleted. </para><para> Note that it can take approximately 10-15 minutes to delete an <c>OnlineStore</c><c>FeatureGroup</c> with the <c>InMemory</c><c>StorageType</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFeatureGroupCmdlet.FeatureGroupName"> <summary> <para> <para>The name of the <c>FeatureGroup</c> you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFeatureGroupCmdlet.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.DeleteFeatureGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFeatureGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFeatureGroupCmdlet.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.RemoveSMFlowDefinitionCmdlet"> <summary> Deletes the specified flow definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFlowDefinitionCmdlet.FlowDefinitionName"> <summary> <para> <para>The name of the flow definition you are deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFlowDefinitionCmdlet.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.DeleteFlowDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFlowDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FlowDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^FlowDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMFlowDefinitionCmdlet.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.RemoveSMHubCmdlet"> <summary> Delete a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubCmdlet.HubName"> <summary> <para> <para>The name of the hub to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubCmdlet.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.DeleteHubResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HubName parameter. The -PassThru parameter is deprecated, use -Select '^HubName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubCmdlet.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.RemoveSMHubContentCmdlet"> <summary> Delete the contents of a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubContentCmdlet.HubContentName"> <summary> <para> <para>The name of the content that you want to delete from a hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubContentCmdlet.HubContentType"> <summary> <para> <para>The type of content that you want to delete from a hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubContentCmdlet.HubContentVersion"> <summary> <para> <para>The version of the content that you want to delete from a hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubContentCmdlet.HubName"> <summary> <para> <para>The name of the hub that you want to delete content in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubContentCmdlet.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.DeleteHubContentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHubContentCmdlet.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.RemoveSMHumanTaskUiCmdlet"> <summary> Use this operation to delete a human task user interface (worker task template). <para> To see a list of human task user interfaces (work task templates) in your account, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html">ListHumanTaskUis</a>. When you delete a worker task template, it no longer appears when you call <c>ListHumanTaskUis</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHumanTaskUiCmdlet.HumanTaskUiName"> <summary> <para> <para>The name of the human task user interface (work task template) you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHumanTaskUiCmdlet.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.DeleteHumanTaskUiResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHumanTaskUiCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HumanTaskUiName parameter. The -PassThru parameter is deprecated, use -Select '^HumanTaskUiName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHumanTaskUiCmdlet.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.RemoveSMHyperParameterTuningJobCmdlet"> <summary> Deletes a hyperparameter tuning job. The <c>DeleteHyperParameterTuningJob</c> API deletes only the tuning job entry that was created in SageMaker when you called the <c>CreateHyperParameterTuningJob</c> API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHyperParameterTuningJobCmdlet.HyperParameterTuningJobName"> <summary> <para> <para>The name of the hyperparameter tuning job that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHyperParameterTuningJobCmdlet.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.DeleteHyperParameterTuningJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMHyperParameterTuningJobCmdlet.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.RemoveSMHyperParameterTuningJobCmdlet.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.RemoveSMImageCmdlet"> <summary> Deletes a SageMaker image and all versions of the image. The container images aren't deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageCmdlet.ImageName"> <summary> <para> <para>The name of the image to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageCmdlet.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.DeleteImageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageCmdlet.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.RemoveSMImageVersionCmdlet"> <summary> Deletes a version of a SageMaker image. The container image the version represents isn't deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageVersionCmdlet.Alias"> <summary> <para> <para>The alias of the image to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageVersionCmdlet.ImageName"> <summary> <para> <para>The name of the image to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageVersionCmdlet.Version"> <summary> <para> <para>The version to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageVersionCmdlet.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.DeleteImageVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMImageVersionCmdlet.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.RemoveSMInferenceComponentCmdlet"> <summary> Deletes an inference component. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceComponentCmdlet.InferenceComponentName"> <summary> <para> <para>The name of the inference component to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceComponentCmdlet.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.DeleteInferenceComponentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InferenceComponentName parameter. The -PassThru parameter is deprecated, use -Select '^InferenceComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceComponentCmdlet.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.RemoveSMInferenceExperimentCmdlet"> <summary> Deletes an inference experiment. <note><para> This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceExperimentCmdlet.Name"> <summary> <para> <para>The name of the inference experiment you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteInferenceExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteInferenceExperimentResponse 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.RemoveSMInferenceExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMInferenceExperimentCmdlet.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 <c>DeleteModel</c> API deletes only the model entry that was created in SageMaker when you called the <c>CreateModel</c> 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.RemoveSMModelBiasJobDefinitionCmdlet"> <summary> Deletes an Amazon SageMaker model bias job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelBiasJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the model bias job definition to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelBiasJobDefinitionCmdlet.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.DeleteModelBiasJobDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelBiasJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelBiasJobDefinitionCmdlet.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.RemoveSMModelCardCmdlet"> <summary> Deletes an Amazon SageMaker Model Card. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCardCmdlet.ModelCardName"> <summary> <para> <para>The name of the model card to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCardCmdlet.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.DeleteModelCardResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelCardCmdlet.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.RemoveSMModelExplainabilityJobDefinitionCmdlet"> <summary> Deletes an Amazon SageMaker model explainability job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelExplainabilityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the model explainability job definition to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelExplainabilityJobDefinitionCmdlet.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.DeleteModelExplainabilityJobDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelExplainabilityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelExplainabilityJobDefinitionCmdlet.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 SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageCmdlet.ModelPackageName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the model package to delete.</para><para>When you specify a name, 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.RemoveSMModelPackageGroupCmdlet"> <summary> Deletes the specified model group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupCmdlet.ModelPackageGroupName"> <summary> <para> <para>The name of the model group to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupCmdlet.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.DeleteModelPackageGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupCmdlet.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.RemoveSMModelPackageGroupPolicyCmdlet"> <summary> Deletes a model group resource policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupPolicyCmdlet.ModelPackageGroupName"> <summary> <para> <para>The name of the model group for which to delete the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupPolicyCmdlet.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.DeleteModelPackageGroupPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelPackageGroupPolicyCmdlet.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.RemoveSMModelQualityJobDefinitionCmdlet"> <summary> Deletes the secified model quality monitoring job definition. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelQualityJobDefinitionCmdlet.JobDefinitionName"> <summary> <para> <para>The name of the model quality monitoring job definition to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelQualityJobDefinitionCmdlet.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.DeleteModelQualityJobDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelQualityJobDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMModelQualityJobDefinitionCmdlet.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.RemoveSMMonitoringScheduleCmdlet"> <summary> Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMMonitoringScheduleCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of the monitoring schedule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMMonitoringScheduleCmdlet.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.DeleteMonitoringScheduleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMMonitoringScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMMonitoringScheduleCmdlet.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 SageMaker notebook instance. Before you can delete a notebook instance, you must call the <c>StopNotebookInstance</c> API. <important><para> When you delete a notebook instance, you lose all of your data. 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 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.RemoveSMPipelineCmdlet"> <summary> Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the <c>StopPipelineExecution</c> API. When you delete a pipeline, all instances of the pipeline are deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMPipelineCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeletePipelineResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeletePipelineResponse 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.RemoveSMPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMPipelineCmdlet.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.RemoveSMProjectCmdlet"> <summary> Delete the specified project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMProjectCmdlet.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.DeleteProjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMProjectCmdlet.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 SageMaker resource. <para> To list a resource's tags, use the <c>ListTags</c> 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><note><para> When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile 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.RemoveSMSpaceCmdlet"> <summary> Used to delete a space. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMSpaceCmdlet.DomainId"> <summary> <para> <para>The ID of the associated domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMSpaceCmdlet.SpaceName"> <summary> <para> <para>The name of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMSpaceCmdlet.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.DeleteSpaceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMSpaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpaceName parameter. The -PassThru parameter is deprecated, use -Select '^SpaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMSpaceCmdlet.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.RemoveSMStudioLifecycleConfigCmdlet"> <summary> Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMStudioLifecycleConfigCmdlet.StudioLifecycleConfigName"> <summary> <para> <para>The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMStudioLifecycleConfigCmdlet.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.DeleteStudioLifecycleConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMStudioLifecycleConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioLifecycleConfigName parameter. The -PassThru parameter is deprecated, use -Select '^StudioLifecycleConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMStudioLifecycleConfigCmdlet.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.RemoveSMTrialCmdlet"> <summary> Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html">DescribeTrialComponent</a> API to get the list of trial components. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMTrialCmdlet.TrialName"> <summary> <para> <para>The name of the trial to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMTrialCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteTrialResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteTrialResponse 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.RemoveSMTrialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialName parameter. The -PassThru parameter is deprecated, use -Select '^TrialName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMTrialCmdlet.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.RemoveSMTrialComponentCmdlet"> <summary> Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html">DisassociateTrialComponent</a> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMTrialComponentCmdlet.TrialComponentName"> <summary> <para> <para>The name of the component to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMTrialComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialComponentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.DeleteTrialComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DeleteTrialComponentResponse 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.RemoveSMTrialComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialComponentName parameter. The -PassThru parameter is deprecated, use -Select '^TrialComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMTrialComponentCmdlet.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.RemoveSMUserProfileCmdlet"> <summary> Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMUserProfileCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMUserProfileCmdlet.UserProfileName"> <summary> <para> <para>The user profile name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMUserProfileCmdlet.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.DeleteUserProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMUserProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserProfileName parameter. The -PassThru parameter is deprecated, use -Select '^UserProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMUserProfileCmdlet.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.RemoveSMWorkforceCmdlet"> <summary> Use this operation to delete a workforce. <para> If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html">CreateWorkforce</a> to create a new workforce. </para><important><para> If a private workforce contains one or more work teams, you must use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html">DeleteWorkteam</a> operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a <c>ResourceInUse</c> error. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkforceCmdlet.WorkforceName"> <summary> <para> <para>The name of the workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkforceCmdlet.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.DeleteWorkforceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkforceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkforceName parameter. The -PassThru parameter is deprecated, use -Select '^WorkforceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RemoveSMWorkforceCmdlet.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.RestartSMPipelineExecutionCmdlet"> <summary> Retry the execution of the pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RestartSMPipelineExecutionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RestartSMPipelineExecutionCmdlet.ParallelismConfiguration_MaxParallelExecutionStep"> <summary> <para> <para>The max number of steps that can be executed in parallel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RestartSMPipelineExecutionCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RestartSMPipelineExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.RetryPipelineExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.RetryPipelineExecutionResponse 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.RestartSMPipelineExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.RestartSMPipelineExecutionCmdlet.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 SageMaker resources that match a search query. Matching resources are returned as a list of <c>SearchRecord</c> 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: numeric, text, Boolean, and timestamp. </para><note><para> The Search API may provide access to otherwise restricted data. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html">Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference</a> for more information. </para></note><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.CrossAccountFilterOption"> <summary> <para> <para> A cross account filter option. When the value is <c>"CrossAccount"</c> the search results will only include resources made discoverable to you from other accounts. When the value is <c>"SameAccount"</c> or <c>null</c> the search results will only include resources from your account. Default is <c>null</c>. For more information on searching for resources made discoverable to your account, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html"> Search discoverable resources</a> in the SageMaker Developer Guide. The maximum number of <c>ResourceCatalog</c>s viewable is 1000. </para> </para> </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 <c>And</c>. If only a single conditional statement needs to be true for the entire search expression to be true, specify <c>Or</c>. The default value is <c>And</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.Resource"> <summary> <para> <para>The name of the SageMaker resource to search for.</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 <c>SearchResults</c>. The default is <c>LastModifiedTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.SortOrder"> <summary> <para> <para>How <c>SearchResults</c> are ordered. Valid values are <c>Ascending</c> or <c>Descending</c>. The default is <c>Descending</c>.</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.VisibilityCondition"> <summary> <para> <para> Limits the results of your search request to the resources that you can access. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SearchSMResourceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results 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.SearchSMResourceCmdlet.NextToken"> <summary> <para> <para>If more than <c>MaxResults</c> resources match the specified <c>SearchExpression</c>, the response includes a <c>NextToken</c>. The <c>NextToken</c> can be passed to the next <c>SearchRequest</c> to continue retrieving results.</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.SendSMPipelineExecutionStepFailureCmdlet"> <summary> Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepFailureCmdlet.CallbackToken"> <summary> <para> <para>The pipeline generated token from the Amazon SQS queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepFailureCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepFailureCmdlet.FailureReason"> <summary> <para> <para>A message describing why the step failed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepFailureCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.SendPipelineExecutionStepFailureResponse). Specifying the name of a property of type Amazon.SageMaker.Model.SendPipelineExecutionStepFailureResponse 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.SendSMPipelineExecutionStepFailureCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CallbackToken parameter. The -PassThru parameter is deprecated, use -Select '^CallbackToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepFailureCmdlet.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.SendSMPipelineExecutionStepSuccessCmdlet"> <summary> Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepSuccessCmdlet.CallbackToken"> <summary> <para> <para>The pipeline generated token from the Amazon SQS queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepSuccessCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepSuccessCmdlet.OutputParameter"> <summary> <para> <para>A list of the output parameters of the callback step.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepSuccessCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.SendPipelineExecutionStepSuccessResponse). Specifying the name of a property of type Amazon.SageMaker.Model.SendPipelineExecutionStepSuccessResponse 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.SendSMPipelineExecutionStepSuccessCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CallbackToken parameter. The -PassThru parameter is deprecated, use -Select '^CallbackToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.SendSMPipelineExecutionStepSuccessCmdlet.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.StartSMEdgeDeploymentStageCmdlet"> <summary> Starts a stage in an edge deployment plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMEdgeDeploymentStageCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMEdgeDeploymentStageCmdlet.StageName"> <summary> <para> <para>The name of the stage to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMEdgeDeploymentStageCmdlet.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.StartEdgeDeploymentStageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMEdgeDeploymentStageCmdlet.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.StartSMInferenceExperimentCmdlet"> <summary> Starts an inference experiment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMInferenceExperimentCmdlet.Name"> <summary> <para> <para>The name of the inference experiment to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMInferenceExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StartInferenceExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.StartInferenceExperimentResponse 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.StartSMInferenceExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMInferenceExperimentCmdlet.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.StartSMMonitoringScheduleCmdlet"> <summary> Starts a previously stopped monitoring schedule. <note><para> By default, when you successfully create a new schedule, the status of a monitoring schedule is <c>scheduled</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMMonitoringScheduleCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of the schedule to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMMonitoringScheduleCmdlet.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.StartMonitoringScheduleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMMonitoringScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMMonitoringScheduleCmdlet.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.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, SageMaker sets the notebook instance status to <c>InService</c>. A notebook instance's status must be <c>InService</c> 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.StartSMPipelineExecutionCmdlet"> <summary> Starts a pipeline execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.ParallelismConfiguration_MaxParallelExecutionStep"> <summary> <para> <para>The max number of steps that can be executed in parallel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.PipelineExecutionDescription"> <summary> <para> <para>The description of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.PipelineExecutionDisplayName"> <summary> <para> <para>The display name of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.PipelineName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.PipelineParameter"> <summary> <para> <para>Contains a list of pipeline parameters. This list can be empty. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.SelectiveExecutionConfig_SelectedStep"> <summary> <para> <para>A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.SelectiveExecutionConfig_SourcePipelineExecutionArn"> <summary> <para> <para>The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either <c>Failed</c> or <c>Success</c>.</para><para>This field is required if the steps you specify for <c>SelectedSteps</c> depend on output collaterals from any non-specified pipeline steps. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-selective-ex.html">Selective Execution for Pipeline Steps</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StartPipelineExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.StartPipelineExecutionResponse 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.StartSMPipelineExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StartSMPipelineExecutionCmdlet.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.StopSMAutoMLJobCmdlet"> <summary> A method for forcing a running job to shut down. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMAutoMLJobCmdlet.AutoMLJobName"> <summary> <para> <para>The name of the object you are requesting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMAutoMLJobCmdlet.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.StopAutoMLJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMAutoMLJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AutoMLJobName parameter. The -PassThru parameter is deprecated, use -Select '^AutoMLJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMAutoMLJobCmdlet.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 <c>StopCompilationJob</c> request, Amazon SageMaker changes the <c>CompilationJobStatus</c> of the job to <c>Stopping</c>. After Amazon SageMaker stops the job, it sets the <c>CompilationJobStatus</c> to <c>Stopped</c>. </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.StopSMEdgeDeploymentStageCmdlet"> <summary> Stops a stage in an edge deployment plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgeDeploymentStageCmdlet.EdgeDeploymentPlanName"> <summary> <para> <para>The name of the edge deployment plan to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgeDeploymentStageCmdlet.StageName"> <summary> <para> <para>The name of the stage to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgeDeploymentStageCmdlet.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.StopEdgeDeploymentStageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgeDeploymentStageCmdlet.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.StopSMEdgePackagingJobCmdlet"> <summary> Request to stop an edge packaging job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgePackagingJobCmdlet.EdgePackagingJobName"> <summary> <para> <para>The name of the edge packaging job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgePackagingJobCmdlet.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.StopEdgePackagingJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgePackagingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EdgePackagingJobName parameter. The -PassThru parameter is deprecated, use -Select '^EdgePackagingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMEdgePackagingJobCmdlet.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 <c>Stopped</c> 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.StopSMInferenceExperimentCmdlet"> <summary> Stops an inference experiment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.DesiredModelVariant"> <summary> <para> <para> An array of <c>ModelVariantConfig</c> objects. There is one for each variant that you want to deploy after the inference experiment stops. Each <c>ModelVariantConfig</c> describes the infrastructure configuration for deploying the corresponding variant. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.DesiredState"> <summary> <para> <para> The desired state of the experiment after stopping. The possible states are the following: </para><ul><li><para><c>Completed</c>: The experiment completed successfully</para></li><li><para><c>Cancelled</c>: The experiment was canceled</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.ModelVariantAction"> <summary> <para> <para> Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following: </para><ul><li><para><c>Promote</c> - Promote the shadow variant to a production variant</para></li><li><para><c>Remove</c> - Delete the variant</para></li><li><para><c>Retain</c> - Keep the variant as it is</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.Name"> <summary> <para> <para>The name of the inference experiment to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.Reason"> <summary> <para> <para>The reason for stopping the experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopInferenceExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.StopInferenceExperimentResponse 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.StopSMInferenceExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceExperimentCmdlet.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.StopSMInferenceRecommendationsJobCmdlet"> <summary> Stops an Inference Recommender job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceRecommendationsJobCmdlet.JobName"> <summary> <para> <para>The name of the job you want to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceRecommendationsJobCmdlet.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.StopInferenceRecommendationsJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceRecommendationsJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobName parameter. The -PassThru parameter is deprecated, use -Select '^JobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMInferenceRecommendationsJobCmdlet.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.StopSMMonitoringScheduleCmdlet"> <summary> Stops a previously started monitoring schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMMonitoringScheduleCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of the schedule to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMMonitoringScheduleCmdlet.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.StopMonitoringScheduleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMMonitoringScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMMonitoringScheduleCmdlet.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, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call <c>StopNotebookInstance</c>. <para> To access data on the ML storage volume for a notebook instance that has been terminated, call the <c>StartNotebookInstance</c> API. <c>StartNotebookInstance</c> 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.StopSMPipelineExecutionCmdlet"> <summary> Stops a pipeline execution. <para><b>Callback Step</b></para><para> A pipeline execution won't stop while a callback step is running. When you call <c>StopPipelineExecution</c> on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping". </para><para> You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to <c>SendPipelineExecutionStepSuccess</c> or <c>SendPipelineExecutionStepFailure</c>. </para><para> Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution. </para><para><b>Lambda Step</b></para><para> A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is <c>Stopped</c>. If the timeout is hit the pipeline execution status is <c>Failed</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMPipelineExecutionCmdlet.ClientRequestToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMPipelineExecutionCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMPipelineExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.StopPipelineExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.StopPipelineExecutionResponse 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.StopSMPipelineExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMPipelineExecutionCmdlet.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.StopSMProcessingJobCmdlet"> <summary> Stops a processing job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMProcessingJobCmdlet.ProcessingJobName"> <summary> <para> <para>The name of the processing job to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMProcessingJobCmdlet.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.StopProcessingJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMProcessingJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProcessingJobName parameter. The -PassThru parameter is deprecated, use -Select '^ProcessingJobName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.StopSMProcessingJobCmdlet.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, SageMaker sends the algorithm the <c>SIGTERM</c> 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 <c>StopTrainingJob</c> request, SageMaker changes the status of the job to <c>Stopping</c>. After SageMaker stops the job, it sets the status to <c>Stopped</c>. </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 batch transform job. <para> When Amazon SageMaker receives a <c>StopTransformJob</c> request, the status of the job changes to <c>Stopping</c>. After Amazon SageMaker stops the job, the status is set to <c>Stopped</c>. When you stop a batch 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 batch 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.UnregisterSMTrialComponentCmdlet"> <summary> Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html">AssociateTrialComponent</a> API. <para> To get a list of the trials a component is associated with, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API. Specify <c>ExperimentTrialComponent</c> for the <c>Resource</c> parameter. The list appears in the response under <c>Results.TrialComponent.Parents</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UnregisterSMTrialComponentCmdlet.TrialComponentName"> <summary> <para> <para>The name of the component to disassociate from the trial.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UnregisterSMTrialComponentCmdlet.TrialName"> <summary> <para> <para>The name of the trial to disassociate from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UnregisterSMTrialComponentCmdlet.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.DisassociateTrialComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.DisassociateTrialComponentResponse 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.UnregisterSMTrialComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialComponentName parameter. The -PassThru parameter is deprecated, use -Select '^TrialComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UnregisterSMTrialComponentCmdlet.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.UpdateSMActionCmdlet"> <summary> Updates an action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.ActionName"> <summary> <para> <para>The name of the action to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.Description"> <summary> <para> <para>The new description for the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.Property"> <summary> <para> <para>The new list of properties. Overwrites the current property list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.PropertiesToRemove"> <summary> <para> <para>A list of properties to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.Status"> <summary> <para> <para>The new status for the action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ActionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateActionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateActionResponse 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.UpdateSMActionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ActionName parameter. The -PassThru parameter is deprecated, use -Select '^ActionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMActionCmdlet.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.UpdateSMAppImageConfigCmdlet"> <summary> Updates the properties of an AppImageConfig. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.AppImageConfigName"> <summary> <para> <para>The name of the AppImageConfig to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.CodeEditorAppImageConfig_ContainerConfig_ContainerArguments"> <summary> <para> <para>The arguments for the container when you're running the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.ContainerConfig_ContainerArgument"> <summary> <para> <para>The arguments for the container when you're running the application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.CodeEditorAppImageConfig_ContainerConfig_ContainerEntrypoint"> <summary> <para> <para>The entrypoint used to run the application in the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.ContainerConfig_ContainerEntrypoint"> <summary> <para> <para>The entrypoint used to run the application in the container.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.CodeEditorAppImageConfig_ContainerConfig_ContainerEnvironmentVariables"> <summary> <para> <para>The environment variables to set in the container</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.ContainerConfig_ContainerEnvironmentVariable"> <summary> <para> <para>The environment variables to set in the container</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.CodeEditorAppImageConfig_FileSystemConfig_DefaultGid"> <summary> <para> <para>The default POSIX group ID (GID). If not specified, defaults to <c>100</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.JupyterLabAppImageConfig_FileSystemConfig_DefaultGid"> <summary> <para> <para>The default POSIX group ID (GID). If not specified, defaults to <c>100</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.FileSystemConfig_DefaultGid"> <summary> <para> <para>The default POSIX group ID (GID). If not specified, defaults to <c>100</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.CodeEditorAppImageConfig_FileSystemConfig_DefaultUid"> <summary> <para> <para>The default POSIX user ID (UID). If not specified, defaults to <c>1000</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.JupyterLabAppImageConfig_FileSystemConfig_DefaultUid"> <summary> <para> <para>The default POSIX user ID (UID). If not specified, defaults to <c>1000</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.FileSystemConfig_DefaultUid"> <summary> <para> <para>The default POSIX user ID (UID). If not specified, defaults to <c>1000</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.KernelGatewayImageConfig_KernelSpec"> <summary> <para> <para>The specification of the Jupyter kernels in the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.CodeEditorAppImageConfig_FileSystemConfig_MountPath"> <summary> <para> <para>The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to <i>/home/sagemaker-user</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.JupyterLabAppImageConfig_FileSystemConfig_MountPath"> <summary> <para> <para>The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to <i>/home/sagemaker-user</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.FileSystemConfig_MountPath"> <summary> <para> <para>The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to <i>/home/sagemaker-user</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppImageConfigArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateAppImageConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateAppImageConfigResponse 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.UpdateSMAppImageConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppImageConfigName parameter. The -PassThru parameter is deprecated, use -Select '^AppImageConfigName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMAppImageConfigCmdlet.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.UpdateSMArtifactCmdlet"> <summary> Updates an artifact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMArtifactCmdlet.ArtifactArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the artifact to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMArtifactCmdlet.ArtifactName"> <summary> <para> <para>The new name for the artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMArtifactCmdlet.Property"> <summary> <para> <para>The new list of properties. Overwrites the current property list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMArtifactCmdlet.PropertiesToRemove"> <summary> <para> <para>A list of properties to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMArtifactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ArtifactArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateArtifactResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateArtifactResponse 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.UpdateSMArtifactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ArtifactArn parameter. The -PassThru parameter is deprecated, use -Select '^ArtifactArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMArtifactCmdlet.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.UpdateSMClusterCmdlet"> <summary> Updates a SageMaker HyperPod cluster. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterCmdlet.ClusterName"> <summary> <para> <para>Specify the name of the SageMaker HyperPod cluster you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterCmdlet.InstanceGroup"> <summary> <para> <para>Specify the instance groups to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateClusterResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateClusterResponse 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.UpdateSMClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterCmdlet.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.UpdateSMClusterSoftwareCmdlet"> <summary> Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software">Update the SageMaker HyperPod platform software of a cluster</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterSoftwareCmdlet.ClusterName"> <summary> <para> <para>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterSoftwareCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateClusterSoftwareResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateClusterSoftwareResponse 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.UpdateSMClusterSoftwareCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMClusterSoftwareCmdlet.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 Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of <c>AWSCURRENT</c> and must be in the following format:</para><para><c>{"username": <i>UserName</i>, "password": <i>Password</i>}</c></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.UpdateSMContextCmdlet"> <summary> Updates a context. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMContextCmdlet.ContextName"> <summary> <para> <para>The name of the context to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMContextCmdlet.Description"> <summary> <para> <para>The new description for the context.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMContextCmdlet.Property"> <summary> <para> <para>The new list of properties. Overwrites the current property list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMContextCmdlet.PropertiesToRemove"> <summary> <para> <para>A list of properties to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMContextCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContextArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateContextResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateContextResponse 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.UpdateSMContextCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContextName parameter. The -PassThru parameter is deprecated, use -Select '^ContextName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMContextCmdlet.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.UpdateSMDeviceCmdlet"> <summary> Updates one or more devices in a fleet. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet the devices belong to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceCmdlet.Device"> <summary> <para> <para>List of devices to register with Edge Manager agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceCmdlet.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.UpdateDevicesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceCmdlet.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.UpdateSMDeviceFleetCmdlet"> <summary> Updates a fleet of devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.Description"> <summary> <para> <para>Description of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.DeviceFleetName"> <summary> <para> <para>The name of the fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.EnableIotRoleAlias"> <summary> <para> <para>Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".</para><para>For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.OutputConfig_KmsKeyId"> <summary> <para> <para>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.OutputConfig_PresetDeploymentConfig"> <summary> <para> <para>The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:</para><ul><li><para><c>ComponentName</c> (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.</para></li><li><para><c>ComponentDescription</c> (optional) - Description of the component.</para></li><li><para><c>ComponentVersion</c> (optional) - The version of the component.</para><note><para>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> major.minor.patch</i> number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</para></note></li><li><para><c>PlatformOS</c> (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.</para></li><li><para><c>PlatformArchitecture</c> (optional) - The processor architecture for the platform. </para><para>Supported architectures Windows include: Windows32_x86, Windows64_x64.</para><para>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.OutputConfig_PresetDeploymentType"> <summary> <para> <para>The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.OutputConfig_S3OutputLocation"> <summary> <para> <para>The Amazon Simple Storage (S3) bucker URI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.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.UpdateDeviceFleetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceFleetName parameter. The -PassThru parameter is deprecated, use -Select '^DeviceFleetName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDeviceFleetCmdlet.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.UpdateSMDomainCmdlet"> <summary> Updates the default settings for new user profiles in the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.AppNetworkAccessType"> <summary> <para> <para>Specifies the VPC used for non-EFS traffic.</para><ul><li><para><c>PublicInternetOnly</c> - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access.</para></li><li><para><c>VpcOnly</c> - All Studio traffic is through the specified VPC and subnets.</para></li></ul><para>This configuration can only be modified if there are no apps in the <c>InService</c>, <c>Pending</c>, or <c>Deleting</c> state. The configuration cannot be updated if <c>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</c> is already set or <c>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</c> is provided as part of the same request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.AppSecurityGroupManagement"> <summary> <para> <para>The entity that creates and manages the required security groups for inter-app communication in <c>VPCOnly</c> mode. Required when <c>CreateDomain.AppNetworkAccessType</c> is <c>VPCOnly</c> and <c>DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn</c> is provided. If setting up the domain for use with RStudio, this value must be set to <c>Service</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.JupyterLabAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.JupyterServerAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_CustomFileSystemConfig"> <summary> <para> <para>The settings for assigning a custom file system to a domain. Permitted users can access this file system in Amazon SageMaker Studio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.JupyterLabAppSettings_CustomImage"> <summary> <para> <para>A list of custom SageMaker images that are configured to run as a JupyterLab app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.KernelGatewayAppSettings_CustomImage"> <summary> <para> <para>A list of custom SageMaker images that are configured to run as a KernelGateway app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultEbsStorageSettings_DefaultEbsVolumeSizeInGb"> <summary> <para> <para>The default size of the EBS storage volume for a space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultUserSetting"> <summary> <para> <para>A collection of settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.RStudioServerProDomainSettingsForUpdate_DomainExecutionRoleArn"> <summary> <para> <para>The execution role for the <c>RStudioServerPro</c> Domain-level app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DomainId"> <summary> <para> <para>The ID of the domain to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DockerSettings_EnableDockerAccess"> <summary> <para> <para>Indicates whether the domain can access Docker.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_ExecutionRole"> <summary> <para> <para>The ARN of the execution role for the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DomainSettingsForUpdate_ExecutionRoleIdentityConfig"> <summary> <para> <para>The configuration for attaching a SageMaker user profile name to the execution role as a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html">sts:SourceIdentity key</a>. This configuration can only be modified if there are no apps in the <c>InService</c> or <c>Pending</c> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.CustomPosixUserConfig_Gid"> <summary> <para> <para>The POSIX group ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.JupyterLabAppSettings_LifecycleConfigArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the lifecycle configurations attached to the user profile or domain. To remove a lifecycle config, you must set <c>LifecycleConfigArns</c> to an empty list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.JupyterServerAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the <c>DefaultResourceSpec</c> parameter is also required.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.KernelGatewayAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultEbsStorageSettings_MaximumEbsVolumeSizeInGb"> <summary> <para> <para>The maximum size of the EBS storage volume for a space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.RStudioServerProDomainSettingsForUpdate_RStudioConnectUrl"> <summary> <para> <para>A URL pointing to an RStudio Connect server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.RStudioServerProDomainSettingsForUpdate_RStudioPackageManagerUrl"> <summary> <para> <para>A URL pointing to an RStudio Package Manager server.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DomainSettingsForUpdate_RStudioServerProDomainSettingsForUpdate_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DomainSettingsForUpdate_SecurityGroupId"> <summary> <para> <para>The security groups for the Amazon Virtual Private Cloud that the <c>Domain</c> uses for communication between Domain-level apps and user apps.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DefaultSpaceSettings_SecurityGroup"> <summary> <para> <para>The security group IDs for the Amazon VPC that the space uses for communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.SubnetId"> <summary> <para> <para>The VPC subnets that Studio uses for communication.</para><para>If removing subnets, ensure there are no apps in the <c>InService</c>, <c>Pending</c>, or <c>Deleting</c> state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.CustomPosixUserConfig_Uid"> <summary> <para> <para>The POSIX user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.DockerSettings_VpcOnlyTrustedAccount"> <summary> <para> <para>The list of Amazon Web Services accounts that are trusted when the domain is created in VPC-only mode.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DomainArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateDomainResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateDomainResponse 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.UpdateSMDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMDomainCmdlet.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 <c>EndpointConfig</c> specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous <c>EndpointConfig</c> (there is no availability loss). For more information about how to control the update and traffic shifting process, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails.html"> Update models in production</a>. <para> When SageMaker receives the request, it sets the endpoint status to <c>Updating</c>. After updating the endpoint, it sets the status to <c>InService</c>. To check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html">DescribeEndpoint</a> API. </para><note><para> You must not delete an <c>EndpointConfig</c> in use by an endpoint that is live or while the <c>UpdateEndpoint</c> or <c>CreateEndpoint</c> operations are being performed on the endpoint. To update an endpoint, you must create a new <c>EndpointConfig</c>. </para><para> If you delete the <c>EndpointConfig</c> of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.AutoRollbackConfiguration_Alarm"> <summary> <para> <para>List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.</para> </para> </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.ExcludeRetainedVariantProperty"> <summary> <para> <para>When you are updating endpoint resources with <c>RetainAllVariantProperties</c>, whose value is set to <c>true</c>, <c>ExcludeRetainedVariantProperties</c> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <c>EndpointConfig</c>. If you don't specify a value for <c>ExcludeRetainedVariantProperties</c>, no variant properties are overridden. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.BlueGreenUpdatePolicy_MaximumExecutionTimeoutInSecond"> <summary> <para> <para>Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in <c>TerminationWaitInSeconds</c> and <c>WaitIntervalInSeconds</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.RollingUpdatePolicy_MaximumExecutionTimeoutInSecond"> <summary> <para> <para>The time limit for the total deployment. Exceeding this limit causes a timeout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.RetainAllVariantProperty"> <summary> <para> <para>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <c>RetainAllVariantProperties</c> to <c>true</c>. To use the variant properties specified in a new <c>EndpointConfig</c> call when updating an endpoint, set <c>RetainAllVariantProperties</c> to <c>false</c>. The default is <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.RetainDeploymentConfig"> <summary> <para> <para>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.BlueGreenUpdatePolicy_TerminationWaitInSecond"> <summary> <para> <para>Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.CanarySize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.LinearStepSize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.TrafficRoutingConfiguration_Type"> <summary> <para> <para>Traffic routing strategy type.</para><ul><li><para><c>ALL_AT_ONCE</c>: Endpoint traffic shifts to the new fleet in a single step. </para></li><li><para><c>CANARY</c>: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic. </para></li><li><para><c>LINEAR</c>: Endpoint traffic shifts to the new fleet in n steps of a configurable size. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.MaximumBatchSize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.RollbackMaximumBatchSize_Type"> <summary> <para> <para>Specifies the endpoint capacity type.</para><ul><li><para><c>INSTANCE_COUNT</c>: The endpoint activates based on the number of instances.</para></li><li><para><c>CAPACITY_PERCENT</c>: The endpoint activates based on the specified percentage of capacity.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.CanarySize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.LinearStepSize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.MaximumBatchSize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.RollbackMaximumBatchSize_Value"> <summary> <para> <para>Defines the capacity size, either as a number of instances or a capacity percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.TrafficRoutingConfiguration_WaitIntervalInSecond"> <summary> <para> <para>The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMEndpointCmdlet.RollingUpdatePolicy_WaitIntervalInSecond"> <summary> <para> <para>The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.</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, SageMaker sets the endpoint status to <c>Updating</c>. After updating the endpoint, it sets the status to <c>InService</c>. To check the status of an endpoint, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/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 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.UpdateSMExperimentCmdlet"> <summary> Adds, updates, or removes the description of an experiment. Updates the display name of an experiment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMExperimentCmdlet.Description"> <summary> <para> <para>The description of the experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMExperimentCmdlet.DisplayName"> <summary> <para> <para>The name of the experiment as displayed. The name doesn't need to be unique. If <c>DisplayName</c> isn't specified, <c>ExperimentName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMExperimentCmdlet.ExperimentName"> <summary> <para> <para>The name of the experiment to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateExperimentResponse 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.UpdateSMExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExperimentName parameter. The -PassThru parameter is deprecated, use -Select '^ExperimentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMExperimentCmdlet.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.UpdateSMFeatureGroupCmdlet"> <summary> Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the <c>UpdateFeatureGroup</c> API. <para> You can add features for your feature group using the <c>FeatureAdditions</c> request parameter. Features cannot be removed from a feature group. </para><para> You can update the online store configuration by using the <c>OnlineStoreConfig</c> request parameter. If a <c>TtlDuration</c> is specified, the default <c>TtlDuration</c> applies for all records added to the feature group <i>after the feature group is updated</i>. If a record level <c>TtlDuration</c> exists from using the <c>PutRecord</c> API, the record level <c>TtlDuration</c> applies to that record instead of the default <c>TtlDuration</c>. To remove the default <c>TtlDuration</c> from an existing feature group, use the <c>UpdateFeatureGroup</c> API and set the <c>TtlDuration</c><c>Unit</c> and <c>Value</c> to <c>null</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.FeatureAddition"> <summary> <para> <para>Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the feature group that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.ThroughputConfig_ProvisionedReadCapacityUnit"> <summary> <para> <para>For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.ThroughputConfig_ProvisionedWriteCapacityUnit"> <summary> <para> <para>For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.ThroughputConfig_ThroughputMode"> <summary> <para> <para>Target throughput mode of the feature group. Throughput update is an asynchronous operation, and the outcome should be monitored by polling <c>LastUpdateStatus</c> field in <c>DescribeFeatureGroup</c> response. You cannot update a feature group's throughput while another update is in progress. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.TtlDuration_Unit"> <summary> <para> <para><c>TtlDuration</c> time unit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.TtlDuration_Value"> <summary> <para> <para><c>TtlDuration</c> time value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FeatureGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateFeatureGroupResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateFeatureGroupResponse 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.UpdateSMFeatureGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureGroupCmdlet.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.UpdateSMFeatureMetadataCmdlet"> <summary> Updates the description and parameters of the feature group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.Description"> <summary> <para> <para>A description that you can write to better describe the feature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.FeatureGroupName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.FeatureName"> <summary> <para> <para>The name of the feature that you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.ParameterAddition"> <summary> <para> <para>A list of key-value pairs that you can add to better describe the feature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.ParameterRemoval"> <summary> <para> <para>A list of parameter keys that you can specify to remove parameters that describe your feature.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.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.UpdateFeatureMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FeatureGroupName parameter. The -PassThru parameter is deprecated, use -Select '^FeatureGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMFeatureMetadataCmdlet.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.UpdateSMHubCmdlet"> <summary> Update a hub. <note><para> Hub APIs are only callable through SageMaker Studio. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMHubCmdlet.HubDescription"> <summary> <para> <para>A description of the updated hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMHubCmdlet.HubDisplayName"> <summary> <para> <para>The display name of the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMHubCmdlet.HubName"> <summary> <para> <para>The name of the hub to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMHubCmdlet.HubSearchKeyword"> <summary> <para> <para>The searchable keywords for the hub.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMHubCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HubArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateHubResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateHubResponse 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.UpdateSMHubCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HubName parameter. The -PassThru parameter is deprecated, use -Select '^HubName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMHubCmdlet.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.UpdateSMImageCmdlet"> <summary> Updates the properties of a SageMaker image. To change the image's tags, use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html">AddTags</a> and <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html">DeleteTags</a> APIs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.DeleteProperty"> <summary> <para> <para>A list of properties to delete. Only the <c>Description</c> and <c>DisplayName</c> properties can be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.Description"> <summary> <para> <para>The new description for the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.DisplayName"> <summary> <para> <para>The new display name for the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.ImageName"> <summary> <para> <para>The name of the image to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.RoleArn"> <summary> <para> <para>The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateImageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateImageResponse 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.UpdateSMImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageCmdlet.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.UpdateSMImageVersionCmdlet"> <summary> Updates the properties of a SageMaker image version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.Alias"> <summary> <para> <para>The alias of the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.AliasesToAdd"> <summary> <para> <para>A list of aliases to add.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.AliasesToDelete"> <summary> <para> <para>A list of aliases to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.Horovod"> <summary> <para> <para>Indicates Horovod compatibility.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.ImageName"> <summary> <para> <para>The name of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.JobType"> <summary> <para> <para>Indicates SageMaker job type compatibility.</para><ul><li><para><c>TRAINING</c>: The image version is compatible with SageMaker training jobs.</para></li><li><para><c>INFERENCE</c>: The image version is compatible with SageMaker inference jobs.</para></li><li><para><c>NOTEBOOK_KERNEL</c>: The image version is compatible with SageMaker notebook kernels.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.MLFramework"> <summary> <para> <para>The machine learning framework vended in the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.Processor"> <summary> <para> <para>Indicates CPU or GPU compatibility.</para><ul><li><para><c>CPU</c>: The image version is compatible with CPU.</para></li><li><para><c>GPU</c>: The image version is compatible with GPU.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.ProgrammingLang"> <summary> <para> <para>The supported programming language and its version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.ReleaseNote"> <summary> <para> <para>The maintainer description of the image version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.VendorGuidance"> <summary> <para> <para>The availability of the image version specified by the maintainer.</para><ul><li><para><c>NOT_PROVIDED</c>: The maintainers did not provide a status for image version stability.</para></li><li><para><c>STABLE</c>: The image version is stable.</para></li><li><para><c>TO_BE_ARCHIVED</c>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</para></li><li><para><c>ARCHIVED</c>: The image version is archived. Archived image versions are not searchable and are no longer actively supported. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.Version"> <summary> <para> <para>The version of the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageVersionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateImageVersionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateImageVersionResponse 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.UpdateSMImageVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImageName parameter. The -PassThru parameter is deprecated, use -Select '^ImageName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMImageVersionCmdlet.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.UpdateSMInferenceComponentCmdlet"> <summary> Updates an inference component. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.Container_ArtifactUrl"> <summary> <para> <para>The Amazon 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.UpdateSMInferenceComponentCmdlet.StartupParameters_ContainerStartupHealthCheckTimeoutInSecond"> <summary> <para> <para>The timeout value, in seconds, for your inference container to pass health check by Amazon S3 Hosting. For more information about health check, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-inference-code.html#your-algorithms-inference-algo-ping-requests">How Your Container Should Respond to Health Check (Ping) Requests</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.RuntimeConfig_CopyCount"> <summary> <para> <para>The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.Container_Environment"> <summary> <para> <para>The environment variables to set in the Docker container. Each key and value in the Environment string-to-string map can have length of up to 1024. We support up to 16 entries in the map.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.Container_Image"> <summary> <para> <para>The Amazon Elastic Container Registry (Amazon ECR) path where the Docker image for the model is stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.InferenceComponentName"> <summary> <para> <para>The name of the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.ComputeResourceRequirements_MaxMemoryRequiredInMb"> <summary> <para> <para>The maximum MB of memory to allocate to run a model that you assign to an inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.ComputeResourceRequirements_MinMemoryRequiredInMb"> <summary> <para> <para>The minimum MB of memory to allocate to run a model that you assign to an inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.StartupParameters_ModelDataDownloadTimeoutInSecond"> <summary> <para> <para>The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.Specification_ModelName"> <summary> <para> <para>The name of an existing SageMaker model object in your account that you want to deploy with the inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.ComputeResourceRequirements_NumberOfAcceleratorDevicesRequired"> <summary> <para> <para>The number of accelerators to allocate to run a model that you assign to an inference component. Accelerators include GPUs and Amazon Web Services Inferentia.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.ComputeResourceRequirements_NumberOfCpuCoresRequired"> <summary> <para> <para>The number of CPU cores to allocate to run a model that you assign to an inference component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceComponentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateInferenceComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateInferenceComponentResponse 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.UpdateSMInferenceComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InferenceComponentName parameter. The -PassThru parameter is deprecated, use -Select '^InferenceComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentCmdlet.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.UpdateSMInferenceComponentRuntimeConfigCmdlet"> <summary> Runtime settings for a model that is deployed with an inference component. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentRuntimeConfigCmdlet.DesiredRuntimeConfig_CopyCount"> <summary> <para> <para>The number of runtime copies of the model container to deploy with the inference component. Each copy can serve inference requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentRuntimeConfigCmdlet.InferenceComponentName"> <summary> <para> <para>The name of the inference component to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentRuntimeConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceComponentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateInferenceComponentRuntimeConfigResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateInferenceComponentRuntimeConfigResponse 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.UpdateSMInferenceComponentRuntimeConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InferenceComponentName parameter. The -PassThru parameter is deprecated, use -Select '^InferenceComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceComponentRuntimeConfigCmdlet.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.UpdateSMInferenceExperimentCmdlet"> <summary> Updates an inference experiment that you created. The status of the inference experiment has to be either <c>Created</c>, <c>Running</c>. For more information on the status of an inference experiment, see <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html">DescribeInferenceExperiment</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.ContentType_CsvContentType"> <summary> <para> <para>The list of all content type headers that Amazon SageMaker will treat as CSV and capture accordingly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.Description"> <summary> <para> <para>The description of the inference experiment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.DataStorageConfig_Destination"> <summary> <para> <para>The Amazon S3 bucket where the inference request and response data is stored. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.Schedule_EndTime"> <summary> <para> <para>The timestamp at which the inference experiment ended or will end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.ContentType_JsonContentType"> <summary> <para> <para>The list of all content type headers that SageMaker will treat as JSON and capture accordingly.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.DataStorageConfig_KmsKey"> <summary> <para> <para> The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.ModelVariant"> <summary> <para> <para> An array of <c>ModelVariantConfig</c> objects. There is one for each variant, whose infrastructure configuration you want to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.Name"> <summary> <para> <para>The name of the inference experiment to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.ShadowModeConfig_ShadowModelVariant"> <summary> <para> <para>List of shadow variant configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.ShadowModeConfig_SourceModelVariantName"> <summary> <para> <para> The name of the production variant, which takes all the inference requests. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.Schedule_StartTime"> <summary> <para> <para>The timestamp at which the inference experiment started or will start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InferenceExperimentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateInferenceExperimentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateInferenceExperimentResponse 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.UpdateSMInferenceExperimentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMInferenceExperimentCmdlet.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.UpdateSMModelCardCmdlet"> <summary> Update an Amazon SageMaker Model Card. <important><para> You cannot update both model card content and model card status in a single call. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelCardCmdlet.Content"> <summary> <para> <para>The updated model card content. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</para><para>When updating model card content, be sure to include the full content and not just updated content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelCardCmdlet.ModelCardName"> <summary> <para> <para>The name or Amazon Resource Name (ARN) of the model card to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelCardCmdlet.ModelCardStatus"> <summary> <para> <para>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</para><ul><li><para><c>Draft</c>: The model card is a work in progress.</para></li><li><para><c>PendingReview</c>: The model card is pending review.</para></li><li><para><c>Approved</c>: The model card is approved.</para></li><li><para><c>Archived</c>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelCardCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelCardArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateModelCardResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateModelCardResponse 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.UpdateSMModelCardCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelCardName parameter. The -PassThru parameter is deprecated, use -Select '^ModelCardName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelCardCmdlet.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.UpdateSMModelPackageCmdlet"> <summary> Updates a versioned model. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.AdditionalInferenceSpecificationsToAdd"> <summary> <para> <para>An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.ApprovalDescription"> <summary> <para> <para>A description for the approval status of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.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.UpdateSMModelPackageCmdlet.CustomerMetadataProperty"> <summary> <para> <para>The metadata properties associated with the model package versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.CustomerMetadataPropertiesToRemove"> <summary> <para> <para>The metadata properties associated with the model package versions to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.ModelApprovalStatus"> <summary> <para> <para>The approval status of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.ModelPackageArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.SourceUri"> <summary> <para> <para>The URI of the source for the model package.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.InferenceSpecification_SupportedContentType"> <summary> <para> <para>The supported MIME types for the input data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.InferenceSpecification_SupportedRealtimeInferenceInstanceType"> <summary> <para> <para>A list of the instance types that are used to generate inferences in real-time.</para><para>This parameter is required for unversioned models, and optional for versioned models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.InferenceSpecification_SupportedResponseMIMEType"> <summary> <para> <para>The supported MIME types for the output data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.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>This parameter is required for unversioned models, and optional for versioned models.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.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.UpdateModelPackageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateModelPackageResponse 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.UpdateSMModelPackageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageArn parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMModelPackageCmdlet.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.UpdateSMMonitoringAlertCmdlet"> <summary> Update the parameters of a model monitor alert. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringAlertCmdlet.DatapointsToAlert"> <summary> <para> <para>Within <c>EvaluationPeriod</c>, how many execution failures will raise an alert.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringAlertCmdlet.EvaluationPeriod"> <summary> <para> <para>The number of most recent monitoring executions to consider when evaluating alert status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringAlertCmdlet.MonitoringAlertName"> <summary> <para> <para>The name of a monitoring alert.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringAlertCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of a monitoring schedule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringAlertCmdlet.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.UpdateMonitoringAlertResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateMonitoringAlertResponse 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.UpdateSMMonitoringAlertCmdlet.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.UpdateSMMonitoringScheduleCmdlet"> <summary> Updates a previously created schedule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringScheduleCmdlet.MonitoringScheduleConfig"> <summary> <para> <para>The configuration object that specifies the monitoring schedule and defines the monitoring job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringScheduleCmdlet.MonitoringScheduleName"> <summary> <para> <para>The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MonitoringScheduleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateMonitoringScheduleResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateMonitoringScheduleResponse 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.UpdateSMMonitoringScheduleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MonitoringScheduleName parameter. The -PassThru parameter is deprecated, use -Select '^MonitoringScheduleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMMonitoringScheduleCmdlet.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="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.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">Amazon Web Services 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 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">Amazon Web Services 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 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 <c>true</c> 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.InstanceMetadataServiceConfiguration_MinimumInstanceMetadataServiceVersion"> <summary> <para> <para>Indicates the minimum IMDS version that the notebook instance supports. When passed as part of <c>CreateNotebookInstance</c>, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of <c>UpdateNotebookInstance</c>, there is no default.</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 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">SageMaker Roles</a>. </para><note><para>To be able to pass this role to SageMaker, the caller of this API must have the <c>iam:PassRole</c> 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 <c>Enabled</c>.</para><note><para>If you set this to <c>Disabled</c>, 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 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 href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html">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.UpdateSMPipelineCmdlet"> <summary> Updates a pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineDefinitionS3Location_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.ParallelismConfiguration_MaxParallelExecutionStep"> <summary> <para> <para>The max number of steps that can be executed in parallel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineDefinitionS3Location_ObjectKey"> <summary> <para> <para>The object key (or key name) uniquely identifies the object in an S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineDefinition"> <summary> <para> <para>The JSON pipeline definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineDescription"> <summary> <para> <para>The description of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineDisplayName"> <summary> <para> <para>The display name of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) that the pipeline uses to execute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.PipelineDefinitionS3Location_VersionId"> <summary> <para> <para>Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdatePipelineResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdatePipelineResponse 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.UpdateSMPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineCmdlet.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.UpdateSMPipelineExecutionCmdlet"> <summary> Updates a pipeline execution. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineExecutionCmdlet.ParallelismConfiguration_MaxParallelExecutionStep"> <summary> <para> <para>The max number of steps that can be executed in parallel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineExecutionCmdlet.PipelineExecutionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineExecutionCmdlet.PipelineExecutionDescription"> <summary> <para> <para>The description of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineExecutionCmdlet.PipelineExecutionDisplayName"> <summary> <para> <para>The display name of the pipeline execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineExecutionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineExecutionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdatePipelineExecutionResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdatePipelineExecutionResponse 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.UpdateSMPipelineExecutionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineExecutionArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineExecutionArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMPipelineExecutionCmdlet.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.UpdateSMProjectCmdlet"> <summary> Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model. <note><para> You must not update a project that is in use. If you update the <c>ServiceCatalogProvisioningUpdateDetails</c> of a project that is active or being created, or updated, you may lose resources already created by the project. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.ProjectDescription"> <summary> <para> <para>The description for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.ServiceCatalogProvisioningUpdateDetails_ProvisioningArtifactId"> <summary> <para> <para>The ID of the provisioning artifact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.ServiceCatalogProvisioningUpdateDetails_ProvisioningParameter"> <summary> <para> <para>A list of key value pairs that you specify when you provision a product.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.Tag"> <summary> <para> <para>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see <a href="https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html">Amazon Web Services Service Catalog Tag Update Constraints</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateProjectResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateProjectResponse 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.UpdateSMProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMProjectCmdlet.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.UpdateSMSpaceCmdlet"> <summary> Updates the settings of a space. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_AppType"> <summary> <para> <para>The type of app created within the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.JupyterLabAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterLab application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.JupyterServerAppSettings_CodeRepository"> <summary> <para> <para>A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_CustomFileSystem"> <summary> <para> <para>A file system, created by you, that you assign to a space for an Amazon SageMaker Domain. Permitted users can access this file system in Amazon SageMaker Studio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.KernelGatewayAppSettings_CustomImage"> <summary> <para> <para>A list of custom SageMaker images that are configured to run as a KernelGateway app.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.DomainId"> <summary> <para> <para>The ID of the associated domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.EbsStorageSettings_EbsVolumeSizeInGb"> <summary> <para> <para>The size of an EBS storage volume for a space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_InstanceType"> <summary> <para> <para>The instance type that the image version runs on.</para><note><para><b>JupyterServer apps</b> only support the <c>system</c> value.</para><para>For <b>KernelGateway apps</b>, the <c>system</c> value is translated to <c>ml.t3.medium</c>. KernelGateway apps also support all other values for available instance types.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.JupyterServerAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the <c>DefaultResourceSpec</c> parameter is also required.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.KernelGatewayAppSettings_LifecycleConfigArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.</para><note><para>To remove a Lifecycle Config, you must set <c>LifecycleConfigArns</c> to an empty list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageArn"> <summary> <para> <para>The ARN of the SageMaker image that the image version belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionAlias"> <summary> <para> <para>The SageMakerImageVersionAlias of the image to launch with. This value is in SemVer 2.0.0 versioning format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_CodeEditorAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterLabAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_JupyterServerAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceSettings_KernelGatewayAppSettings_DefaultResourceSpec_SageMakerImageVersionArn"> <summary> <para> <para>The ARN of the image version created on the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceDisplayName"> <summary> <para> <para>The name of the space that appears in the Amazon SageMaker Studio UI.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.SpaceName"> <summary> <para> <para>The name of the space.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SpaceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateSpaceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateSpaceResponse 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.UpdateSMSpaceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SpaceName parameter. The -PassThru parameter is deprecated, use -Select '^SpaceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMSpaceCmdlet.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.UpdateSMTrainingJobCmdlet"> <summary> Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.ProfilerConfig_DisableProfiler"> <summary> <para> <para>To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to <c>True</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.RemoteDebugConfig_EnableRemoteDebug"> <summary> <para> <para>If set to True, enables remote debugging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.ResourceConfig_KeepAlivePeriodInSecond"> <summary> <para> <para>The <c>KeepAlivePeriodInSeconds</c> value specified in the <c>ResourceConfig</c> to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.ProfilerRuleConfiguration"> <summary> <para> <para>Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.ProfilerConfig_ProfilingIntervalInMillisecond"> <summary> <para> <para>A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.ProfilerConfig_ProfilingParameter"> <summary> <para> <para>Configuration information for capturing framework metrics. Available key strings for different profiling options are <c>DetailedProfilingConfig</c>, <c>PythonProfilingConfig</c>, and <c>DataLoaderProfilingConfig</c>. The following codes are configuration structures for the <c>ProfilingParameters</c> parameter. To learn more about how to configure the <c>ProfilingParameters</c> parameter, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html">Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.ProfilerConfig_S3OutputPath"> <summary> <para> <para>Path to Amazon S3 storage location for system and framework metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.TrainingJobName"> <summary> <para> <para>The name of a training job to update the Debugger profiling configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrainingJobCmdlet.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.UpdateTrainingJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateTrainingJobResponse 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.UpdateSMTrainingJobCmdlet.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.UpdateSMTrainingJobCmdlet.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.UpdateSMTrialCmdlet"> <summary> Updates the display name of a trial. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialCmdlet.DisplayName"> <summary> <para> <para>The name of the trial as displayed. The name doesn't need to be unique. If <c>DisplayName</c> isn't specified, <c>TrialName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialCmdlet.TrialName"> <summary> <para> <para>The name of the trial to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateTrialResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateTrialResponse 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.UpdateSMTrialCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialName parameter. The -PassThru parameter is deprecated, use -Select '^TrialName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialCmdlet.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.UpdateSMTrialComponentCmdlet"> <summary> Updates one or more properties of a trial component. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.DisplayName"> <summary> <para> <para>The name of the component as displayed. The name doesn't need to be unique. If <c>DisplayName</c> isn't specified, <c>TrialComponentName</c> is displayed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.EndTime"> <summary> <para> <para>When the component ended.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.InputArtifact"> <summary> <para> <para>Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.InputArtifactsToRemove"> <summary> <para> <para>The input artifacts to remove from the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.Status_Message"> <summary> <para> <para>If the component failed, a message describing why.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.OutputArtifact"> <summary> <para> <para>Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.OutputArtifactsToRemove"> <summary> <para> <para>The output artifacts to remove from the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.Parameter"> <summary> <para> <para>Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.ParametersToRemove"> <summary> <para> <para>The hyperparameters to remove from the component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.Status_PrimaryStatus"> <summary> <para> <para>The status of the trial component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.StartTime"> <summary> <para> <para>When the component started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.TrialComponentName"> <summary> <para> <para>The name of the component to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrialComponentArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateTrialComponentResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateTrialComponentResponse 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.UpdateSMTrialComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrialComponentName parameter. The -PassThru parameter is deprecated, use -Select '^TrialComponentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMTrialComponentCmdlet.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.UpdateSMUserProfileCmdlet"> <summary> Updates a user profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMUserProfileCmdlet.DomainId"> <summary> <para> <para>The domain ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMUserProfileCmdlet.UserProfileName"> <summary> <para> <para>The user profile name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMUserProfileCmdlet.UserSetting"> <summary> <para> <para>A collection of settings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMUserProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserProfileArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateUserProfileResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateUserProfileResponse 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.UpdateSMUserProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserProfileName parameter. The -PassThru parameter is deprecated, use -Select '^UserProfileName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMUserProfileCmdlet.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.UpdateSMWorkforceCmdlet"> <summary> Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration. <para> The worker portal is now supported in VPC and public internet. </para><para> Use <c>SourceIpConfig</c> to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>. By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a <c>Not Found</c> error message on the worker portal. </para><para> To restrict access to all the workers in public internet, add the <c>SourceIpConfig</c> CIDR value as "10.0.0.0/16". </para><important><para> Amazon SageMaker does not support Source Ip restriction for worker portals in VPC. </para></important><para> Use <c>OidcConfig</c> to update the configuration of a workforce created using your own OIDC IdP. </para><important><para> You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html">DeleteWorkteam</a> operation. </para></important><para> After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html">DescribeWorkforce</a> operation. </para><important><para> This operation only applies to private workforces. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_AuthorizationEndpoint"> <summary> <para> <para>The OIDC IdP authorization endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.SourceIpConfig_Cidr"> <summary> <para> <para>A list of one to ten <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">Classless Inter-Domain Routing</a> (CIDR) values.</para><para>Maximum: Ten CIDR values</para><note><para>The following Length Constraints apply to individual CIDR values in the CIDR value list.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_ClientId"> <summary> <para> <para>The OIDC IdP client ID used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_ClientSecret"> <summary> <para> <para>The OIDC IdP client secret used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_Issuer"> <summary> <para> <para>The OIDC IdP issuer used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_JwksUri"> <summary> <para> <para>The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_LogoutEndpoint"> <summary> <para> <para>The OIDC IdP logout endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.WorkforceVpcConfig_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.UpdateSMWorkforceCmdlet.WorkforceVpcConfig_Subnet"> <summary> <para> <para>The ID of the subnets in the VPC that you want to connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_TokenEndpoint"> <summary> <para> <para>The OIDC IdP token endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.OidcConfig_UserInfoEndpoint"> <summary> <para> <para>The OIDC IdP user information endpoint used to configure your private workforce.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.WorkforceVpcConfig_VpcId"> <summary> <para> <para>The ID of the VPC that the workforce uses for communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.WorkforceName"> <summary> <para> <para>The name of the private workforce that you want to update. You can find your workforce name by using the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html">ListWorkforces</a> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Workforce'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateWorkforceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateWorkforceResponse 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.UpdateSMWorkforceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkforceName parameter. The -PassThru parameter is deprecated, use -Select '^WorkforceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkforceCmdlet.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 <c>MemberDefinition</c> objects that contains objects that identify the workers that make up the work team. </para><para>Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use <c>CognitoMemberDefinition</c>. For workforces created using your own OIDC identity provider (IdP) use <c>OidcMemberDefinition</c>. You should not provide input for both of these parameters in a single request.</para><para>For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito <i>user groups</i> within the user pool used to create a workforce. All of the <c>CognitoMemberDefinition</c> objects that make up the member definition must have the same <c>ClientId</c> and <c>UserPool</c> values. To add a Amazon Cognito user group to an existing worker pool, see <a href="">Adding groups to a User Pool</a>. For more information about user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito User Pools</a>.</para><para>For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in <c>OidcMemberDefinition</c> by listing those groups in <c>Groups</c>. Be aware that user groups that are already in the work team must also be listed in <c>Groups</c> when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.UpdateSMWorkteamCmdlet.NotificationConfiguration_NotificationTopicArn"> <summary> <para> <para>The ARN for the Amazon 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> <member name="T:Amazon.PowerShell.Cmdlets.SM.WriteSMModelPackageGroupPolicyCmdlet"> <summary> Adds a resouce policy to control access to a model group. For information about resoure policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html">Identity-based policies and resource-based policies</a> in the <i>Amazon Web Services Identity and Access Management User Guide.</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.WriteSMModelPackageGroupPolicyCmdlet.ModelPackageGroupName"> <summary> <para> <para>The name of the model group to add a resource policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.WriteSMModelPackageGroupPolicyCmdlet.ResourcePolicy"> <summary> <para> <para>The resource policy for the model group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.WriteSMModelPackageGroupPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelPackageGroupArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.PutModelPackageGroupPolicyResponse). Specifying the name of a property of type Amazon.SageMaker.Model.PutModelPackageGroupPolicyResponse 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.WriteSMModelPackageGroupPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ModelPackageGroupName parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageGroupName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SM.WriteSMModelPackageGroupPolicyCmdlet.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> |