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 AWS Comprehend Medical StartPHIDetectionJob API operation.

Syntax

Start-CMPMPersonalHealthInformationDetectionJob
-ClientRequestToken <String>
-DataAccessRoleArn <String>
-JobName <String>
-KMSKey <String>
-LanguageCode <LanguageCode>
-InputDataConfig_S3Bucket <String>
-OutputDataConfig_S3Bucket <String>
-InputDataConfig_S3Key <String>
-OutputDataConfig_S3Key <String>
-Select <String>
-Force <SwitchParameter>

Description

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

Parameters

-ClientRequestToken <String>
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataAccessRoleArn <String>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-InputDataConfig_S3Bucket <String>
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputDataConfig_S3Key <String>
The path to the input data files in the S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobName <String>
The identifier of the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSKey <String>
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LanguageCode <LanguageCode>
The language of the input documents. All documents must be in the same language.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_S3Bucket <String>
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_S3Key <String>
The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComprehendMedical.Model.StartPHIDetectionJobResponse). Specifying the name of a property of type Amazon.ComprehendMedical.Model.StartPHIDetectionJobResponse 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)

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

This cmdlet returns a System.String object. The service call response (type Amazon.ComprehendMedical.Model.StartPHIDetectionJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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