ComprehendMedical / Client / start_snomedct_inference_job

start_snomedct_inference_job#

ComprehendMedical.Client.start_snomedct_inference_job(**kwargs)#

Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.

See also: AWS API Documentation

Request Syntax

response = client.start_snomedct_inference_job(
    InputDataConfig={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    OutputDataConfig={
        'S3Bucket': 'string',
        'S3Key': 'string'
    },
    DataAccessRoleArn='string',
    JobName='string',
    ClientRequestToken='string',
    KMSKey='string',
    LanguageCode='en'
)
Parameters:

  • InputDataConfig (dict) –

    [REQUIRED]

    The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.

    • S3Bucket (string) – [REQUIRED]

      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.

    • S3Key (string) –

      The path to the input data files in the S3 bucket.

  • OutputDataConfig (dict) –

    [REQUIRED]

    The output properties for a detection job.

    • S3Bucket (string) – [REQUIRED]

      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.

    • S3Key (string) –

      The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.

  • DataAccessRoleArn (string) –

    [REQUIRED]

    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.

  • JobName (string) – The user generated name the asynchronous InferSNOMEDCT job.

  • ClientRequestToken (string) –

    A unique identifier for the request. If you don’t set the client request token, Amazon Comprehend Medical generates one.

    This field is autopopulated if not provided.

  • KMSKey (string) – An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

  • LanguageCode (string) –

    [REQUIRED]

    The language of the input documents. All documents must be in the same language.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string'
}

Response Structure

  • (dict) –

    • JobId (string) –

      The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.

Exceptions

  • ComprehendMedical.Client.exceptions.InvalidRequestException

  • ComprehendMedical.Client.exceptions.TooManyRequestsException

  • ComprehendMedical.Client.exceptions.ResourceNotFoundException

  • ComprehendMedical.Client.exceptions.InternalServerException