AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service CreateFlowDefinition API operation.

Syntax

New-SMFlowDefinition
-FlowDefinitionName <String>
-HumanLoopRequestSource_AwsManagedHumanLoopRequestSource <AwsManagedHumanLoopRequestSource>
-AmountInUsd_Cent <Int32>
-AmountInUsd_Dollar <Int32>
-HumanLoopActivationConditionsConfig_HumanLoopActivationCondition <String>
-HumanLoopConfig_HumanTaskUiArn <String>
-OutputConfig_KmsKeyId <String>
-RoleArn <String>
-OutputConfig_S3OutputPath <String>
-Tag <Tag[]>
-HumanLoopConfig_TaskAvailabilityLifetimeInSecond <Int32>
-HumanLoopConfig_TaskCount <Int32>
-HumanLoopConfig_TaskDescription <String>
-HumanLoopConfig_TaskKeyword <String[]>
-HumanLoopConfig_TaskTimeLimitInSecond <Int32>
-HumanLoopConfig_TaskTitle <String>
-AmountInUsd_TenthFractionsOfACent <Int32>
-HumanLoopConfig_WorkteamArn <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a flow definition.

Parameters

-AmountInUsd_Cent <Int32>
The fractional portion, in cents, of the amount.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_PublicWorkforceTaskPrice_AmountInUsd_Cents
-AmountInUsd_Dollar <Int32>
The whole number of dollars in the amount.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_PublicWorkforceTaskPrice_AmountInUsd_Dollars
-AmountInUsd_TenthFractionsOfACent <Int32>
Fractions of a cent, in tenths.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_PublicWorkforceTaskPrice_AmountInUsd_TenthFractionsOfACent
-FlowDefinitionName <String>
The name of your flow definition.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopActivationConditionsConfig_HumanLoopActivationCondition <String>
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 JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopActivationConfig_HumanLoopActivationConditionsConfig_HumanLoopActivationConditions
-HumanLoopConfig_HumanTaskUiArn <String>
The Amazon Resource Name (ARN) of the human task user interface.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.To learn how to create a custom HTML template, see Create Custom Worker Task Template.To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopConfig_TaskAvailabilityLifetimeInSecond <Int32>
The length of time that a task remains available for review by human workers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_TaskAvailabilityLifetimeInSeconds
-HumanLoopConfig_TaskCount <Int32>
The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopConfig_TaskDescription <String>
A description for the human worker task.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopConfig_TaskKeyword <String[]>
Keywords used to describe the task so that workers can discover the task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_TaskKeywords
-HumanLoopConfig_TaskTimeLimitInSecond <Int32>
The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHumanLoopConfig_TaskTimeLimitInSeconds
-HumanLoopConfig_TaskTitle <String>
A title for the human worker task.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopConfig_WorkteamArn <String>
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 Create and Manage Workforces.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-HumanLoopRequestSource_AwsManagedHumanLoopRequestSource <AwsManagedHumanLoopRequestSource>
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:
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConfig_KmsKeyId <String>
The Amazon Key Management Service (KMS) key ID for server-side encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConfig_S3OutputPath <String>
The Amazon S3 path where the object containing human output will be made available.To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SageMaker.Model.CreateFlowDefinitionResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateFlowDefinitionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z