Documentation

Overview

    Package comprehendmedical provides the API client, operations, and parameter types for AWS Comprehend Medical.

    Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-10-30"
    View Source
    const ServiceID = "ComprehendMedical"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Comprehend Medical.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) DescribeEntitiesDetectionV2Job

                func (c *Client) DescribeEntitiesDetectionV2Job(ctx context.Context, params *DescribeEntitiesDetectionV2JobInput, optFns ...func(*Options)) (*DescribeEntitiesDetectionV2JobOutput, error)

                  Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

                  func (*Client) DescribeICD10CMInferenceJob

                  func (c *Client) DescribeICD10CMInferenceJob(ctx context.Context, params *DescribeICD10CMInferenceJobInput, optFns ...func(*Options)) (*DescribeICD10CMInferenceJobOutput, error)

                    Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.

                    func (*Client) DescribePHIDetectionJob

                    func (c *Client) DescribePHIDetectionJob(ctx context.Context, params *DescribePHIDetectionJobInput, optFns ...func(*Options)) (*DescribePHIDetectionJobOutput, error)

                      Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

                      func (*Client) DescribeRxNormInferenceJob

                      func (c *Client) DescribeRxNormInferenceJob(ctx context.Context, params *DescribeRxNormInferenceJobInput, optFns ...func(*Options)) (*DescribeRxNormInferenceJobOutput, error)

                        Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

                        func (*Client) DetectEntities

                        func (c *Client) DetectEntities(ctx context.Context, params *DetectEntitiesInput, optFns ...func(*Options)) (*DetectEntitiesOutput, error)

                          The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead. Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

                          Deprecated: This operation is deprecated, use DetectEntitiesV2 instead.

                          func (*Client) DetectEntitiesV2

                          func (c *Client) DetectEntitiesV2(ctx context.Context, params *DetectEntitiesV2Input, optFns ...func(*Options)) (*DetectEntitiesV2Output, error)

                            Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts. The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications. The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

                            func (*Client) DetectPHI

                            func (c *Client) DetectPHI(ctx context.Context, params *DetectPHIInput, optFns ...func(*Options)) (*DetectPHIOutput, error)

                              Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

                              func (*Client) InferICD10CM

                              func (c *Client) InferICD10CM(ctx context.Context, params *InferICD10CMInput, optFns ...func(*Options)) (*InferICD10CMOutput, error)

                                InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.

                                func (*Client) InferRxNorm

                                func (c *Client) InferRxNorm(ctx context.Context, params *InferRxNormInput, optFns ...func(*Options)) (*InferRxNormOutput, error)

                                  InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.

                                  func (*Client) ListEntitiesDetectionV2Jobs

                                  func (c *Client) ListEntitiesDetectionV2Jobs(ctx context.Context, params *ListEntitiesDetectionV2JobsInput, optFns ...func(*Options)) (*ListEntitiesDetectionV2JobsOutput, error)

                                    Gets a list of medical entity detection jobs that you have submitted.

                                    func (*Client) ListICD10CMInferenceJobs

                                    func (c *Client) ListICD10CMInferenceJobs(ctx context.Context, params *ListICD10CMInferenceJobsInput, optFns ...func(*Options)) (*ListICD10CMInferenceJobsOutput, error)

                                      Gets a list of InferICD10CM jobs that you have submitted.

                                      func (*Client) ListPHIDetectionJobs

                                      func (c *Client) ListPHIDetectionJobs(ctx context.Context, params *ListPHIDetectionJobsInput, optFns ...func(*Options)) (*ListPHIDetectionJobsOutput, error)

                                        Gets a list of protected health information (PHI) detection jobs that you have submitted.

                                        func (*Client) ListRxNormInferenceJobs

                                        func (c *Client) ListRxNormInferenceJobs(ctx context.Context, params *ListRxNormInferenceJobsInput, optFns ...func(*Options)) (*ListRxNormInferenceJobsOutput, error)

                                          Gets a list of InferRxNorm jobs that you have submitted.

                                          func (*Client) StartEntitiesDetectionV2Job

                                          func (c *Client) StartEntitiesDetectionV2Job(ctx context.Context, params *StartEntitiesDetectionV2JobInput, optFns ...func(*Options)) (*StartEntitiesDetectionV2JobOutput, error)

                                            Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

                                            func (*Client) StartICD10CMInferenceJob

                                            func (c *Client) StartICD10CMInferenceJob(ctx context.Context, params *StartICD10CMInferenceJobInput, optFns ...func(*Options)) (*StartICD10CMInferenceJobOutput, error)

                                              Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.

                                              func (*Client) StartPHIDetectionJob

                                              func (c *Client) StartPHIDetectionJob(ctx context.Context, params *StartPHIDetectionJobInput, optFns ...func(*Options)) (*StartPHIDetectionJobOutput, error)

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

                                                func (*Client) StartRxNormInferenceJob

                                                func (c *Client) StartRxNormInferenceJob(ctx context.Context, params *StartRxNormInferenceJobInput, optFns ...func(*Options)) (*StartRxNormInferenceJobOutput, error)

                                                  Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job.

                                                  func (*Client) StopEntitiesDetectionV2Job

                                                  func (c *Client) StopEntitiesDetectionV2Job(ctx context.Context, params *StopEntitiesDetectionV2JobInput, optFns ...func(*Options)) (*StopEntitiesDetectionV2JobOutput, error)

                                                    Stops a medical entities detection job in progress.

                                                    func (*Client) StopICD10CMInferenceJob

                                                    func (c *Client) StopICD10CMInferenceJob(ctx context.Context, params *StopICD10CMInferenceJobInput, optFns ...func(*Options)) (*StopICD10CMInferenceJobOutput, error)

                                                      Stops an InferICD10CM inference job in progress.

                                                      func (*Client) StopPHIDetectionJob

                                                      func (c *Client) StopPHIDetectionJob(ctx context.Context, params *StopPHIDetectionJobInput, optFns ...func(*Options)) (*StopPHIDetectionJobOutput, error)

                                                        Stops a protected health information (PHI) detection job in progress.

                                                        func (*Client) StopRxNormInferenceJob

                                                        func (c *Client) StopRxNormInferenceJob(ctx context.Context, params *StopRxNormInferenceJobInput, optFns ...func(*Options)) (*StopRxNormInferenceJobOutput, error)

                                                          Stops an InferRxNorm inference job in progress.

                                                          type DescribeEntitiesDetectionV2JobInput

                                                          type DescribeEntitiesDetectionV2JobInput struct {
                                                          
                                                          	// The identifier that Amazon Comprehend Medical generated for the job. The
                                                          	// StartEntitiesDetectionV2Job operation returns this identifier in its response.
                                                          	//
                                                          	// This member is required.
                                                          	JobId *string
                                                          }

                                                          type DescribeEntitiesDetectionV2JobOutput

                                                          type DescribeEntitiesDetectionV2JobOutput struct {
                                                          
                                                          	// An object that contains the properties associated with a detection job.
                                                          	ComprehendMedicalAsyncJobProperties *types.ComprehendMedicalAsyncJobProperties
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type DescribeICD10CMInferenceJobInput

                                                          type DescribeICD10CMInferenceJobInput struct {
                                                          
                                                          	// The identifier that Amazon Comprehend Medical generated for the job. The
                                                          	// StartICD10CMInferenceJob operation returns this identifier in its response.
                                                          	//
                                                          	// This member is required.
                                                          	JobId *string
                                                          }

                                                          type DescribeICD10CMInferenceJobOutput

                                                          type DescribeICD10CMInferenceJobOutput struct {
                                                          
                                                          	// An object that contains the properties associated with a detection job.
                                                          	ComprehendMedicalAsyncJobProperties *types.ComprehendMedicalAsyncJobProperties
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type DescribePHIDetectionJobInput

                                                          type DescribePHIDetectionJobInput struct {
                                                          
                                                          	// The identifier that Amazon Comprehend Medical generated for the job. The
                                                          	// StartPHIDetectionJob operation returns this identifier in its response.
                                                          	//
                                                          	// This member is required.
                                                          	JobId *string
                                                          }

                                                          type DescribePHIDetectionJobOutput

                                                          type DescribePHIDetectionJobOutput struct {
                                                          
                                                          	// An object that contains the properties associated with a detection job.
                                                          	ComprehendMedicalAsyncJobProperties *types.ComprehendMedicalAsyncJobProperties
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type DescribeRxNormInferenceJobInput

                                                          type DescribeRxNormInferenceJobInput struct {
                                                          
                                                          	// The identifier that Amazon Comprehend Medical generated for the job. The
                                                          	// StartRxNormInferenceJob operation returns this identifier in its response.
                                                          	//
                                                          	// This member is required.
                                                          	JobId *string
                                                          }

                                                          type DescribeRxNormInferenceJobOutput

                                                          type DescribeRxNormInferenceJobOutput struct {
                                                          
                                                          	// An object that contains the properties associated with a detection job.
                                                          	ComprehendMedicalAsyncJobProperties *types.ComprehendMedicalAsyncJobProperties
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type DetectEntitiesInput

                                                          type DetectEntitiesInput struct {
                                                          
                                                          	// A UTF-8 text string containing the clinical content being examined for entities.
                                                          	// Each string must contain fewer than 20,000 bytes of characters.
                                                          	//
                                                          	// This member is required.
                                                          	Text *string
                                                          }

                                                          type DetectEntitiesOutput

                                                          type DetectEntitiesOutput struct {
                                                          
                                                          	// The collection of medical entities extracted from the input text and their
                                                          	// associated information. For each entity, the response provides the entity text,
                                                          	// the entity category, where the entity text begins and ends, and the level of
                                                          	// confidence that Amazon Comprehend Medical has in the detection and analysis.
                                                          	// Attributes and traits of the entity are also returned.
                                                          	//
                                                          	// This member is required.
                                                          	Entities []types.Entity
                                                          
                                                          	// The version of the model used to analyze the documents. The version number looks
                                                          	// like X.X.X. You can use this information to track the model used for a
                                                          	// particular batch of documents.
                                                          	//
                                                          	// This member is required.
                                                          	ModelVersion *string
                                                          
                                                          	// If the result of the previous request to DetectEntities was truncated, include
                                                          	// the PaginationToken to fetch the next page of entities.
                                                          	PaginationToken *string
                                                          
                                                          	// Attributes extracted from the input text that we were unable to relate to an
                                                          	// entity.
                                                          	UnmappedAttributes []types.UnmappedAttribute
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type DetectEntitiesV2Input

                                                          type DetectEntitiesV2Input struct {
                                                          
                                                          	// A UTF-8 string containing the clinical content being examined for entities. Each
                                                          	// string must contain fewer than 20,000 bytes of characters.
                                                          	//
                                                          	// This member is required.
                                                          	Text *string
                                                          }

                                                          type DetectEntitiesV2Output

                                                          type DetectEntitiesV2Output struct {
                                                          
                                                          	// The collection of medical entities extracted from the input text and their
                                                          	// associated information. For each entity, the response provides the entity text,
                                                          	// the entity category, where the entity text begins and ends, and the level of
                                                          	// confidence in the detection and analysis. Attributes and traits of the entity
                                                          	// are also returned.
                                                          	//
                                                          	// This member is required.
                                                          	Entities []types.Entity
                                                          
                                                          	// The version of the model used to analyze the documents. The version number looks
                                                          	// like X.X.X. You can use this information to track the model used for a
                                                          	// particular batch of documents.
                                                          	//
                                                          	// This member is required.
                                                          	ModelVersion *string
                                                          
                                                          	// If the result to the DetectEntitiesV2 operation was truncated, include the
                                                          	// PaginationToken to fetch the next page of entities.
                                                          	PaginationToken *string
                                                          
                                                          	// Attributes extracted from the input text that couldn't be related to an entity.
                                                          	UnmappedAttributes []types.UnmappedAttribute
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type DetectPHIInput

                                                          type DetectPHIInput struct {
                                                          
                                                          	// A UTF-8 text string containing the clinical content being examined for PHI
                                                          	// entities. Each string must contain fewer than 20,000 bytes of characters.
                                                          	//
                                                          	// This member is required.
                                                          	Text *string
                                                          }

                                                          type DetectPHIOutput

                                                          type DetectPHIOutput struct {
                                                          
                                                          	// The collection of PHI entities extracted from the input text and their
                                                          	// associated information. For each entity, the response provides the entity text,
                                                          	// the entity category, where the entity text begins and ends, and the level of
                                                          	// confidence that Amazon Comprehend Medical has in its detection.
                                                          	//
                                                          	// This member is required.
                                                          	Entities []types.Entity
                                                          
                                                          	// The version of the model used to analyze the documents. The version number looks
                                                          	// like X.X.X. You can use this information to track the model used for a
                                                          	// particular batch of documents.
                                                          	//
                                                          	// This member is required.
                                                          	ModelVersion *string
                                                          
                                                          	// If the result of the previous request to DetectPHI was truncated, include the
                                                          	// PaginationToken to fetch the next page of PHI entities.
                                                          	PaginationToken *string
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type EndpointResolver

                                                          type EndpointResolver interface {
                                                          	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                          }

                                                            EndpointResolver interface for resolving service endpoints.

                                                            func EndpointResolverFromURL

                                                            func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                              EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                              type EndpointResolverFunc

                                                              type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                                                EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                                                func (EndpointResolverFunc) ResolveEndpoint

                                                                func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                                type EndpointResolverOptions

                                                                type EndpointResolverOptions = internalendpoints.Options

                                                                  EndpointResolverOptions is the service endpoint resolver options

                                                                  type HTTPClient

                                                                  type HTTPClient interface {
                                                                  	Do(*http.Request) (*http.Response, error)
                                                                  }

                                                                  type HTTPSignerV4

                                                                  type HTTPSignerV4 interface {
                                                                  	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                                  }

                                                                  type IdempotencyTokenProvider

                                                                  type IdempotencyTokenProvider interface {
                                                                  	GetIdempotencyToken() (string, error)
                                                                  }

                                                                    IdempotencyTokenProvider interface for providing idempotency token

                                                                    type InferICD10CMInput

                                                                    type InferICD10CMInput struct {
                                                                    
                                                                    	// The input text used for analysis. The input for InferICD10CM is a string from 1
                                                                    	// to 10000 characters.
                                                                    	//
                                                                    	// This member is required.
                                                                    	Text *string
                                                                    }

                                                                    type InferICD10CMOutput

                                                                    type InferICD10CMOutput struct {
                                                                    
                                                                    	// The medical conditions detected in the text linked to ICD-10-CM concepts. If the
                                                                    	// action is successful, the service sends back an HTTP 200 response, as well as
                                                                    	// the entities detected.
                                                                    	//
                                                                    	// This member is required.
                                                                    	Entities []types.ICD10CMEntity
                                                                    
                                                                    	// The version of the model used to analyze the documents, in the format n.n.n You
                                                                    	// can use this information to track the model used for a particular batch of
                                                                    	// documents.
                                                                    	ModelVersion *string
                                                                    
                                                                    	// If the result of the previous request to InferICD10CM was truncated, include the
                                                                    	// PaginationToken to fetch the next page of medical condition entities.
                                                                    	PaginationToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type InferRxNormInput

                                                                    type InferRxNormInput struct {
                                                                    
                                                                    	// The input text used for analysis. The input for InferRxNorm is a string from 1
                                                                    	// to 10000 characters.
                                                                    	//
                                                                    	// This member is required.
                                                                    	Text *string
                                                                    }

                                                                    type InferRxNormOutput

                                                                    type InferRxNormOutput struct {
                                                                    
                                                                    	// The medication entities detected in the text linked to RxNorm concepts. If the
                                                                    	// action is successful, the service sends back an HTTP 200 response, as well as
                                                                    	// the entities detected.
                                                                    	//
                                                                    	// This member is required.
                                                                    	Entities []types.RxNormEntity
                                                                    
                                                                    	// The version of the model used to analyze the documents, in the format n.n.n You
                                                                    	// can use this information to track the model used for a particular batch of
                                                                    	// documents.
                                                                    	ModelVersion *string
                                                                    
                                                                    	// If the result of the previous request to InferRxNorm was truncated, include the
                                                                    	// PaginationToken to fetch the next page of medication entities.
                                                                    	PaginationToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type ListEntitiesDetectionV2JobsInput

                                                                    type ListEntitiesDetectionV2JobsInput struct {
                                                                    
                                                                    	// Filters the jobs that are returned. You can filter jobs based on their names,
                                                                    	// status, or the date and time that they were submitted. You can only set one
                                                                    	// filter at a time.
                                                                    	Filter *types.ComprehendMedicalAsyncJobFilter
                                                                    
                                                                    	// The maximum number of results to return in each page. The default is 100.
                                                                    	MaxResults *int32
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    }

                                                                    type ListEntitiesDetectionV2JobsOutput

                                                                    type ListEntitiesDetectionV2JobsOutput struct {
                                                                    
                                                                    	// A list containing the properties of each job returned.
                                                                    	ComprehendMedicalAsyncJobPropertiesList []types.ComprehendMedicalAsyncJobProperties
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type ListICD10CMInferenceJobsInput

                                                                    type ListICD10CMInferenceJobsInput struct {
                                                                    
                                                                    	// Filters the jobs that are returned. You can filter jobs based on their names,
                                                                    	// status, or the date and time that they were submitted. You can only set one
                                                                    	// filter at a time.
                                                                    	Filter *types.ComprehendMedicalAsyncJobFilter
                                                                    
                                                                    	// The maximum number of results to return in each page. The default is 100.
                                                                    	MaxResults *int32
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    }

                                                                    type ListICD10CMInferenceJobsOutput

                                                                    type ListICD10CMInferenceJobsOutput struct {
                                                                    
                                                                    	// A list containing the properties of each job that is returned.
                                                                    	ComprehendMedicalAsyncJobPropertiesList []types.ComprehendMedicalAsyncJobProperties
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type ListPHIDetectionJobsInput

                                                                    type ListPHIDetectionJobsInput struct {
                                                                    
                                                                    	// Filters the jobs that are returned. You can filter jobs based on their names,
                                                                    	// status, or the date and time that they were submitted. You can only set one
                                                                    	// filter at a time.
                                                                    	Filter *types.ComprehendMedicalAsyncJobFilter
                                                                    
                                                                    	// The maximum number of results to return in each page. The default is 100.
                                                                    	MaxResults *int32
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    }

                                                                    type ListPHIDetectionJobsOutput

                                                                    type ListPHIDetectionJobsOutput struct {
                                                                    
                                                                    	// A list containing the properties of each job returned.
                                                                    	ComprehendMedicalAsyncJobPropertiesList []types.ComprehendMedicalAsyncJobProperties
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type ListRxNormInferenceJobsInput

                                                                    type ListRxNormInferenceJobsInput struct {
                                                                    
                                                                    	// Filters the jobs that are returned. You can filter jobs based on their names,
                                                                    	// status, or the date and time that they were submitted. You can only set one
                                                                    	// filter at a time.
                                                                    	Filter *types.ComprehendMedicalAsyncJobFilter
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	MaxResults *int32
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    }

                                                                    type ListRxNormInferenceJobsOutput

                                                                    type ListRxNormInferenceJobsOutput struct {
                                                                    
                                                                    	// The maximum number of results to return in each page. The default is 100.
                                                                    	ComprehendMedicalAsyncJobPropertiesList []types.ComprehendMedicalAsyncJobProperties
                                                                    
                                                                    	// Identifies the next page of results to return.
                                                                    	NextToken *string
                                                                    
                                                                    	// Metadata pertaining to the operation's result.
                                                                    	ResultMetadata middleware.Metadata
                                                                    }

                                                                    type Options

                                                                    type Options struct {
                                                                    	// Set of options to modify how an operation is invoked. These apply to all
                                                                    	// operations invoked for this client. Use functional options on operation call to
                                                                    	// modify this list for per operation behavior.
                                                                    	APIOptions []func(*middleware.Stack) error
                                                                    
                                                                    	// Configures the events that will be sent to the configured logger.
                                                                    	ClientLogMode aws.ClientLogMode
                                                                    
                                                                    	// The credentials object to use when signing requests.
                                                                    	Credentials aws.CredentialsProvider
                                                                    
                                                                    	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                    	EndpointOptions EndpointResolverOptions
                                                                    
                                                                    	// The service endpoint resolver.
                                                                    	EndpointResolver EndpointResolver
                                                                    
                                                                    	// Signature Version 4 (SigV4) Signer
                                                                    	HTTPSignerV4 HTTPSignerV4
                                                                    
                                                                    	// Provides idempotency tokens values that will be automatically populated into
                                                                    	// idempotent API operations.
                                                                    	IdempotencyTokenProvider IdempotencyTokenProvider
                                                                    
                                                                    	// The logger writer interface to write logging messages to.
                                                                    	Logger logging.Logger
                                                                    
                                                                    	// The region to send requests to. (Required)
                                                                    	Region string
                                                                    
                                                                    	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                    	// failures. When nil the API client will use a default retryer.
                                                                    	Retryer aws.Retryer
                                                                    
                                                                    	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                    	// implementation if nil.
                                                                    	HTTPClient HTTPClient
                                                                    }

                                                                    func (Options) Copy

                                                                    func (o Options) Copy() Options

                                                                      Copy creates a clone where the APIOptions list is deep copied.

                                                                      type ResolveEndpoint

                                                                      type ResolveEndpoint struct {
                                                                      	Resolver EndpointResolver
                                                                      	Options  EndpointResolverOptions
                                                                      }

                                                                      func (*ResolveEndpoint) HandleSerialize

                                                                      func (*ResolveEndpoint) ID

                                                                      func (*ResolveEndpoint) ID() string

                                                                      type StartEntitiesDetectionV2JobInput

                                                                      type StartEntitiesDetectionV2JobInput struct {
                                                                      
                                                                      	// 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
                                                                      	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
                                                                      	//
                                                                      	// This member is required.
                                                                      	DataAccessRoleArn *string
                                                                      
                                                                      	// Specifies the format and location of the input data for the job.
                                                                      	//
                                                                      	// This member is required.
                                                                      	InputDataConfig *types.InputDataConfig
                                                                      
                                                                      	// The language of the input documents. All documents must be in the same language.
                                                                      	//
                                                                      	// This member is required.
                                                                      	LanguageCode types.LanguageCode
                                                                      
                                                                      	// Specifies where to send the output files.
                                                                      	//
                                                                      	// This member is required.
                                                                      	OutputDataConfig *types.OutputDataConfig
                                                                      
                                                                      	// A unique identifier for the request. If you don't set the client request token,
                                                                      	// Amazon Comprehend Medical generates one.
                                                                      	ClientRequestToken *string
                                                                      
                                                                      	// The identifier of the job.
                                                                      	JobName *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.
                                                                      	KMSKey *string
                                                                      }

                                                                      type StartEntitiesDetectionV2JobOutput

                                                                      type StartEntitiesDetectionV2JobOutput struct {
                                                                      
                                                                      	// The identifier generated for the job. To get the status of a job, use this
                                                                      	// identifier with the DescribeEntitiesDetectionV2Job operation.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StartICD10CMInferenceJobInput

                                                                      type StartICD10CMInferenceJobInput struct {
                                                                      
                                                                      	// 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
                                                                      	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
                                                                      	//
                                                                      	// This member is required.
                                                                      	DataAccessRoleArn *string
                                                                      
                                                                      	// Specifies the format and location of the input data for the job.
                                                                      	//
                                                                      	// This member is required.
                                                                      	InputDataConfig *types.InputDataConfig
                                                                      
                                                                      	// The language of the input documents. All documents must be in the same language.
                                                                      	//
                                                                      	// This member is required.
                                                                      	LanguageCode types.LanguageCode
                                                                      
                                                                      	// Specifies where to send the output files.
                                                                      	//
                                                                      	// This member is required.
                                                                      	OutputDataConfig *types.OutputDataConfig
                                                                      
                                                                      	// A unique identifier for the request. If you don't set the client request token,
                                                                      	// Amazon Comprehend Medical generates one.
                                                                      	ClientRequestToken *string
                                                                      
                                                                      	// The identifier of the job.
                                                                      	JobName *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.
                                                                      	KMSKey *string
                                                                      }

                                                                      type StartICD10CMInferenceJobOutput

                                                                      type StartICD10CMInferenceJobOutput struct {
                                                                      
                                                                      	// The identifier generated for the job. To get the status of a job, use this
                                                                      	// identifier with the StartICD10CMInferenceJob operation.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StartPHIDetectionJobInput

                                                                      type StartPHIDetectionJobInput struct {
                                                                      
                                                                      	// 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
                                                                      	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
                                                                      	//
                                                                      	// This member is required.
                                                                      	DataAccessRoleArn *string
                                                                      
                                                                      	// Specifies the format and location of the input data for the job.
                                                                      	//
                                                                      	// This member is required.
                                                                      	InputDataConfig *types.InputDataConfig
                                                                      
                                                                      	// The language of the input documents. All documents must be in the same language.
                                                                      	//
                                                                      	// This member is required.
                                                                      	LanguageCode types.LanguageCode
                                                                      
                                                                      	// Specifies where to send the output files.
                                                                      	//
                                                                      	// This member is required.
                                                                      	OutputDataConfig *types.OutputDataConfig
                                                                      
                                                                      	// A unique identifier for the request. If you don't set the client request token,
                                                                      	// Amazon Comprehend Medical generates one.
                                                                      	ClientRequestToken *string
                                                                      
                                                                      	// The identifier of the job.
                                                                      	JobName *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.
                                                                      	KMSKey *string
                                                                      }

                                                                      type StartPHIDetectionJobOutput

                                                                      type StartPHIDetectionJobOutput struct {
                                                                      
                                                                      	// The identifier generated for the job. To get the status of a job, use this
                                                                      	// identifier with the DescribePHIDetectionJob operation.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StartRxNormInferenceJobInput

                                                                      type StartRxNormInferenceJobInput struct {
                                                                      
                                                                      	// 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
                                                                      	// (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
                                                                      	//
                                                                      	// This member is required.
                                                                      	DataAccessRoleArn *string
                                                                      
                                                                      	// Specifies the format and location of the input data for the job.
                                                                      	//
                                                                      	// This member is required.
                                                                      	InputDataConfig *types.InputDataConfig
                                                                      
                                                                      	// The language of the input documents. All documents must be in the same language.
                                                                      	//
                                                                      	// This member is required.
                                                                      	LanguageCode types.LanguageCode
                                                                      
                                                                      	// Specifies where to send the output files.
                                                                      	//
                                                                      	// This member is required.
                                                                      	OutputDataConfig *types.OutputDataConfig
                                                                      
                                                                      	// A unique identifier for the request. If you don't set the client request token,
                                                                      	// Amazon Comprehend Medical generates one.
                                                                      	ClientRequestToken *string
                                                                      
                                                                      	// The identifier of the job.
                                                                      	JobName *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.
                                                                      	KMSKey *string
                                                                      }

                                                                      type StartRxNormInferenceJobOutput

                                                                      type StartRxNormInferenceJobOutput struct {
                                                                      
                                                                      	// The identifier of the job.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StopEntitiesDetectionV2JobInput

                                                                      type StopEntitiesDetectionV2JobInput struct {
                                                                      
                                                                      	// The identifier of the medical entities job to stop.
                                                                      	//
                                                                      	// This member is required.
                                                                      	JobId *string
                                                                      }

                                                                      type StopEntitiesDetectionV2JobOutput

                                                                      type StopEntitiesDetectionV2JobOutput struct {
                                                                      
                                                                      	// The identifier of the medical entities detection job that was stopped.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StopICD10CMInferenceJobInput

                                                                      type StopICD10CMInferenceJobInput struct {
                                                                      
                                                                      	// The identifier of the job.
                                                                      	//
                                                                      	// This member is required.
                                                                      	JobId *string
                                                                      }

                                                                      type StopICD10CMInferenceJobOutput

                                                                      type StopICD10CMInferenceJobOutput struct {
                                                                      
                                                                      	// The identifier generated for the job. To get the status of job, use this
                                                                      	// identifier with the DescribeICD10CMInferenceJob operation.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StopPHIDetectionJobInput

                                                                      type StopPHIDetectionJobInput struct {
                                                                      
                                                                      	// The identifier of the PHI detection job to stop.
                                                                      	//
                                                                      	// This member is required.
                                                                      	JobId *string
                                                                      }

                                                                      type StopPHIDetectionJobOutput

                                                                      type StopPHIDetectionJobOutput struct {
                                                                      
                                                                      	// The identifier of the PHI detection job that was stopped.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type StopRxNormInferenceJobInput

                                                                      type StopRxNormInferenceJobInput struct {
                                                                      
                                                                      	// The identifier of the job.
                                                                      	//
                                                                      	// This member is required.
                                                                      	JobId *string
                                                                      }

                                                                      type StopRxNormInferenceJobOutput

                                                                      type StopRxNormInferenceJobOutput struct {
                                                                      
                                                                      	// The identifier generated for the job. To get the status of job, use this
                                                                      	// identifier with the DescribeRxNormInferenceJob operation.
                                                                      	JobId *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      Directories

                                                                      Path Synopsis
                                                                      internal