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 Comprehend CreateFlywheel API operation.

Syntax

New-COMPFlywheel
-ActiveModelArn <String>
-ClientRequestToken <String>
-DataAccessRoleArn <String>
-DataSecurityConfig_DataLakeKmsKeyId <String>
-DataLakeS3Uri <String>
-EntityRecognitionConfig_EntityType <EntityTypesListItem[]>
-FlywheelName <String>
-DocumentClassificationConfig_Label <String[]>
-TaskConfig_LanguageCode <LanguageCode>
-DocumentClassificationConfig_Mode <DocumentClassifierMode>
-DataSecurityConfig_ModelKmsKeyId <String>
-ModelType <ModelType>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_Subnet <String[]>
-Tag <Tag[]>
-DataSecurityConfig_VolumeKmsKeyId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonComprehendConfig>

Description

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's training data and test data into the flywheel's data lake. To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) when you create the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Parameters

-ActiveModelArn <String>
To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonComprehendConfig>
Amazon.PowerShell.Cmdlets.COMP.AmazonComprehendClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataAccessRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataLakeS3Uri <String>
Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSecurityConfig_DataLakeKmsKeyId <String>
ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSecurityConfig_ModelKmsKeyId <String>
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSecurityConfig_VolumeKmsKeyId <String>
ID for the KMS key that Amazon Comprehend uses to encrypt the volume.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentClassificationConfig_Label <String[]>
One or more labels to associate with the custom classifier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTaskConfig_DocumentClassificationConfig_Labels
-DocumentClassificationConfig_Mode <DocumentClassifierMode>
Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTaskConfig_DocumentClassificationConfig_Mode
-EntityRecognitionConfig_EntityType <EntityTypesListItem[]>
Up to 25 entity types that the model is trained to recognize.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTaskConfig_EntityRecognitionConfig_EntityTypes
-FlywheelName <String>
Name for the flywheel.
Required?True
Position?Named
Accept pipeline input?True (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)
-ModelType <ModelType>
The model type. You need to set ModelType if you are creating a flywheel for a new model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.Comprehend.Model.CreateFlywheelResponse). Specifying the name of a property of type Amazon.Comprehend.Model.CreateFlywheelResponse 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[]>
The tags to associate with this flywheel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TaskConfig_LanguageCode <LanguageCode>
Language code for the language that the model supports.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VpcConfig_SecurityGroupId <String[]>
The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSecurityConfig_VpcConfig_SecurityGroupIds
-VpcConfig_Subnet <String[]>
The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSecurityConfig_VpcConfig_Subnets

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

Amazon.Comprehend.Model.CreateFlywheelResponse
This cmdlet returns an Amazon.Comprehend.Model.CreateFlywheelResponse object containing multiple properties.
Developer Guide
AWS Tools for PowerShell User Guide

Supported Version

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