const ServiceAPIVersion = "2018-10-30"

const ServiceID = "ComprehendMedical"

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

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

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 struct {
	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartICD10CMInferenceJob operation returns this identifier in its response.
	JobId *string
}

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 struct {
	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartPHIDetectionJob operation returns this identifier in its response.
	JobId *string
}

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 struct {
	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartRxNormInferenceJob operation returns this identifier in its response.
	JobId *string
}

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 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.
	Text *string
}

type DetectEntitiesOutput struct {
	// 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.
	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
	// 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.
	Entities []*types.Entity
	// 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 struct {
	// A UTF-8 string containing the clinical content being examined for entities. Each
	// string must contain fewer than 20,000 bytes of characters.
	Text *string
}

type DetectEntitiesV2Output struct {
	// Attributes extracted from the input text that couldn't be related to an entity.
	UnmappedAttributes []*types.UnmappedAttribute
	// If the result to the DetectEntitiesV2 operation was truncated, include the
	// PaginationToken to fetch the next page of entities.
	PaginationToken *string
	// 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.
	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.
	ModelVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.
	Text *string
}

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.
	Entities []*types.Entity
	// If the result of the previous request to DetectPHI was truncated, include the
	// PaginationToken to fetch the next page of PHI entities.
	PaginationToken *string
	// 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.
	ModelVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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

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

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

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

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

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.
	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 struct {
	// The input text used for analysis. The input for InferRxNorm is a string from 1
	// to 10000 characters.
	Text *string
}

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.
	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 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.
	NextToken *string
	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int32
}

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 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 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 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 struct {
	// Identifies the next page of results to return.
	NextToken *string
	// A list containing the properties of each job returned.
	ComprehendMedicalAsyncJobPropertiesList []*types.ComprehendMedicalAsyncJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 struct {
	// Identifies the next page of results to return.
	NextToken *string
	// The maximum number of results to return in each page. The default is 100.
	ComprehendMedicalAsyncJobPropertiesList []*types.ComprehendMedicalAsyncJobProperties

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// 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 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 retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions = internalendpoints.Options

type StartEntitiesDetectionV2JobInput struct {
	// The identifier of the job.
	JobName *string
	// The language of the input documents. All documents must be in the same language.
	LanguageCode types.LanguageCode
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend Medical generates one.
	ClientRequestToken *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
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// 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).
	DataAccessRoleArn *string
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
}

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

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 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).
	DataAccessRoleArn *string
	// The language of the input documents. All documents must be in the same language.
	LanguageCode types.LanguageCode
	// A unique identifier for the request. If you don't set the client request token,
	// Amazon Comprehend Medical generates one.
	ClientRequestToken *string
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// 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 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 struct {
	// Specifies where to send the output files.
	OutputDataConfig *types.OutputDataConfig
	// Specifies the format and location of the input data for the job.
	InputDataConfig *types.InputDataConfig
	// 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
	// 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).
	DataAccessRoleArn *string
	// The language of the input documents. All documents must be in the same language.
	LanguageCode types.LanguageCode
	// 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
}

type StartRxNormInferenceJobOutput struct {
	// The identifier of the job.
	JobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

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 struct {
	// The identifier of the job.
	JobId *string
}

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 struct {
	// The identifier of the PHI detection job to stop.
	JobId *string
}

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 struct {
	// The identifier of the job.
	JobId *string
}

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
}