comprehendmedical

package
Version: v1.40.49 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 10

Documentation

Overview

Package comprehendmedical provides the client and types for making API requests to AWS Comprehend Medical.

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

See https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30 for more information on this service.

See comprehendmedical package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/comprehendmedical/

Using the Client

To contact AWS Comprehend Medical with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Comprehend Medical client ComprehendMedical for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/comprehendmedical/#New

Index

Constants

View Source
const (
	// AttributeNameSign is a AttributeName enum value
	AttributeNameSign = "SIGN"

	// AttributeNameSymptom is a AttributeName enum value
	AttributeNameSymptom = "SYMPTOM"

	// AttributeNameDiagnosis is a AttributeName enum value
	AttributeNameDiagnosis = "DIAGNOSIS"

	// AttributeNameNegation is a AttributeName enum value
	AttributeNameNegation = "NEGATION"
)
View Source
const (
	// EntitySubTypeName is a EntitySubType enum value
	EntitySubTypeName = "NAME"

	// EntitySubTypeDosage is a EntitySubType enum value
	EntitySubTypeDosage = "DOSAGE"

	// EntitySubTypeRouteOrMode is a EntitySubType enum value
	EntitySubTypeRouteOrMode = "ROUTE_OR_MODE"

	// EntitySubTypeForm is a EntitySubType enum value
	EntitySubTypeForm = "FORM"

	// EntitySubTypeFrequency is a EntitySubType enum value
	EntitySubTypeFrequency = "FREQUENCY"

	// EntitySubTypeDuration is a EntitySubType enum value
	EntitySubTypeDuration = "DURATION"

	// EntitySubTypeGenericName is a EntitySubType enum value
	EntitySubTypeGenericName = "GENERIC_NAME"

	// EntitySubTypeBrandName is a EntitySubType enum value
	EntitySubTypeBrandName = "BRAND_NAME"

	// EntitySubTypeStrength is a EntitySubType enum value
	EntitySubTypeStrength = "STRENGTH"

	// EntitySubTypeRate is a EntitySubType enum value
	EntitySubTypeRate = "RATE"

	// EntitySubTypeAcuity is a EntitySubType enum value
	EntitySubTypeAcuity = "ACUITY"

	// EntitySubTypeTestName is a EntitySubType enum value
	EntitySubTypeTestName = "TEST_NAME"

	// EntitySubTypeTestValue is a EntitySubType enum value
	EntitySubTypeTestValue = "TEST_VALUE"

	// EntitySubTypeTestUnits is a EntitySubType enum value
	EntitySubTypeTestUnits = "TEST_UNITS"

	// EntitySubTypeProcedureName is a EntitySubType enum value
	EntitySubTypeProcedureName = "PROCEDURE_NAME"

	// EntitySubTypeTreatmentName is a EntitySubType enum value
	EntitySubTypeTreatmentName = "TREATMENT_NAME"

	// EntitySubTypeDate is a EntitySubType enum value
	EntitySubTypeDate = "DATE"

	// EntitySubTypeAge is a EntitySubType enum value
	EntitySubTypeAge = "AGE"

	// EntitySubTypeContactPoint is a EntitySubType enum value
	EntitySubTypeContactPoint = "CONTACT_POINT"

	// EntitySubTypeEmail is a EntitySubType enum value
	EntitySubTypeEmail = "EMAIL"

	// EntitySubTypeIdentifier is a EntitySubType enum value
	EntitySubTypeIdentifier = "IDENTIFIER"

	// EntitySubTypeUrl is a EntitySubType enum value
	EntitySubTypeUrl = "URL"

	// EntitySubTypeAddress is a EntitySubType enum value
	EntitySubTypeAddress = "ADDRESS"

	// EntitySubTypeProfession is a EntitySubType enum value
	EntitySubTypeProfession = "PROFESSION"

	// EntitySubTypeSystemOrganSite is a EntitySubType enum value
	EntitySubTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"

	// EntitySubTypeDirection is a EntitySubType enum value
	EntitySubTypeDirection = "DIRECTION"

	// EntitySubTypeQuality is a EntitySubType enum value
	EntitySubTypeQuality = "QUALITY"

	// EntitySubTypeQuantity is a EntitySubType enum value
	EntitySubTypeQuantity = "QUANTITY"

	// EntitySubTypeTimeExpression is a EntitySubType enum value
	EntitySubTypeTimeExpression = "TIME_EXPRESSION"

	// EntitySubTypeTimeToMedicationName is a EntitySubType enum value
	EntitySubTypeTimeToMedicationName = "TIME_TO_MEDICATION_NAME"

	// EntitySubTypeTimeToDxName is a EntitySubType enum value
	EntitySubTypeTimeToDxName = "TIME_TO_DX_NAME"

	// EntitySubTypeTimeToTestName is a EntitySubType enum value
	EntitySubTypeTimeToTestName = "TIME_TO_TEST_NAME"

	// EntitySubTypeTimeToProcedureName is a EntitySubType enum value
	EntitySubTypeTimeToProcedureName = "TIME_TO_PROCEDURE_NAME"

	// EntitySubTypeTimeToTreatmentName is a EntitySubType enum value
	EntitySubTypeTimeToTreatmentName = "TIME_TO_TREATMENT_NAME"
)
View Source
const (
	// EntityTypeMedication is a EntityType enum value
	EntityTypeMedication = "MEDICATION"

	// EntityTypeMedicalCondition is a EntityType enum value
	EntityTypeMedicalCondition = "MEDICAL_CONDITION"

	// EntityTypeProtectedHealthInformation is a EntityType enum value
	EntityTypeProtectedHealthInformation = "PROTECTED_HEALTH_INFORMATION"

	// EntityTypeTestTreatmentProcedure is a EntityType enum value
	EntityTypeTestTreatmentProcedure = "TEST_TREATMENT_PROCEDURE"

	// EntityTypeAnatomy is a EntityType enum value
	EntityTypeAnatomy = "ANATOMY"

	// EntityTypeTimeExpression is a EntityType enum value
	EntityTypeTimeExpression = "TIME_EXPRESSION"
)
View Source
const (
	// ICD10CMAttributeTypeAcuity is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeAcuity = "ACUITY"

	// ICD10CMAttributeTypeDirection is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeDirection = "DIRECTION"

	// ICD10CMAttributeTypeSystemOrganSite is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"

	// ICD10CMAttributeTypeQuality is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeQuality = "QUALITY"

	// ICD10CMAttributeTypeQuantity is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeQuantity = "QUANTITY"

	// ICD10CMAttributeTypeTimeToDxName is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeTimeToDxName = "TIME_TO_DX_NAME"

	// ICD10CMAttributeTypeTimeExpression is a ICD10CMAttributeType enum value
	ICD10CMAttributeTypeTimeExpression = "TIME_EXPRESSION"
)
View Source
const (
	// ICD10CMEntityTypeDxName is a ICD10CMEntityType enum value
	ICD10CMEntityTypeDxName = "DX_NAME"

	// ICD10CMEntityTypeTimeExpression is a ICD10CMEntityType enum value
	ICD10CMEntityTypeTimeExpression = "TIME_EXPRESSION"
)
View Source
const (
	// ICD10CMRelationshipTypeOverlap is a ICD10CMRelationshipType enum value
	ICD10CMRelationshipTypeOverlap = "OVERLAP"

	// ICD10CMRelationshipTypeSystemOrganSite is a ICD10CMRelationshipType enum value
	ICD10CMRelationshipTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"
)
View Source
const (
	// ICD10CMTraitNameNegation is a ICD10CMTraitName enum value
	ICD10CMTraitNameNegation = "NEGATION"

	// ICD10CMTraitNameDiagnosis is a ICD10CMTraitName enum value
	ICD10CMTraitNameDiagnosis = "DIAGNOSIS"

	// ICD10CMTraitNameSign is a ICD10CMTraitName enum value
	ICD10CMTraitNameSign = "SIGN"

	// ICD10CMTraitNameSymptom is a ICD10CMTraitName enum value
	ICD10CMTraitNameSymptom = "SYMPTOM"
)
View Source
const (
	// JobStatusSubmitted is a JobStatus enum value
	JobStatusSubmitted = "SUBMITTED"

	// JobStatusInProgress is a JobStatus enum value
	JobStatusInProgress = "IN_PROGRESS"

	// JobStatusCompleted is a JobStatus enum value
	JobStatusCompleted = "COMPLETED"

	// JobStatusPartialSuccess is a JobStatus enum value
	JobStatusPartialSuccess = "PARTIAL_SUCCESS"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"

	// JobStatusStopRequested is a JobStatus enum value
	JobStatusStopRequested = "STOP_REQUESTED"

	// JobStatusStopped is a JobStatus enum value
	JobStatusStopped = "STOPPED"
)
View Source
const (
	// RelationshipTypeEvery is a RelationshipType enum value
	RelationshipTypeEvery = "EVERY"

	// RelationshipTypeWithDosage is a RelationshipType enum value
	RelationshipTypeWithDosage = "WITH_DOSAGE"

	// RelationshipTypeAdministeredVia is a RelationshipType enum value
	RelationshipTypeAdministeredVia = "ADMINISTERED_VIA"

	// RelationshipTypeFor is a RelationshipType enum value
	RelationshipTypeFor = "FOR"

	// RelationshipTypeNegative is a RelationshipType enum value
	RelationshipTypeNegative = "NEGATIVE"

	// RelationshipTypeOverlap is a RelationshipType enum value
	RelationshipTypeOverlap = "OVERLAP"

	// RelationshipTypeDosage is a RelationshipType enum value
	RelationshipTypeDosage = "DOSAGE"

	// RelationshipTypeRouteOrMode is a RelationshipType enum value
	RelationshipTypeRouteOrMode = "ROUTE_OR_MODE"

	// RelationshipTypeForm is a RelationshipType enum value
	RelationshipTypeForm = "FORM"

	// RelationshipTypeFrequency is a RelationshipType enum value
	RelationshipTypeFrequency = "FREQUENCY"

	// RelationshipTypeDuration is a RelationshipType enum value
	RelationshipTypeDuration = "DURATION"

	// RelationshipTypeStrength is a RelationshipType enum value
	RelationshipTypeStrength = "STRENGTH"

	// RelationshipTypeRate is a RelationshipType enum value
	RelationshipTypeRate = "RATE"

	// RelationshipTypeAcuity is a RelationshipType enum value
	RelationshipTypeAcuity = "ACUITY"

	// RelationshipTypeTestValue is a RelationshipType enum value
	RelationshipTypeTestValue = "TEST_VALUE"

	// RelationshipTypeTestUnits is a RelationshipType enum value
	RelationshipTypeTestUnits = "TEST_UNITS"

	// RelationshipTypeDirection is a RelationshipType enum value
	RelationshipTypeDirection = "DIRECTION"

	// RelationshipTypeSystemOrganSite is a RelationshipType enum value
	RelationshipTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"
)
View Source
const (
	// RxNormAttributeTypeDosage is a RxNormAttributeType enum value
	RxNormAttributeTypeDosage = "DOSAGE"

	// RxNormAttributeTypeDuration is a RxNormAttributeType enum value
	RxNormAttributeTypeDuration = "DURATION"

	// RxNormAttributeTypeForm is a RxNormAttributeType enum value
	RxNormAttributeTypeForm = "FORM"

	// RxNormAttributeTypeFrequency is a RxNormAttributeType enum value
	RxNormAttributeTypeFrequency = "FREQUENCY"

	// RxNormAttributeTypeRate is a RxNormAttributeType enum value
	RxNormAttributeTypeRate = "RATE"

	// RxNormAttributeTypeRouteOrMode is a RxNormAttributeType enum value
	RxNormAttributeTypeRouteOrMode = "ROUTE_OR_MODE"

	// RxNormAttributeTypeStrength is a RxNormAttributeType enum value
	RxNormAttributeTypeStrength = "STRENGTH"
)
View Source
const (
	// RxNormEntityTypeBrandName is a RxNormEntityType enum value
	RxNormEntityTypeBrandName = "BRAND_NAME"

	// RxNormEntityTypeGenericName is a RxNormEntityType enum value
	RxNormEntityTypeGenericName = "GENERIC_NAME"
)
View Source
const (

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal server error occurred. Retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidEncodingException for service response error code
	// "InvalidEncodingException".
	//
	// The input text was not in valid UTF-8 character encoding. Check your text
	// then retry your request.
	ErrCodeInvalidEncodingException = "InvalidEncodingException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request that you made is invalid. Check your request to determine why
	// it's invalid and then retry the request.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource identified by the specified Amazon Resource Name (ARN) was not
	// found. Check the ARN and try your request again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The Amazon Comprehend Medical service is temporarily unavailable. Please
	// wait and then retry your request.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the text you submitted exceeds the size limit. Reduce the size
	// of the text or use a smaller document and then retry your request.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// You have made too many requests within a short period of time. Wait for a
	// short time and then try your request again. Contact customer support for
	// more information about a service limit increase.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The filter that you specified for the operation is invalid. Check the filter
	// values that you entered and try your request again.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "ComprehendMedical" // Name of service.
	EndpointsID = "comprehendmedical" // ID to lookup a service endpoint with.
	ServiceID   = "ComprehendMedical" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ICD10CMEntityCategoryMedicalCondition is a ICD10CMEntityCategory enum value
	ICD10CMEntityCategoryMedicalCondition = "MEDICAL_CONDITION"
)
View Source
const (
	// LanguageCodeEn is a LanguageCode enum value
	LanguageCodeEn = "en"
)
View Source
const (
	// RxNormEntityCategoryMedication is a RxNormEntityCategory enum value
	RxNormEntityCategoryMedication = "MEDICATION"
)
View Source
const (
	// RxNormTraitNameNegation is a RxNormTraitName enum value
	RxNormTraitNameNegation = "NEGATION"
)

Variables

This section is empty.

Functions

func AttributeName_Values added in v1.34.3

func AttributeName_Values() []string

AttributeName_Values returns all elements of the AttributeName enum

func EntitySubType_Values added in v1.34.3

func EntitySubType_Values() []string

EntitySubType_Values returns all elements of the EntitySubType enum

func EntityType_Values added in v1.34.3

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func ICD10CMAttributeType_Values added in v1.34.3

func ICD10CMAttributeType_Values() []string

ICD10CMAttributeType_Values returns all elements of the ICD10CMAttributeType enum

func ICD10CMEntityCategory_Values added in v1.34.3

func ICD10CMEntityCategory_Values() []string

ICD10CMEntityCategory_Values returns all elements of the ICD10CMEntityCategory enum

func ICD10CMEntityType_Values added in v1.34.3

func ICD10CMEntityType_Values() []string

ICD10CMEntityType_Values returns all elements of the ICD10CMEntityType enum

func ICD10CMRelationshipType_Values added in v1.38.19

func ICD10CMRelationshipType_Values() []string

ICD10CMRelationshipType_Values returns all elements of the ICD10CMRelationshipType enum

func ICD10CMTraitName_Values added in v1.34.3

func ICD10CMTraitName_Values() []string

ICD10CMTraitName_Values returns all elements of the ICD10CMTraitName enum

func JobStatus_Values added in v1.34.3

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func LanguageCode_Values added in v1.34.3

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func RelationshipType_Values added in v1.34.3

func RelationshipType_Values() []string

RelationshipType_Values returns all elements of the RelationshipType enum

func RxNormAttributeType_Values added in v1.34.3

func RxNormAttributeType_Values() []string

RxNormAttributeType_Values returns all elements of the RxNormAttributeType enum

func RxNormEntityCategory_Values added in v1.34.3

func RxNormEntityCategory_Values() []string

RxNormEntityCategory_Values returns all elements of the RxNormEntityCategory enum

func RxNormEntityType_Values added in v1.34.3

func RxNormEntityType_Values() []string

RxNormEntityType_Values returns all elements of the RxNormEntityType enum

func RxNormTraitName_Values added in v1.34.3

func RxNormTraitName_Values() []string

RxNormTraitName_Values returns all elements of the RxNormTraitName enum

Types

type Attribute

type Attribute struct {

	// The 0-based character offset in the input text that shows where the attribute
	// begins. The offset returns the UTF-8 code point in the string.
	BeginOffset *int64 `type:"integer"`

	// The category of attribute.
	Category *string `type:"string" enum:"EntityType"`

	// The 0-based character offset in the input text that shows where the attribute
	// ends. The offset returns the UTF-8 code point in the string.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for this attribute. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has that this attribute
	// is correctly related to this entity.
	RelationshipScore *float64 `type:"float"`

	// The type of relationship between the entity and attribute. Type for the relationship
	// is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
	RelationshipType *string `type:"string" enum:"RelationshipType"`

	// The level of confidence that Amazon Comprehend Medical has that the segment
	// of text is correctly recognized as an attribute.
	Score *float64 `type:"float"`

	// The segment of input text extracted as this attribute.
	Text *string `min:"1" type:"string"`

	// Contextual information for this attribute.
	Traits []*Trait `type:"list"`

	// The type of attribute.
	Type *string `type:"string" enum:"EntitySubType"`
	// contains filtered or unexported fields
}

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

func (Attribute) GoString

func (s Attribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Attribute) SetBeginOffset

func (s *Attribute) SetBeginOffset(v int64) *Attribute

SetBeginOffset sets the BeginOffset field's value.

func (*Attribute) SetCategory added in v1.29.15

func (s *Attribute) SetCategory(v string) *Attribute

SetCategory sets the Category field's value.

func (*Attribute) SetEndOffset

func (s *Attribute) SetEndOffset(v int64) *Attribute

SetEndOffset sets the EndOffset field's value.

func (*Attribute) SetId

func (s *Attribute) SetId(v int64) *Attribute

SetId sets the Id field's value.

func (*Attribute) SetRelationshipScore

func (s *Attribute) SetRelationshipScore(v float64) *Attribute

SetRelationshipScore sets the RelationshipScore field's value.

func (*Attribute) SetRelationshipType added in v1.29.15

func (s *Attribute) SetRelationshipType(v string) *Attribute

SetRelationshipType sets the RelationshipType field's value.

func (*Attribute) SetScore

func (s *Attribute) SetScore(v float64) *Attribute

SetScore sets the Score field's value.

func (*Attribute) SetText

func (s *Attribute) SetText(v string) *Attribute

SetText sets the Text field's value.

func (*Attribute) SetTraits

func (s *Attribute) SetTraits(v []*Trait) *Attribute

SetTraits sets the Traits field's value.

func (*Attribute) SetType

func (s *Attribute) SetType(v string) *Attribute

SetType sets the Type field's value.

func (Attribute) String

func (s Attribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComprehendMedical

type ComprehendMedical struct {
	*client.Client
}

ComprehendMedical provides the API operation methods for making requests to AWS Comprehend Medical. See this package's package overview docs for details on the service.

ComprehendMedical methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the ComprehendMedical client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a ComprehendMedical client from just a session.
svc := comprehendmedical.New(mySession)

// Create a ComprehendMedical client with additional configuration
svc := comprehendmedical.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ComprehendMedical) DescribeEntitiesDetectionV2Job added in v1.24.5

DescribeEntitiesDetectionV2Job API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DescribeEntitiesDetectionV2Job for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2Job

func (*ComprehendMedical) DescribeEntitiesDetectionV2JobRequest added in v1.24.5

func (c *ComprehendMedical) DescribeEntitiesDetectionV2JobRequest(input *DescribeEntitiesDetectionV2JobInput) (req *request.Request, output *DescribeEntitiesDetectionV2JobOutput)

DescribeEntitiesDetectionV2JobRequest generates a "aws/request.Request" representing the client's request for the DescribeEntitiesDetectionV2Job operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEntitiesDetectionV2Job for more information on using the DescribeEntitiesDetectionV2Job API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEntitiesDetectionV2JobRequest method.
req, resp := client.DescribeEntitiesDetectionV2JobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2Job

func (*ComprehendMedical) DescribeEntitiesDetectionV2JobWithContext added in v1.24.5

func (c *ComprehendMedical) DescribeEntitiesDetectionV2JobWithContext(ctx aws.Context, input *DescribeEntitiesDetectionV2JobInput, opts ...request.Option) (*DescribeEntitiesDetectionV2JobOutput, error)

DescribeEntitiesDetectionV2JobWithContext is the same as DescribeEntitiesDetectionV2Job with the addition of the ability to pass a context and additional request options.

See DescribeEntitiesDetectionV2Job for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) DescribeICD10CMInferenceJob added in v1.30.22

DescribeICD10CMInferenceJob API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DescribeICD10CMInferenceJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJob

func (*ComprehendMedical) DescribeICD10CMInferenceJobRequest added in v1.30.22

func (c *ComprehendMedical) DescribeICD10CMInferenceJobRequest(input *DescribeICD10CMInferenceJobInput) (req *request.Request, output *DescribeICD10CMInferenceJobOutput)

DescribeICD10CMInferenceJobRequest generates a "aws/request.Request" representing the client's request for the DescribeICD10CMInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeICD10CMInferenceJob for more information on using the DescribeICD10CMInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeICD10CMInferenceJobRequest method.
req, resp := client.DescribeICD10CMInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJob

func (*ComprehendMedical) DescribeICD10CMInferenceJobWithContext added in v1.30.22

func (c *ComprehendMedical) DescribeICD10CMInferenceJobWithContext(ctx aws.Context, input *DescribeICD10CMInferenceJobInput, opts ...request.Option) (*DescribeICD10CMInferenceJobOutput, error)

DescribeICD10CMInferenceJobWithContext is the same as DescribeICD10CMInferenceJob with the addition of the ability to pass a context and additional request options.

See DescribeICD10CMInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) DescribePHIDetectionJob added in v1.24.5

DescribePHIDetectionJob API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DescribePHIDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJob

func (*ComprehendMedical) DescribePHIDetectionJobRequest added in v1.24.5

func (c *ComprehendMedical) DescribePHIDetectionJobRequest(input *DescribePHIDetectionJobInput) (req *request.Request, output *DescribePHIDetectionJobOutput)

DescribePHIDetectionJobRequest generates a "aws/request.Request" representing the client's request for the DescribePHIDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePHIDetectionJob for more information on using the DescribePHIDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribePHIDetectionJobRequest method.
req, resp := client.DescribePHIDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJob

func (*ComprehendMedical) DescribePHIDetectionJobWithContext added in v1.24.5

func (c *ComprehendMedical) DescribePHIDetectionJobWithContext(ctx aws.Context, input *DescribePHIDetectionJobInput, opts ...request.Option) (*DescribePHIDetectionJobOutput, error)

DescribePHIDetectionJobWithContext is the same as DescribePHIDetectionJob with the addition of the ability to pass a context and additional request options.

See DescribePHIDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) DescribeRxNormInferenceJob added in v1.30.22

DescribeRxNormInferenceJob API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DescribeRxNormInferenceJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJob

func (*ComprehendMedical) DescribeRxNormInferenceJobRequest added in v1.30.22

func (c *ComprehendMedical) DescribeRxNormInferenceJobRequest(input *DescribeRxNormInferenceJobInput) (req *request.Request, output *DescribeRxNormInferenceJobOutput)

DescribeRxNormInferenceJobRequest generates a "aws/request.Request" representing the client's request for the DescribeRxNormInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRxNormInferenceJob for more information on using the DescribeRxNormInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRxNormInferenceJobRequest method.
req, resp := client.DescribeRxNormInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJob

func (*ComprehendMedical) DescribeRxNormInferenceJobWithContext added in v1.30.22

func (c *ComprehendMedical) DescribeRxNormInferenceJobWithContext(ctx aws.Context, input *DescribeRxNormInferenceJobInput, opts ...request.Option) (*DescribeRxNormInferenceJobOutput, error)

DescribeRxNormInferenceJobWithContext is the same as DescribeRxNormInferenceJob with the addition of the ability to pass a context and additional request options.

See DescribeRxNormInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) DetectEntities deprecated

This method has been deprecated.
func (c *ComprehendMedical) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)

DetectEntities API operation for AWS Comprehend Medical.

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 .

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DetectEntities for usage and error information.

Returned Error Types:

* InternalServerException
An internal server error occurred. Retry your request.

* ServiceUnavailableException
The Amazon Comprehend Medical service is temporarily unavailable. Please
wait and then retry your request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* InvalidEncodingException
The input text was not in valid UTF-8 character encoding. Check your text
then retry your request.

* TextSizeLimitExceededException
The size of the text you submitted exceeds the size limit. Reduce the size
of the text or use a smaller document and then retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntities

Deprecated: This operation is deprecated, use DetectEntitiesV2 instead.

func (*ComprehendMedical) DetectEntitiesRequest deprecated

This method has been deprecated.
func (c *ComprehendMedical) DetectEntitiesRequest(input *DetectEntitiesInput) (req *request.Request, output *DetectEntitiesOutput)

DetectEntitiesRequest generates a "aws/request.Request" representing the client's request for the DetectEntities operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectEntities for more information on using the DetectEntities API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetectEntitiesRequest method.
req, resp := client.DetectEntitiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntities

Deprecated: This operation is deprecated, use DetectEntitiesV2 instead.

func (*ComprehendMedical) DetectEntitiesV2 added in v1.24.5

func (c *ComprehendMedical) DetectEntitiesV2(input *DetectEntitiesV2Input) (*DetectEntitiesV2Output, error)

DetectEntitiesV2 API operation for AWS Comprehend Medical.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DetectEntitiesV2 for usage and error information.

Returned Error Types:

* InternalServerException
An internal server error occurred. Retry your request.

* ServiceUnavailableException
The Amazon Comprehend Medical service is temporarily unavailable. Please
wait and then retry your request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* InvalidEncodingException
The input text was not in valid UTF-8 character encoding. Check your text
then retry your request.

* TextSizeLimitExceededException
The size of the text you submitted exceeds the size limit. Reduce the size
of the text or use a smaller document and then retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2

func (*ComprehendMedical) DetectEntitiesV2Request added in v1.24.5

func (c *ComprehendMedical) DetectEntitiesV2Request(input *DetectEntitiesV2Input) (req *request.Request, output *DetectEntitiesV2Output)

DetectEntitiesV2Request generates a "aws/request.Request" representing the client's request for the DetectEntitiesV2 operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectEntitiesV2 for more information on using the DetectEntitiesV2 API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetectEntitiesV2Request method.
req, resp := client.DetectEntitiesV2Request(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2

func (*ComprehendMedical) DetectEntitiesV2WithContext added in v1.24.5

func (c *ComprehendMedical) DetectEntitiesV2WithContext(ctx aws.Context, input *DetectEntitiesV2Input, opts ...request.Option) (*DetectEntitiesV2Output, error)

DetectEntitiesV2WithContext is the same as DetectEntitiesV2 with the addition of the ability to pass a context and additional request options.

See DetectEntitiesV2 for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) DetectEntitiesWithContext deprecated

This method has been deprecated.
func (c *ComprehendMedical) DetectEntitiesWithContext(ctx aws.Context, input *DetectEntitiesInput, opts ...request.Option) (*DetectEntitiesOutput, error)

DetectEntitiesWithContext is the same as DetectEntities with the addition of the ability to pass a context and additional request options.

See DetectEntities for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

Deprecated: This operation is deprecated, use DetectEntitiesV2 instead.

func (*ComprehendMedical) DetectPHI

func (c *ComprehendMedical) DetectPHI(input *DetectPHIInput) (*DetectPHIOutput, error)

DetectPHI API operation for AWS Comprehend Medical.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation DetectPHI for usage and error information.

Returned Error Types:

* InternalServerException
An internal server error occurred. Retry your request.

* ServiceUnavailableException
The Amazon Comprehend Medical service is temporarily unavailable. Please
wait and then retry your request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* InvalidEncodingException
The input text was not in valid UTF-8 character encoding. Check your text
then retry your request.

* TextSizeLimitExceededException
The size of the text you submitted exceeds the size limit. Reduce the size
of the text or use a smaller document and then retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHI

func (*ComprehendMedical) DetectPHIRequest

func (c *ComprehendMedical) DetectPHIRequest(input *DetectPHIInput) (req *request.Request, output *DetectPHIOutput)

DetectPHIRequest generates a "aws/request.Request" representing the client's request for the DetectPHI operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetectPHI for more information on using the DetectPHI API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetectPHIRequest method.
req, resp := client.DetectPHIRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHI

func (*ComprehendMedical) DetectPHIWithContext

func (c *ComprehendMedical) DetectPHIWithContext(ctx aws.Context, input *DetectPHIInput, opts ...request.Option) (*DetectPHIOutput, error)

DetectPHIWithContext is the same as DetectPHI with the addition of the ability to pass a context and additional request options.

See DetectPHI for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) InferICD10CM added in v1.26.3

func (c *ComprehendMedical) InferICD10CM(input *InferICD10CMInput) (*InferICD10CMOutput, error)

InferICD10CM API operation for AWS Comprehend Medical.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation InferICD10CM for usage and error information.

Returned Error Types:

* InternalServerException
An internal server error occurred. Retry your request.

* ServiceUnavailableException
The Amazon Comprehend Medical service is temporarily unavailable. Please
wait and then retry your request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* InvalidEncodingException
The input text was not in valid UTF-8 character encoding. Check your text
then retry your request.

* TextSizeLimitExceededException
The size of the text you submitted exceeds the size limit. Reduce the size
of the text or use a smaller document and then retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CM

func (*ComprehendMedical) InferICD10CMRequest added in v1.26.3

func (c *ComprehendMedical) InferICD10CMRequest(input *InferICD10CMInput) (req *request.Request, output *InferICD10CMOutput)

InferICD10CMRequest generates a "aws/request.Request" representing the client's request for the InferICD10CM operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InferICD10CM for more information on using the InferICD10CM API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the InferICD10CMRequest method.
req, resp := client.InferICD10CMRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CM

func (*ComprehendMedical) InferICD10CMWithContext added in v1.26.3

func (c *ComprehendMedical) InferICD10CMWithContext(ctx aws.Context, input *InferICD10CMInput, opts ...request.Option) (*InferICD10CMOutput, error)

InferICD10CMWithContext is the same as InferICD10CM with the addition of the ability to pass a context and additional request options.

See InferICD10CM for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) InferRxNorm added in v1.26.3

func (c *ComprehendMedical) InferRxNorm(input *InferRxNormInput) (*InferRxNormOutput, error)

InferRxNorm API operation for AWS Comprehend Medical.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation InferRxNorm for usage and error information.

Returned Error Types:

* InternalServerException
An internal server error occurred. Retry your request.

* ServiceUnavailableException
The Amazon Comprehend Medical service is temporarily unavailable. Please
wait and then retry your request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* InvalidEncodingException
The input text was not in valid UTF-8 character encoding. Check your text
then retry your request.

* TextSizeLimitExceededException
The size of the text you submitted exceeds the size limit. Reduce the size
of the text or use a smaller document and then retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNorm

func (*ComprehendMedical) InferRxNormRequest added in v1.26.3

func (c *ComprehendMedical) InferRxNormRequest(input *InferRxNormInput) (req *request.Request, output *InferRxNormOutput)

InferRxNormRequest generates a "aws/request.Request" representing the client's request for the InferRxNorm operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InferRxNorm for more information on using the InferRxNorm API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the InferRxNormRequest method.
req, resp := client.InferRxNormRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNorm

func (*ComprehendMedical) InferRxNormWithContext added in v1.26.3

func (c *ComprehendMedical) InferRxNormWithContext(ctx aws.Context, input *InferRxNormInput, opts ...request.Option) (*InferRxNormOutput, error)

InferRxNormWithContext is the same as InferRxNorm with the addition of the ability to pass a context and additional request options.

See InferRxNorm for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) ListEntitiesDetectionV2Jobs added in v1.24.5

ListEntitiesDetectionV2Jobs API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation ListEntitiesDetectionV2Jobs for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ValidationException
The filter that you specified for the operation is invalid. Check the filter
values that you entered and try your request again.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2Jobs

func (*ComprehendMedical) ListEntitiesDetectionV2JobsRequest added in v1.24.5

func (c *ComprehendMedical) ListEntitiesDetectionV2JobsRequest(input *ListEntitiesDetectionV2JobsInput) (req *request.Request, output *ListEntitiesDetectionV2JobsOutput)

ListEntitiesDetectionV2JobsRequest generates a "aws/request.Request" representing the client's request for the ListEntitiesDetectionV2Jobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEntitiesDetectionV2Jobs for more information on using the ListEntitiesDetectionV2Jobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEntitiesDetectionV2JobsRequest method.
req, resp := client.ListEntitiesDetectionV2JobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2Jobs

func (*ComprehendMedical) ListEntitiesDetectionV2JobsWithContext added in v1.24.5

func (c *ComprehendMedical) ListEntitiesDetectionV2JobsWithContext(ctx aws.Context, input *ListEntitiesDetectionV2JobsInput, opts ...request.Option) (*ListEntitiesDetectionV2JobsOutput, error)

ListEntitiesDetectionV2JobsWithContext is the same as ListEntitiesDetectionV2Jobs with the addition of the ability to pass a context and additional request options.

See ListEntitiesDetectionV2Jobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) ListICD10CMInferenceJobs added in v1.30.22

ListICD10CMInferenceJobs API operation for AWS Comprehend Medical.

Gets a list of InferICD10CM jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation ListICD10CMInferenceJobs for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ValidationException
The filter that you specified for the operation is invalid. Check the filter
values that you entered and try your request again.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobs

func (*ComprehendMedical) ListICD10CMInferenceJobsRequest added in v1.30.22

func (c *ComprehendMedical) ListICD10CMInferenceJobsRequest(input *ListICD10CMInferenceJobsInput) (req *request.Request, output *ListICD10CMInferenceJobsOutput)

ListICD10CMInferenceJobsRequest generates a "aws/request.Request" representing the client's request for the ListICD10CMInferenceJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListICD10CMInferenceJobs for more information on using the ListICD10CMInferenceJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListICD10CMInferenceJobsRequest method.
req, resp := client.ListICD10CMInferenceJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobs

func (*ComprehendMedical) ListICD10CMInferenceJobsWithContext added in v1.30.22

func (c *ComprehendMedical) ListICD10CMInferenceJobsWithContext(ctx aws.Context, input *ListICD10CMInferenceJobsInput, opts ...request.Option) (*ListICD10CMInferenceJobsOutput, error)

ListICD10CMInferenceJobsWithContext is the same as ListICD10CMInferenceJobs with the addition of the ability to pass a context and additional request options.

See ListICD10CMInferenceJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) ListPHIDetectionJobs added in v1.24.5

ListPHIDetectionJobs API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation ListPHIDetectionJobs for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ValidationException
The filter that you specified for the operation is invalid. Check the filter
values that you entered and try your request again.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobs

func (*ComprehendMedical) ListPHIDetectionJobsRequest added in v1.24.5

func (c *ComprehendMedical) ListPHIDetectionJobsRequest(input *ListPHIDetectionJobsInput) (req *request.Request, output *ListPHIDetectionJobsOutput)

ListPHIDetectionJobsRequest generates a "aws/request.Request" representing the client's request for the ListPHIDetectionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPHIDetectionJobs for more information on using the ListPHIDetectionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPHIDetectionJobsRequest method.
req, resp := client.ListPHIDetectionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobs

func (*ComprehendMedical) ListPHIDetectionJobsWithContext added in v1.24.5

func (c *ComprehendMedical) ListPHIDetectionJobsWithContext(ctx aws.Context, input *ListPHIDetectionJobsInput, opts ...request.Option) (*ListPHIDetectionJobsOutput, error)

ListPHIDetectionJobsWithContext is the same as ListPHIDetectionJobs with the addition of the ability to pass a context and additional request options.

See ListPHIDetectionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) ListRxNormInferenceJobs added in v1.30.22

ListRxNormInferenceJobs API operation for AWS Comprehend Medical.

Gets a list of InferRxNorm jobs that you have submitted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation ListRxNormInferenceJobs for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ValidationException
The filter that you specified for the operation is invalid. Check the filter
values that you entered and try your request again.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobs

func (*ComprehendMedical) ListRxNormInferenceJobsRequest added in v1.30.22

func (c *ComprehendMedical) ListRxNormInferenceJobsRequest(input *ListRxNormInferenceJobsInput) (req *request.Request, output *ListRxNormInferenceJobsOutput)

ListRxNormInferenceJobsRequest generates a "aws/request.Request" representing the client's request for the ListRxNormInferenceJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRxNormInferenceJobs for more information on using the ListRxNormInferenceJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRxNormInferenceJobsRequest method.
req, resp := client.ListRxNormInferenceJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobs

func (*ComprehendMedical) ListRxNormInferenceJobsWithContext added in v1.30.22

func (c *ComprehendMedical) ListRxNormInferenceJobsWithContext(ctx aws.Context, input *ListRxNormInferenceJobsInput, opts ...request.Option) (*ListRxNormInferenceJobsOutput, error)

ListRxNormInferenceJobsWithContext is the same as ListRxNormInferenceJobs with the addition of the ability to pass a context and additional request options.

See ListRxNormInferenceJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StartEntitiesDetectionV2Job added in v1.24.5

StartEntitiesDetectionV2Job API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StartEntitiesDetectionV2Job for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2Job

func (*ComprehendMedical) StartEntitiesDetectionV2JobRequest added in v1.24.5

func (c *ComprehendMedical) StartEntitiesDetectionV2JobRequest(input *StartEntitiesDetectionV2JobInput) (req *request.Request, output *StartEntitiesDetectionV2JobOutput)

StartEntitiesDetectionV2JobRequest generates a "aws/request.Request" representing the client's request for the StartEntitiesDetectionV2Job operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartEntitiesDetectionV2Job for more information on using the StartEntitiesDetectionV2Job API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartEntitiesDetectionV2JobRequest method.
req, resp := client.StartEntitiesDetectionV2JobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2Job

func (*ComprehendMedical) StartEntitiesDetectionV2JobWithContext added in v1.24.5

func (c *ComprehendMedical) StartEntitiesDetectionV2JobWithContext(ctx aws.Context, input *StartEntitiesDetectionV2JobInput, opts ...request.Option) (*StartEntitiesDetectionV2JobOutput, error)

StartEntitiesDetectionV2JobWithContext is the same as StartEntitiesDetectionV2Job with the addition of the ability to pass a context and additional request options.

See StartEntitiesDetectionV2Job for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StartICD10CMInferenceJob added in v1.30.22

StartICD10CMInferenceJob API operation for AWS Comprehend Medical.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StartICD10CMInferenceJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJob

func (*ComprehendMedical) StartICD10CMInferenceJobRequest added in v1.30.22

func (c *ComprehendMedical) StartICD10CMInferenceJobRequest(input *StartICD10CMInferenceJobInput) (req *request.Request, output *StartICD10CMInferenceJobOutput)

StartICD10CMInferenceJobRequest generates a "aws/request.Request" representing the client's request for the StartICD10CMInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartICD10CMInferenceJob for more information on using the StartICD10CMInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartICD10CMInferenceJobRequest method.
req, resp := client.StartICD10CMInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJob

func (*ComprehendMedical) StartICD10CMInferenceJobWithContext added in v1.30.22

func (c *ComprehendMedical) StartICD10CMInferenceJobWithContext(ctx aws.Context, input *StartICD10CMInferenceJobInput, opts ...request.Option) (*StartICD10CMInferenceJobOutput, error)

StartICD10CMInferenceJobWithContext is the same as StartICD10CMInferenceJob with the addition of the ability to pass a context and additional request options.

See StartICD10CMInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StartPHIDetectionJob added in v1.24.5

StartPHIDetectionJob API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StartPHIDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJob

func (*ComprehendMedical) StartPHIDetectionJobRequest added in v1.24.5

func (c *ComprehendMedical) StartPHIDetectionJobRequest(input *StartPHIDetectionJobInput) (req *request.Request, output *StartPHIDetectionJobOutput)

StartPHIDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StartPHIDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartPHIDetectionJob for more information on using the StartPHIDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartPHIDetectionJobRequest method.
req, resp := client.StartPHIDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJob

func (*ComprehendMedical) StartPHIDetectionJobWithContext added in v1.24.5

func (c *ComprehendMedical) StartPHIDetectionJobWithContext(ctx aws.Context, input *StartPHIDetectionJobInput, opts ...request.Option) (*StartPHIDetectionJobOutput, error)

StartPHIDetectionJobWithContext is the same as StartPHIDetectionJob with the addition of the ability to pass a context and additional request options.

See StartPHIDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StartRxNormInferenceJob added in v1.30.22

StartRxNormInferenceJob API operation for AWS Comprehend Medical.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StartRxNormInferenceJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* TooManyRequestsException
You have made too many requests within a short period of time. Wait for a
short time and then try your request again. Contact customer support for
more information about a service limit increase.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJob

func (*ComprehendMedical) StartRxNormInferenceJobRequest added in v1.30.22

func (c *ComprehendMedical) StartRxNormInferenceJobRequest(input *StartRxNormInferenceJobInput) (req *request.Request, output *StartRxNormInferenceJobOutput)

StartRxNormInferenceJobRequest generates a "aws/request.Request" representing the client's request for the StartRxNormInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartRxNormInferenceJob for more information on using the StartRxNormInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartRxNormInferenceJobRequest method.
req, resp := client.StartRxNormInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJob

func (*ComprehendMedical) StartRxNormInferenceJobWithContext added in v1.30.22

func (c *ComprehendMedical) StartRxNormInferenceJobWithContext(ctx aws.Context, input *StartRxNormInferenceJobInput, opts ...request.Option) (*StartRxNormInferenceJobOutput, error)

StartRxNormInferenceJobWithContext is the same as StartRxNormInferenceJob with the addition of the ability to pass a context and additional request options.

See StartRxNormInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StopEntitiesDetectionV2Job added in v1.24.5

StopEntitiesDetectionV2Job API operation for AWS Comprehend Medical.

Stops a medical entities detection job in progress.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StopEntitiesDetectionV2Job for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2Job

func (*ComprehendMedical) StopEntitiesDetectionV2JobRequest added in v1.24.5

func (c *ComprehendMedical) StopEntitiesDetectionV2JobRequest(input *StopEntitiesDetectionV2JobInput) (req *request.Request, output *StopEntitiesDetectionV2JobOutput)

StopEntitiesDetectionV2JobRequest generates a "aws/request.Request" representing the client's request for the StopEntitiesDetectionV2Job operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopEntitiesDetectionV2Job for more information on using the StopEntitiesDetectionV2Job API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopEntitiesDetectionV2JobRequest method.
req, resp := client.StopEntitiesDetectionV2JobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2Job

func (*ComprehendMedical) StopEntitiesDetectionV2JobWithContext added in v1.24.5

func (c *ComprehendMedical) StopEntitiesDetectionV2JobWithContext(ctx aws.Context, input *StopEntitiesDetectionV2JobInput, opts ...request.Option) (*StopEntitiesDetectionV2JobOutput, error)

StopEntitiesDetectionV2JobWithContext is the same as StopEntitiesDetectionV2Job with the addition of the ability to pass a context and additional request options.

See StopEntitiesDetectionV2Job for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StopICD10CMInferenceJob added in v1.30.22

StopICD10CMInferenceJob API operation for AWS Comprehend Medical.

Stops an InferICD10CM inference job in progress.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StopICD10CMInferenceJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJob

func (*ComprehendMedical) StopICD10CMInferenceJobRequest added in v1.30.22

func (c *ComprehendMedical) StopICD10CMInferenceJobRequest(input *StopICD10CMInferenceJobInput) (req *request.Request, output *StopICD10CMInferenceJobOutput)

StopICD10CMInferenceJobRequest generates a "aws/request.Request" representing the client's request for the StopICD10CMInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopICD10CMInferenceJob for more information on using the StopICD10CMInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopICD10CMInferenceJobRequest method.
req, resp := client.StopICD10CMInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJob

func (*ComprehendMedical) StopICD10CMInferenceJobWithContext added in v1.30.22

func (c *ComprehendMedical) StopICD10CMInferenceJobWithContext(ctx aws.Context, input *StopICD10CMInferenceJobInput, opts ...request.Option) (*StopICD10CMInferenceJobOutput, error)

StopICD10CMInferenceJobWithContext is the same as StopICD10CMInferenceJob with the addition of the ability to pass a context and additional request options.

See StopICD10CMInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StopPHIDetectionJob added in v1.24.5

StopPHIDetectionJob API operation for AWS Comprehend Medical.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StopPHIDetectionJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJob

func (*ComprehendMedical) StopPHIDetectionJobRequest added in v1.24.5

func (c *ComprehendMedical) StopPHIDetectionJobRequest(input *StopPHIDetectionJobInput) (req *request.Request, output *StopPHIDetectionJobOutput)

StopPHIDetectionJobRequest generates a "aws/request.Request" representing the client's request for the StopPHIDetectionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopPHIDetectionJob for more information on using the StopPHIDetectionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopPHIDetectionJobRequest method.
req, resp := client.StopPHIDetectionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJob

func (*ComprehendMedical) StopPHIDetectionJobWithContext added in v1.24.5

func (c *ComprehendMedical) StopPHIDetectionJobWithContext(ctx aws.Context, input *StopPHIDetectionJobInput, opts ...request.Option) (*StopPHIDetectionJobOutput, error)

StopPHIDetectionJobWithContext is the same as StopPHIDetectionJob with the addition of the ability to pass a context and additional request options.

See StopPHIDetectionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ComprehendMedical) StopRxNormInferenceJob added in v1.30.22

StopRxNormInferenceJob API operation for AWS Comprehend Medical.

Stops an InferRxNorm inference job in progress.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Comprehend Medical's API operation StopRxNormInferenceJob for usage and error information.

Returned Error Types:

* InvalidRequestException
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the request.

* ResourceNotFoundException
The resource identified by the specified Amazon Resource Name (ARN) was not
found. Check the ARN and try your request again.

* InternalServerException
An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJob

func (*ComprehendMedical) StopRxNormInferenceJobRequest added in v1.30.22

func (c *ComprehendMedical) StopRxNormInferenceJobRequest(input *StopRxNormInferenceJobInput) (req *request.Request, output *StopRxNormInferenceJobOutput)

StopRxNormInferenceJobRequest generates a "aws/request.Request" representing the client's request for the StopRxNormInferenceJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopRxNormInferenceJob for more information on using the StopRxNormInferenceJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopRxNormInferenceJobRequest method.
req, resp := client.StopRxNormInferenceJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJob

func (*ComprehendMedical) StopRxNormInferenceJobWithContext added in v1.30.22

func (c *ComprehendMedical) StopRxNormInferenceJobWithContext(ctx aws.Context, input *StopRxNormInferenceJobInput, opts ...request.Option) (*StopRxNormInferenceJobOutput, error)

StopRxNormInferenceJobWithContext is the same as StopRxNormInferenceJob with the addition of the ability to pass a context and additional request options.

See StopRxNormInferenceJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ComprehendMedicalAsyncJobFilter added in v1.24.5

type ComprehendMedicalAsyncJobFilter struct {

	// Filters on the name of the job.
	JobName *string `min:"1" type:"string"`

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time `type:"timestamp"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information for filtering a list of detection jobs.

func (ComprehendMedicalAsyncJobFilter) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComprehendMedicalAsyncJobFilter) SetJobName added in v1.24.5

SetJobName sets the JobName field's value.

func (*ComprehendMedicalAsyncJobFilter) SetJobStatus added in v1.24.5

SetJobStatus sets the JobStatus field's value.

func (*ComprehendMedicalAsyncJobFilter) SetSubmitTimeAfter added in v1.24.5

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*ComprehendMedicalAsyncJobFilter) SetSubmitTimeBefore added in v1.24.5

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (ComprehendMedicalAsyncJobFilter) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComprehendMedicalAsyncJobFilter) Validate added in v1.24.5

func (s *ComprehendMedicalAsyncJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ComprehendMedicalAsyncJobProperties added in v1.24.5

type ComprehendMedicalAsyncJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read
	// access to your input data.
	DataAccessRoleArn *string `min:"20" type:"string"`

	// The time that the detection job completed.
	EndTime *time.Time `type:"timestamp"`

	// The date and time that job metadata is deleted from the server. Output files
	// in your S3 bucket will not be deleted. After the metadata is deleted, the
	// job will no longer appear in the results of the ListEntitiesDetectionV2Job
	// or the ListPHIDetectionJobs operation.
	ExpirationTime *time.Time `type:"timestamp"`

	// The input data configuration that you supplied when you created the detection
	// job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the detection job.
	JobId *string `min:"1" type:"string"`

	// The name that you assigned to the detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the detection job. If the status is FAILED, the Message
	// field shows the reason for the failure.
	JobStatus *string `type:"string" enum:"JobStatus"`

	// The AWS Key Management Service key, if any, used to encrypt the output files.
	KMSKey *string `min:"1" type:"string"`

	// The language code of the input documents.
	LanguageCode *string `type:"string" enum:"LanguageCode"`

	// The path to the file that describes the results of a batch job.
	ManifestFilePath *string `min:"1" type:"string"`

	// A description of the status of a job.
	Message *string `type:"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 `type:"string"`

	// The output data configuration that you supplied when you created the detection
	// job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Provides information about a detection job.

func (ComprehendMedicalAsyncJobProperties) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComprehendMedicalAsyncJobProperties) SetDataAccessRoleArn added in v1.24.5

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*ComprehendMedicalAsyncJobProperties) SetEndTime added in v1.24.5

SetEndTime sets the EndTime field's value.

func (*ComprehendMedicalAsyncJobProperties) SetExpirationTime added in v1.24.5

SetExpirationTime sets the ExpirationTime field's value.

func (*ComprehendMedicalAsyncJobProperties) SetInputDataConfig added in v1.24.5

SetInputDataConfig sets the InputDataConfig field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobName added in v1.24.5

SetJobName sets the JobName field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobStatus added in v1.24.5

SetJobStatus sets the JobStatus field's value.

func (*ComprehendMedicalAsyncJobProperties) SetKMSKey added in v1.24.5

SetKMSKey sets the KMSKey field's value.

func (*ComprehendMedicalAsyncJobProperties) SetLanguageCode added in v1.24.5

SetLanguageCode sets the LanguageCode field's value.

func (*ComprehendMedicalAsyncJobProperties) SetManifestFilePath added in v1.24.5

SetManifestFilePath sets the ManifestFilePath field's value.

func (*ComprehendMedicalAsyncJobProperties) SetMessage added in v1.24.5

SetMessage sets the Message field's value.

func (*ComprehendMedicalAsyncJobProperties) SetModelVersion added in v1.24.5

SetModelVersion sets the ModelVersion field's value.

func (*ComprehendMedicalAsyncJobProperties) SetOutputDataConfig added in v1.24.5

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*ComprehendMedicalAsyncJobProperties) SetSubmitTime added in v1.24.5

SetSubmitTime sets the SubmitTime field's value.

func (ComprehendMedicalAsyncJobProperties) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEntitiesDetectionV2JobInput added in v1.24.5

type DescribeEntitiesDetectionV2JobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartEntitiesDetectionV2Job operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionV2JobInput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntitiesDetectionV2JobInput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionV2JobInput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntitiesDetectionV2JobInput) Validate added in v1.24.5

Validate inspects the fields of the type to determine if they are valid.

type DescribeEntitiesDetectionV2JobOutput added in v1.24.5

type DescribeEntitiesDetectionV2JobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEntitiesDetectionV2JobOutput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEntitiesDetectionV2JobOutput) SetComprehendMedicalAsyncJobProperties added in v1.24.5

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeEntitiesDetectionV2JobOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeICD10CMInferenceJobInput added in v1.30.22

type DescribeICD10CMInferenceJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartICD10CMInferenceJob operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeICD10CMInferenceJobInput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeICD10CMInferenceJobInput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (DescribeICD10CMInferenceJobInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeICD10CMInferenceJobInput) Validate added in v1.30.22

Validate inspects the fields of the type to determine if they are valid.

type DescribeICD10CMInferenceJobOutput added in v1.30.22

type DescribeICD10CMInferenceJobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeICD10CMInferenceJobOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeICD10CMInferenceJobOutput) SetComprehendMedicalAsyncJobProperties added in v1.30.22

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeICD10CMInferenceJobOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePHIDetectionJobInput added in v1.24.5

type DescribePHIDetectionJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartPHIDetectionJob operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePHIDetectionJobInput) GoString added in v1.24.5

func (s DescribePHIDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePHIDetectionJobInput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (DescribePHIDetectionJobInput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePHIDetectionJobInput) Validate added in v1.24.5

func (s *DescribePHIDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePHIDetectionJobOutput added in v1.24.5

type DescribePHIDetectionJobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribePHIDetectionJobOutput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePHIDetectionJobOutput) SetComprehendMedicalAsyncJobProperties added in v1.24.5

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribePHIDetectionJobOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRxNormInferenceJobInput added in v1.30.22

type DescribeRxNormInferenceJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartRxNormInferenceJob operation returns this identifier in its response.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRxNormInferenceJobInput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRxNormInferenceJobInput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (DescribeRxNormInferenceJobInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRxNormInferenceJobInput) Validate added in v1.30.22

func (s *DescribeRxNormInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRxNormInferenceJobOutput added in v1.30.22

type DescribeRxNormInferenceJobOutput struct {

	// An object that contains the properties associated with a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeRxNormInferenceJobOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRxNormInferenceJobOutput) SetComprehendMedicalAsyncJobProperties added in v1.30.22

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeRxNormInferenceJobOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectEntitiesInput) GoString

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesInput) SetText

SetText sets the Text field's value.

func (DetectEntitiesInput) String

func (s DetectEntitiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesInput) Validate

func (s *DetectEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// Entities is a required field
	Entities []*Entity `type:"list" required:"true"`

	// 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 is a required field
	ModelVersion *string `min:"1" type:"string" required:"true"`

	// If the result of the previous request to DetectEntities was truncated, include
	// the PaginationToken to fetch the next page of entities.
	PaginationToken *string `min:"1" type:"string"`

	// Attributes extracted from the input text that we were unable to relate to
	// an entity.
	UnmappedAttributes []*UnmappedAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DetectEntitiesOutput) GoString

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesOutput) SetEntities

func (s *DetectEntitiesOutput) SetEntities(v []*Entity) *DetectEntitiesOutput

SetEntities sets the Entities field's value.

func (*DetectEntitiesOutput) SetModelVersion added in v1.24.5

func (s *DetectEntitiesOutput) SetModelVersion(v string) *DetectEntitiesOutput

SetModelVersion sets the ModelVersion field's value.

func (*DetectEntitiesOutput) SetPaginationToken

func (s *DetectEntitiesOutput) SetPaginationToken(v string) *DetectEntitiesOutput

SetPaginationToken sets the PaginationToken field's value.

func (*DetectEntitiesOutput) SetUnmappedAttributes

func (s *DetectEntitiesOutput) SetUnmappedAttributes(v []*UnmappedAttribute) *DetectEntitiesOutput

SetUnmappedAttributes sets the UnmappedAttributes field's value.

func (DetectEntitiesOutput) String

func (s DetectEntitiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetectEntitiesV2Input added in v1.24.5

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 is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectEntitiesV2Input) GoString added in v1.24.5

func (s DetectEntitiesV2Input) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesV2Input) SetText added in v1.24.5

SetText sets the Text field's value.

func (DetectEntitiesV2Input) String added in v1.24.5

func (s DetectEntitiesV2Input) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesV2Input) Validate added in v1.24.5

func (s *DetectEntitiesV2Input) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectEntitiesV2Output added in v1.24.5

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.
	//
	// Entities is a required field
	Entities []*Entity `type:"list" required:"true"`

	// 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 is a required field
	ModelVersion *string `min:"1" type:"string" required:"true"`

	// If the result to the DetectEntitiesV2 operation was truncated, include the
	// PaginationToken to fetch the next page of entities.
	PaginationToken *string `min:"1" type:"string"`

	// Attributes extracted from the input text that couldn't be related to an entity.
	UnmappedAttributes []*UnmappedAttribute `type:"list"`
	// contains filtered or unexported fields
}

func (DetectEntitiesV2Output) GoString added in v1.24.5

func (s DetectEntitiesV2Output) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectEntitiesV2Output) SetEntities added in v1.24.5

SetEntities sets the Entities field's value.

func (*DetectEntitiesV2Output) SetModelVersion added in v1.24.5

func (s *DetectEntitiesV2Output) SetModelVersion(v string) *DetectEntitiesV2Output

SetModelVersion sets the ModelVersion field's value.

func (*DetectEntitiesV2Output) SetPaginationToken added in v1.24.5

func (s *DetectEntitiesV2Output) SetPaginationToken(v string) *DetectEntitiesV2Output

SetPaginationToken sets the PaginationToken field's value.

func (*DetectEntitiesV2Output) SetUnmappedAttributes added in v1.24.5

func (s *DetectEntitiesV2Output) SetUnmappedAttributes(v []*UnmappedAttribute) *DetectEntitiesV2Output

SetUnmappedAttributes sets the UnmappedAttributes field's value.

func (DetectEntitiesV2Output) String added in v1.24.5

func (s DetectEntitiesV2Output) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectPHIInput) GoString

func (s DetectPHIInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectPHIInput) SetText

func (s *DetectPHIInput) SetText(v string) *DetectPHIInput

SetText sets the Text field's value.

func (DetectPHIInput) String

func (s DetectPHIInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectPHIInput) Validate

func (s *DetectPHIInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// Entities is a required field
	Entities []*Entity `type:"list" required:"true"`

	// 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 is a required field
	ModelVersion *string `min:"1" type:"string" required:"true"`

	// If the result of the previous request to DetectPHI was truncated, include
	// the PaginationToken to fetch the next page of PHI entities.
	PaginationToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DetectPHIOutput) GoString

func (s DetectPHIOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetectPHIOutput) SetEntities

func (s *DetectPHIOutput) SetEntities(v []*Entity) *DetectPHIOutput

SetEntities sets the Entities field's value.

func (*DetectPHIOutput) SetModelVersion added in v1.24.5

func (s *DetectPHIOutput) SetModelVersion(v string) *DetectPHIOutput

SetModelVersion sets the ModelVersion field's value.

func (*DetectPHIOutput) SetPaginationToken

func (s *DetectPHIOutput) SetPaginationToken(v string) *DetectPHIOutput

SetPaginationToken sets the PaginationToken field's value.

func (DetectPHIOutput) String

func (s DetectPHIOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Entity

type Entity struct {

	// The extracted attributes that relate to this entity.
	Attributes []*Attribute `type:"list"`

	// The 0-based character offset in the input text that shows where the entity
	// begins. The offset returns the UTF-8 code point in the string.
	BeginOffset *int64 `type:"integer"`

	// The category of the entity.
	Category *string `type:"string" enum:"EntityType"`

	// The 0-based character offset in the input text that shows where the entity
	// ends. The offset returns the UTF-8 code point in the string.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for the entity. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detection.
	Score *float64 `type:"float"`

	// The segment of input text extracted as this entity.
	Text *string `min:"1" type:"string"`

	// Contextual information for the entity.
	Traits []*Trait `type:"list"`

	// Describes the specific type of entity with category of entities.
	Type *string `type:"string" enum:"EntitySubType"`
	// contains filtered or unexported fields
}

Provides information about an extracted medical entity.

func (Entity) GoString

func (s Entity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Entity) SetAttributes

func (s *Entity) SetAttributes(v []*Attribute) *Entity

SetAttributes sets the Attributes field's value.

func (*Entity) SetBeginOffset

func (s *Entity) SetBeginOffset(v int64) *Entity

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetCategory

func (s *Entity) SetCategory(v string) *Entity

SetCategory sets the Category field's value.

func (*Entity) SetEndOffset

func (s *Entity) SetEndOffset(v int64) *Entity

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetId

func (s *Entity) SetId(v int64) *Entity

SetId sets the Id field's value.

func (*Entity) SetScore

func (s *Entity) SetScore(v float64) *Entity

SetScore sets the Score field's value.

func (*Entity) SetText

func (s *Entity) SetText(v string) *Entity

SetText sets the Text field's value.

func (*Entity) SetTraits

func (s *Entity) SetTraits(v []*Trait) *Entity

SetTraits sets the Traits field's value.

func (*Entity) SetType

func (s *Entity) SetType(v string) *Entity

SetType sets the Type field's value.

func (Entity) String

func (s Entity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ICD10CMAttribute added in v1.26.3

type ICD10CMAttribute struct {

	// The 0-based character offset in the input text that shows where the attribute
	// begins. The offset returns the UTF-8 code point in the string.
	BeginOffset *int64 `type:"integer"`

	// The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.
	Category *string `type:"string" enum:"ICD10CMEntityType"`

	// The 0-based character offset in the input text that shows where the attribute
	// ends. The offset returns the UTF-8 code point in the string.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for this attribute. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has that this attribute
	// is correctly related to this entity.
	RelationshipScore *float64 `type:"float"`

	// The type of relationship between the entity and attribute. Type for the relationship
	// can be either of OVERLAP or SYSTEM_ORGAN_SITE.
	RelationshipType *string `type:"string" enum:"ICD10CMRelationshipType"`

	// The level of confidence that Amazon Comprehend Medical has that the segment
	// of text is correctly recognized as an attribute.
	Score *float64 `type:"float"`

	// The segment of input text which contains the detected attribute.
	Text *string `min:"1" type:"string"`

	// The contextual information for the attribute. The traits recognized by InferICD10CM
	// are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
	Traits []*ICD10CMTrait `type:"list"`

	// The type of attribute. InferICD10CM detects entities of the type DX_NAME.
	Type *string `type:"string" enum:"ICD10CMAttributeType"`
	// contains filtered or unexported fields
}

The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: Direction, System, Organ or Site, and Acuity.

func (ICD10CMAttribute) GoString added in v1.26.3

func (s ICD10CMAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ICD10CMAttribute) SetBeginOffset added in v1.26.3

func (s *ICD10CMAttribute) SetBeginOffset(v int64) *ICD10CMAttribute

SetBeginOffset sets the BeginOffset field's value.

func (*ICD10CMAttribute) SetCategory added in v1.38.19

func (s *ICD10CMAttribute) SetCategory(v string) *ICD10CMAttribute

SetCategory sets the Category field's value.

func (*ICD10CMAttribute) SetEndOffset added in v1.26.3

func (s *ICD10CMAttribute) SetEndOffset(v int64) *ICD10CMAttribute

SetEndOffset sets the EndOffset field's value.

func (*ICD10CMAttribute) SetId added in v1.26.3

SetId sets the Id field's value.

func (*ICD10CMAttribute) SetRelationshipScore added in v1.26.3

func (s *ICD10CMAttribute) SetRelationshipScore(v float64) *ICD10CMAttribute

SetRelationshipScore sets the RelationshipScore field's value.

func (*ICD10CMAttribute) SetRelationshipType added in v1.38.19

func (s *ICD10CMAttribute) SetRelationshipType(v string) *ICD10CMAttribute

SetRelationshipType sets the RelationshipType field's value.

func (*ICD10CMAttribute) SetScore added in v1.26.3

func (s *ICD10CMAttribute) SetScore(v float64) *ICD10CMAttribute

SetScore sets the Score field's value.

func (*ICD10CMAttribute) SetText added in v1.26.3

func (s *ICD10CMAttribute) SetText(v string) *ICD10CMAttribute

SetText sets the Text field's value.

func (*ICD10CMAttribute) SetTraits added in v1.26.3

func (s *ICD10CMAttribute) SetTraits(v []*ICD10CMTrait) *ICD10CMAttribute

SetTraits sets the Traits field's value.

func (*ICD10CMAttribute) SetType added in v1.26.3

func (s *ICD10CMAttribute) SetType(v string) *ICD10CMAttribute

SetType sets the Type field's value.

func (ICD10CMAttribute) String added in v1.26.3

func (s ICD10CMAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ICD10CMConcept added in v1.26.3

type ICD10CMConcept struct {

	// The ICD-10-CM code that identifies the concept found in the knowledge base
	// from the Centers for Disease Control.
	Code *string `min:"1" type:"string"`

	// The long description of the ICD-10-CM code in the ontology.
	Description *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend Medical has that the entity
	// is accurately linked to an ICD-10-CM concept.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

func (ICD10CMConcept) GoString added in v1.26.3

func (s ICD10CMConcept) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ICD10CMConcept) SetCode added in v1.26.3

func (s *ICD10CMConcept) SetCode(v string) *ICD10CMConcept

SetCode sets the Code field's value.

func (*ICD10CMConcept) SetDescription added in v1.26.3

func (s *ICD10CMConcept) SetDescription(v string) *ICD10CMConcept

SetDescription sets the Description field's value.

func (*ICD10CMConcept) SetScore added in v1.26.3

func (s *ICD10CMConcept) SetScore(v float64) *ICD10CMConcept

SetScore sets the Score field's value.

func (ICD10CMConcept) String added in v1.26.3

func (s ICD10CMConcept) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ICD10CMEntity added in v1.26.3

type ICD10CMEntity struct {

	// The detected attributes that relate to the entity. An extracted segment of
	// the text that is an attribute of an entity, or otherwise related to an entity,
	// such as the nature of a medical condition.
	Attributes []*ICD10CMAttribute `type:"list"`

	// The 0-based character offset in the input text that shows where the entity
	// begins. The offset returns the UTF-8 code point in the string.
	BeginOffset *int64 `type:"integer"`

	// The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION
	// category.
	Category *string `type:"string" enum:"ICD10CMEntityCategory"`

	// The 0-based character offset in the input text that shows where the entity
	// ends. The offset returns the UTF-8 code point in the string.
	EndOffset *int64 `type:"integer"`

	// The ICD-10-CM concepts that the entity could refer to, along with a score
	// indicating the likelihood of the match.
	ICD10CMConcepts []*ICD10CMConcept `type:"list"`

	// The numeric identifier for the entity. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detection.
	Score *float64 `type:"float"`

	// The segment of input text that is matched to the detected entity.
	Text *string `min:"1" type:"string"`

	// Provides Contextual information for the entity. The traits recognized by
	// InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.
	Traits []*ICD10CMTrait `type:"list"`

	// Describes the specific type of entity with category of entities. InferICD10CM
	// detects entities of the type DX_NAME and TIME_EXPRESSION.
	Type *string `type:"string" enum:"ICD10CMEntityType"`
	// contains filtered or unexported fields
}

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.

func (ICD10CMEntity) GoString added in v1.26.3

func (s ICD10CMEntity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ICD10CMEntity) SetAttributes added in v1.26.3

func (s *ICD10CMEntity) SetAttributes(v []*ICD10CMAttribute) *ICD10CMEntity

SetAttributes sets the Attributes field's value.

func (*ICD10CMEntity) SetBeginOffset added in v1.26.3

func (s *ICD10CMEntity) SetBeginOffset(v int64) *ICD10CMEntity

SetBeginOffset sets the BeginOffset field's value.

func (*ICD10CMEntity) SetCategory added in v1.26.3

func (s *ICD10CMEntity) SetCategory(v string) *ICD10CMEntity

SetCategory sets the Category field's value.

func (*ICD10CMEntity) SetEndOffset added in v1.26.3

func (s *ICD10CMEntity) SetEndOffset(v int64) *ICD10CMEntity

SetEndOffset sets the EndOffset field's value.

func (*ICD10CMEntity) SetICD10CMConcepts added in v1.26.3

func (s *ICD10CMEntity) SetICD10CMConcepts(v []*ICD10CMConcept) *ICD10CMEntity

SetICD10CMConcepts sets the ICD10CMConcepts field's value.

func (*ICD10CMEntity) SetId added in v1.26.3

func (s *ICD10CMEntity) SetId(v int64) *ICD10CMEntity

SetId sets the Id field's value.

func (*ICD10CMEntity) SetScore added in v1.26.3

func (s *ICD10CMEntity) SetScore(v float64) *ICD10CMEntity

SetScore sets the Score field's value.

func (*ICD10CMEntity) SetText added in v1.26.3

func (s *ICD10CMEntity) SetText(v string) *ICD10CMEntity

SetText sets the Text field's value.

func (*ICD10CMEntity) SetTraits added in v1.26.3

func (s *ICD10CMEntity) SetTraits(v []*ICD10CMTrait) *ICD10CMEntity

SetTraits sets the Traits field's value.

func (*ICD10CMEntity) SetType added in v1.26.3

func (s *ICD10CMEntity) SetType(v string) *ICD10CMEntity

SetType sets the Type field's value.

func (ICD10CMEntity) String added in v1.26.3

func (s ICD10CMEntity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ICD10CMTrait added in v1.26.3

type ICD10CMTrait struct {

	// Provides a name or contextual description about the trait.
	Name *string `type:"string" enum:"ICD10CMTraitName"`

	// The level of confidence that Amazon Comprehend Medical has that the segment
	// of text is correctly recognized as a trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

func (ICD10CMTrait) GoString added in v1.26.3

func (s ICD10CMTrait) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ICD10CMTrait) SetName added in v1.26.3

func (s *ICD10CMTrait) SetName(v string) *ICD10CMTrait

SetName sets the Name field's value.

func (*ICD10CMTrait) SetScore added in v1.26.3

func (s *ICD10CMTrait) SetScore(v float64) *ICD10CMTrait

SetScore sets the Score field's value.

func (ICD10CMTrait) String added in v1.26.3

func (s ICD10CMTrait) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferICD10CMInput added in v1.26.3

type InferICD10CMInput struct {

	// The input text used for analysis. The input for InferICD10CM is a string
	// from 1 to 10000 characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InferICD10CMInput) GoString added in v1.26.3

func (s InferICD10CMInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferICD10CMInput) SetText added in v1.26.3

SetText sets the Text field's value.

func (InferICD10CMInput) String added in v1.26.3

func (s InferICD10CMInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferICD10CMInput) Validate added in v1.26.3

func (s *InferICD10CMInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InferICD10CMOutput added in v1.26.3

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 is a required field
	Entities []*ICD10CMEntity `type:"list" required:"true"`

	// 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 `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (InferICD10CMOutput) GoString added in v1.26.3

func (s InferICD10CMOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferICD10CMOutput) SetEntities added in v1.26.3

func (s *InferICD10CMOutput) SetEntities(v []*ICD10CMEntity) *InferICD10CMOutput

SetEntities sets the Entities field's value.

func (*InferICD10CMOutput) SetModelVersion added in v1.26.3

func (s *InferICD10CMOutput) SetModelVersion(v string) *InferICD10CMOutput

SetModelVersion sets the ModelVersion field's value.

func (*InferICD10CMOutput) SetPaginationToken added in v1.26.3

func (s *InferICD10CMOutput) SetPaginationToken(v string) *InferICD10CMOutput

SetPaginationToken sets the PaginationToken field's value.

func (InferICD10CMOutput) String added in v1.26.3

func (s InferICD10CMOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferRxNormInput added in v1.26.3

type InferRxNormInput struct {

	// The input text used for analysis. The input for InferRxNorm is a string from
	// 1 to 10000 characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InferRxNormInput) GoString added in v1.26.3

func (s InferRxNormInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferRxNormInput) SetText added in v1.26.3

func (s *InferRxNormInput) SetText(v string) *InferRxNormInput

SetText sets the Text field's value.

func (InferRxNormInput) String added in v1.26.3

func (s InferRxNormInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferRxNormInput) Validate added in v1.26.3

func (s *InferRxNormInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InferRxNormOutput added in v1.26.3

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 is a required field
	Entities []*RxNormEntity `type:"list" required:"true"`

	// 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 `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (InferRxNormOutput) GoString added in v1.26.3

func (s InferRxNormOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferRxNormOutput) SetEntities added in v1.26.3

func (s *InferRxNormOutput) SetEntities(v []*RxNormEntity) *InferRxNormOutput

SetEntities sets the Entities field's value.

func (*InferRxNormOutput) SetModelVersion added in v1.26.3

func (s *InferRxNormOutput) SetModelVersion(v string) *InferRxNormOutput

SetModelVersion sets the ModelVersion field's value.

func (*InferRxNormOutput) SetPaginationToken added in v1.26.3

func (s *InferRxNormOutput) SetPaginationToken(v string) *InferRxNormOutput

SetPaginationToken sets the PaginationToken field's value.

func (InferRxNormOutput) String added in v1.26.3

func (s InferRxNormOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputDataConfig added in v1.24.5

type InputDataConfig struct {

	// The URI of the S3 bucket that contains the input data. The bucket must be
	// in the same region as the API endpoint that you are calling.
	//
	// Each file in the document collection must be less than 40 KB. You can store
	// a maximum of 30 GB in the bucket.
	//
	// S3Bucket is a required field
	S3Bucket *string `min:"3" type:"string" required:"true"`

	// The path to the input data files in the S3 bucket.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (InputDataConfig) GoString added in v1.24.5

func (s InputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDataConfig) SetS3Bucket added in v1.24.5

func (s *InputDataConfig) SetS3Bucket(v string) *InputDataConfig

SetS3Bucket sets the S3Bucket field's value.

func (*InputDataConfig) SetS3Key added in v1.24.5

func (s *InputDataConfig) SetS3Key(v string) *InputDataConfig

SetS3Key sets the S3Key field's value.

func (InputDataConfig) String added in v1.24.5

func (s InputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputDataConfig) Validate added in v1.24.5

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException added in v1.28.0

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Code added in v1.28.0

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error added in v1.28.0

func (s *InternalServerException) Error() string

func (InternalServerException) GoString added in v1.28.0

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message added in v1.28.0

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr added in v1.28.0

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID added in v1.28.0

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode added in v1.28.0

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String added in v1.28.0

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidEncodingException added in v1.28.0

type InvalidEncodingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.

func (*InvalidEncodingException) Code added in v1.28.0

func (s *InvalidEncodingException) Code() string

Code returns the exception type name.

func (*InvalidEncodingException) Error added in v1.28.0

func (s *InvalidEncodingException) Error() string

func (InvalidEncodingException) GoString added in v1.28.0

func (s InvalidEncodingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidEncodingException) Message added in v1.28.0

func (s *InvalidEncodingException) Message() string

Message returns the exception's message.

func (*InvalidEncodingException) OrigErr added in v1.28.0

func (s *InvalidEncodingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEncodingException) RequestID added in v1.28.0

func (s *InvalidEncodingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEncodingException) StatusCode added in v1.28.0

func (s *InvalidEncodingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidEncodingException) String added in v1.28.0

func (s InvalidEncodingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

func (*InvalidRequestException) Code added in v1.28.0

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEntitiesDetectionV2JobsInput added in v1.24.5

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 *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionV2JobsInput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesDetectionV2JobsInput) SetFilter added in v1.24.5

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionV2JobsInput) SetMaxResults added in v1.24.5

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionV2JobsInput) SetNextToken added in v1.24.5

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionV2JobsInput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesDetectionV2JobsInput) Validate added in v1.24.5

Validate inspects the fields of the type to determine if they are valid.

type ListEntitiesDetectionV2JobsOutput added in v1.24.5

type ListEntitiesDetectionV2JobsOutput struct {

	// A list containing the properties of each job returned.
	ComprehendMedicalAsyncJobPropertiesList []*ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEntitiesDetectionV2JobsOutput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEntitiesDetectionV2JobsOutput) SetComprehendMedicalAsyncJobPropertiesList added in v1.24.5

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListEntitiesDetectionV2JobsOutput) SetNextToken added in v1.24.5

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionV2JobsOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListICD10CMInferenceJobsInput added in v1.30.22

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 *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListICD10CMInferenceJobsInput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListICD10CMInferenceJobsInput) SetFilter added in v1.30.22

SetFilter sets the Filter field's value.

func (*ListICD10CMInferenceJobsInput) SetMaxResults added in v1.30.22

SetMaxResults sets the MaxResults field's value.

func (*ListICD10CMInferenceJobsInput) SetNextToken added in v1.30.22

SetNextToken sets the NextToken field's value.

func (ListICD10CMInferenceJobsInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListICD10CMInferenceJobsInput) Validate added in v1.30.22

func (s *ListICD10CMInferenceJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListICD10CMInferenceJobsOutput added in v1.30.22

type ListICD10CMInferenceJobsOutput struct {

	// A list containing the properties of each job that is returned.
	ComprehendMedicalAsyncJobPropertiesList []*ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListICD10CMInferenceJobsOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListICD10CMInferenceJobsOutput) SetComprehendMedicalAsyncJobPropertiesList added in v1.30.22

func (s *ListICD10CMInferenceJobsOutput) SetComprehendMedicalAsyncJobPropertiesList(v []*ComprehendMedicalAsyncJobProperties) *ListICD10CMInferenceJobsOutput

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListICD10CMInferenceJobsOutput) SetNextToken added in v1.30.22

SetNextToken sets the NextToken field's value.

func (ListICD10CMInferenceJobsOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPHIDetectionJobsInput added in v1.24.5

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 *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// The maximum number of results to return in each page. The default is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPHIDetectionJobsInput) GoString added in v1.24.5

func (s ListPHIDetectionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPHIDetectionJobsInput) SetFilter added in v1.24.5

SetFilter sets the Filter field's value.

func (*ListPHIDetectionJobsInput) SetMaxResults added in v1.24.5

SetMaxResults sets the MaxResults field's value.

func (*ListPHIDetectionJobsInput) SetNextToken added in v1.24.5

SetNextToken sets the NextToken field's value.

func (ListPHIDetectionJobsInput) String added in v1.24.5

func (s ListPHIDetectionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPHIDetectionJobsInput) Validate added in v1.24.5

func (s *ListPHIDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPHIDetectionJobsOutput added in v1.24.5

type ListPHIDetectionJobsOutput struct {

	// A list containing the properties of each job returned.
	ComprehendMedicalAsyncJobPropertiesList []*ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPHIDetectionJobsOutput) GoString added in v1.24.5

func (s ListPHIDetectionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPHIDetectionJobsOutput) SetComprehendMedicalAsyncJobPropertiesList added in v1.24.5

func (s *ListPHIDetectionJobsOutput) SetComprehendMedicalAsyncJobPropertiesList(v []*ComprehendMedicalAsyncJobProperties) *ListPHIDetectionJobsOutput

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListPHIDetectionJobsOutput) SetNextToken added in v1.24.5

SetNextToken sets the NextToken field's value.

func (ListPHIDetectionJobsOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRxNormInferenceJobsInput added in v1.30.22

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 *ComprehendMedicalAsyncJobFilter `type:"structure"`

	// Identifies the next page of results to return.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRxNormInferenceJobsInput) GoString added in v1.30.22

func (s ListRxNormInferenceJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRxNormInferenceJobsInput) SetFilter added in v1.30.22

SetFilter sets the Filter field's value.

func (*ListRxNormInferenceJobsInput) SetMaxResults added in v1.30.22

SetMaxResults sets the MaxResults field's value.

func (*ListRxNormInferenceJobsInput) SetNextToken added in v1.30.22

SetNextToken sets the NextToken field's value.

func (ListRxNormInferenceJobsInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRxNormInferenceJobsInput) Validate added in v1.30.22

func (s *ListRxNormInferenceJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRxNormInferenceJobsOutput added in v1.30.22

type ListRxNormInferenceJobsOutput struct {

	// The maximum number of results to return in each page. The default is 100.
	ComprehendMedicalAsyncJobPropertiesList []*ComprehendMedicalAsyncJobProperties `type:"list"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRxNormInferenceJobsOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRxNormInferenceJobsOutput) SetComprehendMedicalAsyncJobPropertiesList added in v1.30.22

func (s *ListRxNormInferenceJobsOutput) SetComprehendMedicalAsyncJobPropertiesList(v []*ComprehendMedicalAsyncJobProperties) *ListRxNormInferenceJobsOutput

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListRxNormInferenceJobsOutput) SetNextToken added in v1.30.22

SetNextToken sets the NextToken field's value.

func (ListRxNormInferenceJobsOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OutputDataConfig added in v1.24.5

type OutputDataConfig struct {

	// When you use the OutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location where you want to write the output data. The
	// URI must be in the same region as the API endpoint that you are calling.
	// The location is used as the prefix for the actual location of the output.
	//
	// S3Bucket is a required field
	S3Bucket *string `min:"3" type:"string" required:"true"`

	// The path to the output data files in the S3 bucket. Amazon Comprehend Medical
	// creates an output directory using the job ID so that the output from one
	// job does not overwrite the output of another.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

The output properties for a detection job.

func (OutputDataConfig) GoString added in v1.24.5

func (s OutputDataConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) SetS3Bucket added in v1.24.5

func (s *OutputDataConfig) SetS3Bucket(v string) *OutputDataConfig

SetS3Bucket sets the S3Bucket field's value.

func (*OutputDataConfig) SetS3Key added in v1.24.5

func (s *OutputDataConfig) SetS3Key(v string) *OutputDataConfig

SetS3Key sets the S3Key field's value.

func (OutputDataConfig) String added in v1.24.5

func (s OutputDataConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OutputDataConfig) Validate added in v1.24.5

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException added in v1.28.0

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RxNormAttribute added in v1.26.3

type RxNormAttribute struct {

	// The 0-based character offset in the input text that shows where the attribute
	// begins. The offset returns the UTF-8 code point in the string.
	BeginOffset *int64 `type:"integer"`

	// The 0-based character offset in the input text that shows where the attribute
	// ends. The offset returns the UTF-8 code point in the string.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for this attribute. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend Medical has that the attribute
	// is accurately linked to an entity.
	RelationshipScore *float64 `type:"float"`

	// The level of confidence that Comprehend Medical has that the segment of text
	// is correctly recognized as an attribute.
	Score *float64 `type:"float"`

	// The segment of input text which corresponds to the detected attribute.
	Text *string `min:"1" type:"string"`

	// Contextual information for the attribute. InferRxNorm recognizes the trait
	// NEGATION for attributes, i.e. that the patient is not taking a specific dose
	// or form of a medication.
	Traits []*RxNormTrait `type:"list"`

	// The type of attribute. The types of attributes recognized by InferRxNorm
	// are BRAND_NAME and GENERIC_NAME.
	Type *string `type:"string" enum:"RxNormAttributeType"`
	// contains filtered or unexported fields
}

The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE.

func (RxNormAttribute) GoString added in v1.26.3

func (s RxNormAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RxNormAttribute) SetBeginOffset added in v1.26.3

func (s *RxNormAttribute) SetBeginOffset(v int64) *RxNormAttribute

SetBeginOffset sets the BeginOffset field's value.

func (*RxNormAttribute) SetEndOffset added in v1.26.3

func (s *RxNormAttribute) SetEndOffset(v int64) *RxNormAttribute

SetEndOffset sets the EndOffset field's value.

func (*RxNormAttribute) SetId added in v1.26.3

func (s *RxNormAttribute) SetId(v int64) *RxNormAttribute

SetId sets the Id field's value.

func (*RxNormAttribute) SetRelationshipScore added in v1.26.3

func (s *RxNormAttribute) SetRelationshipScore(v float64) *RxNormAttribute

SetRelationshipScore sets the RelationshipScore field's value.

func (*RxNormAttribute) SetScore added in v1.26.3

func (s *RxNormAttribute) SetScore(v float64) *RxNormAttribute

SetScore sets the Score field's value.

func (*RxNormAttribute) SetText added in v1.26.3

func (s *RxNormAttribute) SetText(v string) *RxNormAttribute

SetText sets the Text field's value.

func (*RxNormAttribute) SetTraits added in v1.26.3

func (s *RxNormAttribute) SetTraits(v []*RxNormTrait) *RxNormAttribute

SetTraits sets the Traits field's value.

func (*RxNormAttribute) SetType added in v1.26.3

func (s *RxNormAttribute) SetType(v string) *RxNormAttribute

SetType sets the Type field's value.

func (RxNormAttribute) String added in v1.26.3

func (s RxNormAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RxNormConcept added in v1.26.3

type RxNormConcept struct {

	// RxNorm concept ID, also known as the RxCUI.
	Code *string `min:"1" type:"string"`

	// The description of the RxNorm concept.
	Description *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend Medical has that the entity
	// is accurately linked to the reported RxNorm concept.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.

func (RxNormConcept) GoString added in v1.26.3

func (s RxNormConcept) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RxNormConcept) SetCode added in v1.26.3

func (s *RxNormConcept) SetCode(v string) *RxNormConcept

SetCode sets the Code field's value.

func (*RxNormConcept) SetDescription added in v1.26.3

func (s *RxNormConcept) SetDescription(v string) *RxNormConcept

SetDescription sets the Description field's value.

func (*RxNormConcept) SetScore added in v1.26.3

func (s *RxNormConcept) SetScore(v float64) *RxNormConcept

SetScore sets the Score field's value.

func (RxNormConcept) String added in v1.26.3

func (s RxNormConcept) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RxNormEntity added in v1.26.3

type RxNormEntity struct {

	// The extracted attributes that relate to the entity. The attributes recognized
	// by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE,
	// and STRENGTH.
	Attributes []*RxNormAttribute `type:"list"`

	// The 0-based character offset in the input text that shows where the entity
	// begins. The offset returns the UTF-8 code point in the string.
	BeginOffset *int64 `type:"integer"`

	// The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
	Category *string `type:"string" enum:"RxNormEntityCategory"`

	// The 0-based character offset in the input text that shows where the entity
	// ends. The offset returns the UTF-8 code point in the string.
	EndOffset *int64 `type:"integer"`

	// The numeric identifier for the entity. This is a monotonically increasing
	// id unique within this response rather than a global unique identifier.
	Id *int64 `type:"integer"`

	// The RxNorm concepts that the entity could refer to, along with a score indicating
	// the likelihood of the match.
	RxNormConcepts []*RxNormConcept `type:"list"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detected entity.
	Score *float64 `type:"float"`

	// The segment of input text extracted from which the entity was detected.
	Text *string `min:"1" type:"string"`

	// Contextual information for the entity.
	Traits []*RxNormTrait `type:"list"`

	// Describes the specific type of entity. For InferRxNorm, the recognized entity
	// type is MEDICATION.
	Type *string `type:"string" enum:"RxNormEntityType"`
	// contains filtered or unexported fields
}

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.

func (RxNormEntity) GoString added in v1.26.3

func (s RxNormEntity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RxNormEntity) SetAttributes added in v1.26.3

func (s *RxNormEntity) SetAttributes(v []*RxNormAttribute) *RxNormEntity

SetAttributes sets the Attributes field's value.

func (*RxNormEntity) SetBeginOffset added in v1.26.3

func (s *RxNormEntity) SetBeginOffset(v int64) *RxNormEntity

SetBeginOffset sets the BeginOffset field's value.

func (*RxNormEntity) SetCategory added in v1.26.3

func (s *RxNormEntity) SetCategory(v string) *RxNormEntity

SetCategory sets the Category field's value.

func (*RxNormEntity) SetEndOffset added in v1.26.3

func (s *RxNormEntity) SetEndOffset(v int64) *RxNormEntity

SetEndOffset sets the EndOffset field's value.

func (*RxNormEntity) SetId added in v1.26.3

func (s *RxNormEntity) SetId(v int64) *RxNormEntity

SetId sets the Id field's value.

func (*RxNormEntity) SetRxNormConcepts added in v1.26.3

func (s *RxNormEntity) SetRxNormConcepts(v []*RxNormConcept) *RxNormEntity

SetRxNormConcepts sets the RxNormConcepts field's value.

func (*RxNormEntity) SetScore added in v1.26.3

func (s *RxNormEntity) SetScore(v float64) *RxNormEntity

SetScore sets the Score field's value.

func (*RxNormEntity) SetText added in v1.26.3

func (s *RxNormEntity) SetText(v string) *RxNormEntity

SetText sets the Text field's value.

func (*RxNormEntity) SetTraits added in v1.26.3

func (s *RxNormEntity) SetTraits(v []*RxNormTrait) *RxNormEntity

SetTraits sets the Traits field's value.

func (*RxNormEntity) SetType added in v1.26.3

func (s *RxNormEntity) SetType(v string) *RxNormEntity

SetType sets the Type field's value.

func (RxNormEntity) String added in v1.26.3

func (s RxNormEntity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RxNormTrait added in v1.26.3

type RxNormTrait struct {

	// Provides a name or contextual description about the trait.
	Name *string `type:"string" enum:"RxNormTraitName"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of the detected trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The contextual information for the entity. InferRxNorm recognizes the trait NEGATION, which is any indication that the patient is not taking a medication.

func (RxNormTrait) GoString added in v1.26.3

func (s RxNormTrait) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RxNormTrait) SetName added in v1.26.3

func (s *RxNormTrait) SetName(v string) *RxNormTrait

SetName sets the Name field's value.

func (*RxNormTrait) SetScore added in v1.26.3

func (s *RxNormTrait) SetScore(v float64) *RxNormTrait

SetScore sets the Score field's value.

func (RxNormTrait) String added in v1.26.3

func (s RxNormTrait) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException added in v1.28.0

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

func (*ServiceUnavailableException) Code added in v1.28.0

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0

func (ServiceUnavailableException) GoString added in v1.28.0

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message added in v1.28.0

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartEntitiesDetectionV2JobInput added in v1.24.5

type StartEntitiesDetectionV2JobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"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 `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionV2JobInput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEntitiesDetectionV2JobInput) SetClientRequestToken added in v1.24.5

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionV2JobInput) SetDataAccessRoleArn added in v1.24.5

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionV2JobInput) SetInputDataConfig added in v1.24.5

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionV2JobInput) SetJobName added in v1.24.5

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionV2JobInput) SetKMSKey added in v1.24.5

SetKMSKey sets the KMSKey field's value.

func (*StartEntitiesDetectionV2JobInput) SetLanguageCode added in v1.24.5

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionV2JobInput) SetOutputDataConfig added in v1.24.5

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartEntitiesDetectionV2JobInput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEntitiesDetectionV2JobInput) Validate added in v1.24.5

Validate inspects the fields of the type to determine if they are valid.

type StartEntitiesDetectionV2JobOutput added in v1.24.5

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionV2JobOutput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartEntitiesDetectionV2JobOutput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (StartEntitiesDetectionV2JobOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartICD10CMInferenceJobInput added in v1.30.22

type StartICD10CMInferenceJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"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 `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartICD10CMInferenceJobInput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartICD10CMInferenceJobInput) SetClientRequestToken added in v1.30.22

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartICD10CMInferenceJobInput) SetDataAccessRoleArn added in v1.30.22

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartICD10CMInferenceJobInput) SetInputDataConfig added in v1.30.22

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartICD10CMInferenceJobInput) SetJobName added in v1.30.22

SetJobName sets the JobName field's value.

func (*StartICD10CMInferenceJobInput) SetKMSKey added in v1.30.22

SetKMSKey sets the KMSKey field's value.

func (*StartICD10CMInferenceJobInput) SetLanguageCode added in v1.30.22

SetLanguageCode sets the LanguageCode field's value.

func (*StartICD10CMInferenceJobInput) SetOutputDataConfig added in v1.30.22

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartICD10CMInferenceJobInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartICD10CMInferenceJobInput) Validate added in v1.30.22

func (s *StartICD10CMInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartICD10CMInferenceJobOutput added in v1.30.22

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartICD10CMInferenceJobOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartICD10CMInferenceJobOutput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (StartICD10CMInferenceJobOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartPHIDetectionJobInput added in v1.24.5

type StartPHIDetectionJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"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 `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartPHIDetectionJobInput) GoString added in v1.24.5

func (s StartPHIDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartPHIDetectionJobInput) SetClientRequestToken added in v1.24.5

func (s *StartPHIDetectionJobInput) SetClientRequestToken(v string) *StartPHIDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartPHIDetectionJobInput) SetDataAccessRoleArn added in v1.24.5

func (s *StartPHIDetectionJobInput) SetDataAccessRoleArn(v string) *StartPHIDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartPHIDetectionJobInput) SetInputDataConfig added in v1.24.5

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartPHIDetectionJobInput) SetJobName added in v1.24.5

SetJobName sets the JobName field's value.

func (*StartPHIDetectionJobInput) SetKMSKey added in v1.24.5

SetKMSKey sets the KMSKey field's value.

func (*StartPHIDetectionJobInput) SetLanguageCode added in v1.24.5

SetLanguageCode sets the LanguageCode field's value.

func (*StartPHIDetectionJobInput) SetOutputDataConfig added in v1.24.5

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartPHIDetectionJobInput) String added in v1.24.5

func (s StartPHIDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartPHIDetectionJobInput) Validate added in v1.24.5

func (s *StartPHIDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartPHIDetectionJobOutput added in v1.24.5

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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartPHIDetectionJobOutput) GoString added in v1.24.5

func (s StartPHIDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartPHIDetectionJobOutput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (StartPHIDetectionJobOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartRxNormInferenceJobInput added in v1.30.22

type StartRxNormInferenceJobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// 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 is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"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 `min:"1" type:"string"`

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartRxNormInferenceJobInput) GoString added in v1.30.22

func (s StartRxNormInferenceJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRxNormInferenceJobInput) SetClientRequestToken added in v1.30.22

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartRxNormInferenceJobInput) SetDataAccessRoleArn added in v1.30.22

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartRxNormInferenceJobInput) SetInputDataConfig added in v1.30.22

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartRxNormInferenceJobInput) SetJobName added in v1.30.22

SetJobName sets the JobName field's value.

func (*StartRxNormInferenceJobInput) SetKMSKey added in v1.30.22

SetKMSKey sets the KMSKey field's value.

func (*StartRxNormInferenceJobInput) SetLanguageCode added in v1.30.22

SetLanguageCode sets the LanguageCode field's value.

func (*StartRxNormInferenceJobInput) SetOutputDataConfig added in v1.30.22

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartRxNormInferenceJobInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRxNormInferenceJobInput) Validate added in v1.30.22

func (s *StartRxNormInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartRxNormInferenceJobOutput added in v1.30.22

type StartRxNormInferenceJobOutput struct {

	// The identifier of the job.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartRxNormInferenceJobOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRxNormInferenceJobOutput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (StartRxNormInferenceJobOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopEntitiesDetectionV2JobInput added in v1.24.5

type StopEntitiesDetectionV2JobInput struct {

	// The identifier of the medical entities job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionV2JobInput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopEntitiesDetectionV2JobInput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionV2JobInput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopEntitiesDetectionV2JobInput) Validate added in v1.24.5

func (s *StopEntitiesDetectionV2JobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopEntitiesDetectionV2JobOutput added in v1.24.5

type StopEntitiesDetectionV2JobOutput struct {

	// The identifier of the medical entities detection job that was stopped.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopEntitiesDetectionV2JobOutput) GoString added in v1.24.5

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopEntitiesDetectionV2JobOutput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionV2JobOutput) String added in v1.24.5

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopICD10CMInferenceJobInput added in v1.30.22

type StopICD10CMInferenceJobInput struct {

	// The identifier of the job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopICD10CMInferenceJobInput) GoString added in v1.30.22

func (s StopICD10CMInferenceJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopICD10CMInferenceJobInput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (StopICD10CMInferenceJobInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopICD10CMInferenceJobInput) Validate added in v1.30.22

func (s *StopICD10CMInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopICD10CMInferenceJobOutput added in v1.30.22

type StopICD10CMInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeICD10CMInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopICD10CMInferenceJobOutput) GoString added in v1.30.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopICD10CMInferenceJobOutput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (StopICD10CMInferenceJobOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopPHIDetectionJobInput added in v1.24.5

type StopPHIDetectionJobInput struct {

	// The identifier of the PHI detection job to stop.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopPHIDetectionJobInput) GoString added in v1.24.5

func (s StopPHIDetectionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopPHIDetectionJobInput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (StopPHIDetectionJobInput) String added in v1.24.5

func (s StopPHIDetectionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopPHIDetectionJobInput) Validate added in v1.24.5

func (s *StopPHIDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopPHIDetectionJobOutput added in v1.24.5

type StopPHIDetectionJobOutput struct {

	// The identifier of the PHI detection job that was stopped.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopPHIDetectionJobOutput) GoString added in v1.24.5

func (s StopPHIDetectionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopPHIDetectionJobOutput) SetJobId added in v1.24.5

SetJobId sets the JobId field's value.

func (StopPHIDetectionJobOutput) String added in v1.24.5

func (s StopPHIDetectionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopRxNormInferenceJobInput added in v1.30.22

type StopRxNormInferenceJobInput struct {

	// The identifier of the job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopRxNormInferenceJobInput) GoString added in v1.30.22

func (s StopRxNormInferenceJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRxNormInferenceJobInput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (StopRxNormInferenceJobInput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRxNormInferenceJobInput) Validate added in v1.30.22

func (s *StopRxNormInferenceJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopRxNormInferenceJobOutput added in v1.30.22

type StopRxNormInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeRxNormInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopRxNormInferenceJobOutput) GoString added in v1.30.22

func (s StopRxNormInferenceJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRxNormInferenceJobOutput) SetJobId added in v1.30.22

SetJobId sets the JobId field's value.

func (StopRxNormInferenceJobOutput) String added in v1.30.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TextSizeLimitExceededException added in v1.28.0

type TextSizeLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

func (*TextSizeLimitExceededException) Code added in v1.28.0

Code returns the exception type name.

func (*TextSizeLimitExceededException) Error added in v1.28.0

func (TextSizeLimitExceededException) GoString added in v1.28.0

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TextSizeLimitExceededException) Message added in v1.28.0

Message returns the exception's message.

func (*TextSizeLimitExceededException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TextSizeLimitExceededException) RequestID added in v1.28.0

func (s *TextSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TextSizeLimitExceededException) StatusCode added in v1.28.0

func (s *TextSizeLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TextSizeLimitExceededException) String added in v1.28.0

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyRequestsException added in v1.28.0

type TooManyRequestsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.

func (*TooManyRequestsException) Code added in v1.28.0

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error added in v1.28.0

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString added in v1.28.0

func (s TooManyRequestsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyRequestsException) Message added in v1.28.0

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr added in v1.28.0

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID added in v1.28.0

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode added in v1.28.0

func (s *TooManyRequestsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyRequestsException) String added in v1.28.0

func (s TooManyRequestsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Trait

type Trait struct {

	// Provides a name or contextual description about the trait.
	Name *string `type:"string" enum:"AttributeName"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of this trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Provides contextual information about the extracted entity.

func (Trait) GoString

func (s Trait) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Trait) SetName

func (s *Trait) SetName(v string) *Trait

SetName sets the Name field's value.

func (*Trait) SetScore

func (s *Trait) SetScore(v float64) *Trait

SetScore sets the Score field's value.

func (Trait) String

func (s Trait) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnmappedAttribute

type UnmappedAttribute struct {

	// The specific attribute that has been extracted but not mapped to an entity.
	Attribute *Attribute `type:"structure"`

	// The type of the attribute, could be one of the following values: "MEDICATION",
	// "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
	Type *string `type:"string" enum:"EntityType"`
	// contains filtered or unexported fields
}

An attribute that we extracted, but were unable to relate to an entity.

func (UnmappedAttribute) GoString

func (s UnmappedAttribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnmappedAttribute) SetAttribute

func (s *UnmappedAttribute) SetAttribute(v *Attribute) *UnmappedAttribute

SetAttribute sets the Attribute field's value.

func (*UnmappedAttribute) SetType

SetType sets the Type field's value.

func (UnmappedAttribute) String

func (s UnmappedAttribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException added in v1.28.0

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.

func (*ValidationException) Code added in v1.28.0

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.28.0

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.28.0

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.28.0

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.28.0

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.28.0

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.28.0

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.28.0

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package comprehendmedicaliface provides an interface to enable mocking the AWS Comprehend Medical service client for testing your code.
Package comprehendmedicaliface provides an interface to enable mocking the AWS Comprehend Medical service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL