comprehendmedical

package
v1.42.9 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

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. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see Guidelines and quotas (https://docs.aws.amazon.com/comprehend-medical/latest/dev/comprehendmedical-quotas.html) in the Amazon Comprehend Medical Developer Guide.

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"

	// AttributeNamePertainsToFamily is a AttributeName enum value
	AttributeNamePertainsToFamily = "PERTAINS_TO_FAMILY"

	// AttributeNameHypothetical is a AttributeName enum value
	AttributeNameHypothetical = "HYPOTHETICAL"

	// AttributeNameLowConfidence is a AttributeName enum value
	AttributeNameLowConfidence = "LOW_CONFIDENCE"

	// AttributeNamePastHistory is a AttributeName enum value
	AttributeNamePastHistory = "PAST_HISTORY"

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

	// EntitySubTypeDxName is a EntitySubType enum value
	EntitySubTypeDxName = "DX_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"

	// EntitySubTypeTestUnit is a EntitySubType enum value
	EntitySubTypeTestUnit = "TEST_UNIT"

	// 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"

	// EntitySubTypePhoneOrFax is a EntitySubType enum value
	EntitySubTypePhoneOrFax = "PHONE_OR_FAX"

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

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

	// EntitySubTypeId is a EntitySubType enum value
	EntitySubTypeId = "ID"

	// 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"

	// EntitySubTypeAmount is a EntitySubType enum value
	EntitySubTypeAmount = "AMOUNT"

	// EntitySubTypeGender is a EntitySubType enum value
	EntitySubTypeGender = "GENDER"

	// EntitySubTypeRaceEthnicity is a EntitySubType enum value
	EntitySubTypeRaceEthnicity = "RACE_ETHNICITY"

	// EntitySubTypeAllergies is a EntitySubType enum value
	EntitySubTypeAllergies = "ALLERGIES"

	// EntitySubTypeTobaccoUse is a EntitySubType enum value
	EntitySubTypeTobaccoUse = "TOBACCO_USE"

	// EntitySubTypeAlcoholConsumption is a EntitySubType enum value
	EntitySubTypeAlcoholConsumption = "ALCOHOL_CONSUMPTION"

	// EntitySubTypeRecDrugUse is a EntitySubType enum value
	EntitySubTypeRecDrugUse = "REC_DRUG_USE"
)
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"

	// EntityTypeBehavioralEnvironmentalSocial is a EntityType enum value
	EntityTypeBehavioralEnvironmentalSocial = "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
)
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"

	// ICD10CMRelationshipTypeQuality is a ICD10CMRelationshipType enum value
	ICD10CMRelationshipTypeQuality = "QUALITY"
)
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"

	// ICD10CMTraitNamePertainsToFamily is a ICD10CMTraitName enum value
	ICD10CMTraitNamePertainsToFamily = "PERTAINS_TO_FAMILY"

	// ICD10CMTraitNameHypothetical is a ICD10CMTraitName enum value
	ICD10CMTraitNameHypothetical = "HYPOTHETICAL"

	// ICD10CMTraitNameLowConfidence is a ICD10CMTraitName enum value
	ICD10CMTraitNameLowConfidence = "LOW_CONFIDENCE"
)
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"

	// RelationshipTypeTestUnit is a RelationshipType enum value
	RelationshipTypeTestUnit = "TEST_UNIT"

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

	// RelationshipTypeSystemOrganSite is a RelationshipType enum value
	RelationshipTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"

	// RelationshipTypeAmount is a RelationshipType enum value
	RelationshipTypeAmount = "AMOUNT"

	// RelationshipTypeUsage is a RelationshipType enum value
	RelationshipTypeUsage = "USAGE"

	// RelationshipTypeQuality is a RelationshipType enum value
	RelationshipTypeQuality = "QUALITY"
)
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 (
	// RxNormTraitNameNegation is a RxNormTraitName enum value
	RxNormTraitNameNegation = "NEGATION"

	// RxNormTraitNamePastHistory is a RxNormTraitName enum value
	RxNormTraitNamePastHistory = "PAST_HISTORY"
)
View Source
const (
	// SNOMEDCTAttributeTypeAcuity is a SNOMEDCTAttributeType enum value
	SNOMEDCTAttributeTypeAcuity = "ACUITY"

	// SNOMEDCTAttributeTypeQuality is a SNOMEDCTAttributeType enum value
	SNOMEDCTAttributeTypeQuality = "QUALITY"

	// SNOMEDCTAttributeTypeDirection is a SNOMEDCTAttributeType enum value
	SNOMEDCTAttributeTypeDirection = "DIRECTION"

	// SNOMEDCTAttributeTypeSystemOrganSite is a SNOMEDCTAttributeType enum value
	SNOMEDCTAttributeTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"

	// SNOMEDCTAttributeTypeTestValue is a SNOMEDCTAttributeType enum value
	SNOMEDCTAttributeTypeTestValue = "TEST_VALUE"

	// SNOMEDCTAttributeTypeTestUnit is a SNOMEDCTAttributeType enum value
	SNOMEDCTAttributeTypeTestUnit = "TEST_UNIT"
)
View Source
const (
	// SNOMEDCTEntityCategoryMedicalCondition is a SNOMEDCTEntityCategory enum value
	SNOMEDCTEntityCategoryMedicalCondition = "MEDICAL_CONDITION"

	// SNOMEDCTEntityCategoryAnatomy is a SNOMEDCTEntityCategory enum value
	SNOMEDCTEntityCategoryAnatomy = "ANATOMY"

	// SNOMEDCTEntityCategoryTestTreatmentProcedure is a SNOMEDCTEntityCategory enum value
	SNOMEDCTEntityCategoryTestTreatmentProcedure = "TEST_TREATMENT_PROCEDURE"
)
View Source
const (
	// SNOMEDCTEntityTypeDxName is a SNOMEDCTEntityType enum value
	SNOMEDCTEntityTypeDxName = "DX_NAME"

	// SNOMEDCTEntityTypeTestName is a SNOMEDCTEntityType enum value
	SNOMEDCTEntityTypeTestName = "TEST_NAME"

	// SNOMEDCTEntityTypeProcedureName is a SNOMEDCTEntityType enum value
	SNOMEDCTEntityTypeProcedureName = "PROCEDURE_NAME"

	// SNOMEDCTEntityTypeTreatmentName is a SNOMEDCTEntityType enum value
	SNOMEDCTEntityTypeTreatmentName = "TREATMENT_NAME"
)
View Source
const (
	// SNOMEDCTRelationshipTypeAcuity is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeAcuity = "ACUITY"

	// SNOMEDCTRelationshipTypeQuality is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeQuality = "QUALITY"

	// SNOMEDCTRelationshipTypeTestValue is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeTestValue = "TEST_VALUE"

	// SNOMEDCTRelationshipTypeTestUnits is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeTestUnits = "TEST_UNITS"

	// SNOMEDCTRelationshipTypeDirection is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeDirection = "DIRECTION"

	// SNOMEDCTRelationshipTypeSystemOrganSite is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeSystemOrganSite = "SYSTEM_ORGAN_SITE"

	// SNOMEDCTRelationshipTypeTestUnit is a SNOMEDCTRelationshipType enum value
	SNOMEDCTRelationshipTypeTestUnit = "TEST_UNIT"
)
View Source
const (
	// SNOMEDCTTraitNameNegation is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameNegation = "NEGATION"

	// SNOMEDCTTraitNameDiagnosis is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameDiagnosis = "DIAGNOSIS"

	// SNOMEDCTTraitNameSign is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameSign = "SIGN"

	// SNOMEDCTTraitNameSymptom is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameSymptom = "SYMPTOM"

	// SNOMEDCTTraitNamePertainsToFamily is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNamePertainsToFamily = "PERTAINS_TO_FAMILY"

	// SNOMEDCTTraitNameHypothetical is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameHypothetical = "HYPOTHETICAL"

	// SNOMEDCTTraitNameLowConfidence is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameLowConfidence = "LOW_CONFIDENCE"

	// SNOMEDCTTraitNamePastHistory is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNamePastHistory = "PAST_HISTORY"

	// SNOMEDCTTraitNameFuture is a SNOMEDCTTraitName enum value
	SNOMEDCTTraitNameFuture = "FUTURE"
)
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"
)

Variables

This section is empty.

Functions

func AttributeName_Values

func AttributeName_Values() []string

AttributeName_Values returns all elements of the AttributeName enum

func EntitySubType_Values

func EntitySubType_Values() []string

EntitySubType_Values returns all elements of the EntitySubType enum

func EntityType_Values

func EntityType_Values() []string

EntityType_Values returns all elements of the EntityType enum

func ICD10CMAttributeType_Values

func ICD10CMAttributeType_Values() []string

ICD10CMAttributeType_Values returns all elements of the ICD10CMAttributeType enum

func ICD10CMEntityCategory_Values

func ICD10CMEntityCategory_Values() []string

ICD10CMEntityCategory_Values returns all elements of the ICD10CMEntityCategory enum

func ICD10CMEntityType_Values

func ICD10CMEntityType_Values() []string

ICD10CMEntityType_Values returns all elements of the ICD10CMEntityType enum

func ICD10CMRelationshipType_Values

func ICD10CMRelationshipType_Values() []string

ICD10CMRelationshipType_Values returns all elements of the ICD10CMRelationshipType enum

func ICD10CMTraitName_Values

func ICD10CMTraitName_Values() []string

ICD10CMTraitName_Values returns all elements of the ICD10CMTraitName enum

func JobStatus_Values

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func LanguageCode_Values

func LanguageCode_Values() []string

LanguageCode_Values returns all elements of the LanguageCode enum

func RelationshipType_Values

func RelationshipType_Values() []string

RelationshipType_Values returns all elements of the RelationshipType enum

func RxNormAttributeType_Values

func RxNormAttributeType_Values() []string

RxNormAttributeType_Values returns all elements of the RxNormAttributeType enum

func RxNormEntityCategory_Values

func RxNormEntityCategory_Values() []string

RxNormEntityCategory_Values returns all elements of the RxNormEntityCategory enum

func RxNormEntityType_Values

func RxNormEntityType_Values() []string

RxNormEntityType_Values returns all elements of the RxNormEntityType enum

func RxNormTraitName_Values

func RxNormTraitName_Values() []string

RxNormTraitName_Values returns all elements of the RxNormTraitName enum

func SNOMEDCTAttributeType_Values added in v1.42.9

func SNOMEDCTAttributeType_Values() []string

SNOMEDCTAttributeType_Values returns all elements of the SNOMEDCTAttributeType enum

func SNOMEDCTEntityCategory_Values added in v1.42.9

func SNOMEDCTEntityCategory_Values() []string

SNOMEDCTEntityCategory_Values returns all elements of the SNOMEDCTEntityCategory enum

func SNOMEDCTEntityType_Values added in v1.42.9

func SNOMEDCTEntityType_Values() []string

SNOMEDCTEntityType_Values returns all elements of the SNOMEDCTEntityType enum

func SNOMEDCTRelationshipType_Values added in v1.42.9

func SNOMEDCTRelationshipType_Values() []string

SNOMEDCTRelationshipType_Values returns all elements of the SNOMEDCTRelationshipType enum

func SNOMEDCTTraitName_Values added in v1.42.9

func SNOMEDCTTraitName_Values() []string

SNOMEDCTTraitName_Values returns all elements of the SNOMEDCTTraitName 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

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

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 Characters added in v1.42.9

type Characters struct {

	// The number of characters present in the input text document as processed
	// by Amazon Comprehend Medical.
	OriginalTextCharacters *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The number of characters in the input text to be analyzed.

func (Characters) GoString added in v1.42.9

func (s Characters) 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 (*Characters) SetOriginalTextCharacters added in v1.42.9

func (s *Characters) SetOriginalTextCharacters(v int64) *Characters

SetOriginalTextCharacters sets the OriginalTextCharacters field's value.

func (Characters) String added in v1.42.9

func (s Characters) 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

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

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

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

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

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

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

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

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

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

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

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

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) DescribeSNOMEDCTInferenceJob added in v1.42.9

DescribeSNOMEDCTInferenceJob API operation for AWS Comprehend Medical.

Gets the properties associated with an InferSNOMEDCT 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 DescribeSNOMEDCTInferenceJob 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/DescribeSNOMEDCTInferenceJob

func (*ComprehendMedical) DescribeSNOMEDCTInferenceJobRequest added in v1.42.9

func (c *ComprehendMedical) DescribeSNOMEDCTInferenceJobRequest(input *DescribeSNOMEDCTInferenceJobInput) (req *request.Request, output *DescribeSNOMEDCTInferenceJobOutput)

DescribeSNOMEDCTInferenceJobRequest generates a "aws/request.Request" representing the client's request for the DescribeSNOMEDCTInferenceJob 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 DescribeSNOMEDCTInferenceJob for more information on using the DescribeSNOMEDCTInferenceJob 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 DescribeSNOMEDCTInferenceJobRequest method.
req, resp := client.DescribeSNOMEDCTInferenceJobRequest(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/DescribeSNOMEDCTInferenceJob

func (*ComprehendMedical) DescribeSNOMEDCTInferenceJobWithContext added in v1.42.9

func (c *ComprehendMedical) DescribeSNOMEDCTInferenceJobWithContext(ctx aws.Context, input *DescribeSNOMEDCTInferenceJobInput, opts ...request.Option) (*DescribeSNOMEDCTInferenceJobOutput, error)

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

See DescribeSNOMEDCTInferenceJob 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

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

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

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

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

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

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

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

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

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

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

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

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) InferSNOMEDCT added in v1.42.9

func (c *ComprehendMedical) InferSNOMEDCT(input *InferSNOMEDCTInput) (*InferSNOMEDCTOutput, error)

InferSNOMEDCT API operation for AWS Comprehend Medical.

InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

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 InferSNOMEDCT 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/InferSNOMEDCT

func (*ComprehendMedical) InferSNOMEDCTRequest added in v1.42.9

func (c *ComprehendMedical) InferSNOMEDCTRequest(input *InferSNOMEDCTInput) (req *request.Request, output *InferSNOMEDCTOutput)

InferSNOMEDCTRequest generates a "aws/request.Request" representing the client's request for the InferSNOMEDCT 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 InferSNOMEDCT for more information on using the InferSNOMEDCT 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 InferSNOMEDCTRequest method.
req, resp := client.InferSNOMEDCTRequest(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/InferSNOMEDCT

func (*ComprehendMedical) InferSNOMEDCTWithContext added in v1.42.9

func (c *ComprehendMedical) InferSNOMEDCTWithContext(ctx aws.Context, input *InferSNOMEDCTInput, opts ...request.Option) (*InferSNOMEDCTOutput, error)

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

See InferSNOMEDCT 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

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

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

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

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

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

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

ListPHIDetectionJobs API operation for AWS Comprehend Medical.

Gets a list of protected health information (PHI) detection jobs 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

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

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

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

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

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) ListSNOMEDCTInferenceJobs added in v1.42.9

ListSNOMEDCTInferenceJobs API operation for AWS Comprehend Medical.

Gets a list of InferSNOMEDCT jobs a user has 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 ListSNOMEDCTInferenceJobs 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/ListSNOMEDCTInferenceJobs

func (*ComprehendMedical) ListSNOMEDCTInferenceJobsRequest added in v1.42.9

func (c *ComprehendMedical) ListSNOMEDCTInferenceJobsRequest(input *ListSNOMEDCTInferenceJobsInput) (req *request.Request, output *ListSNOMEDCTInferenceJobsOutput)

ListSNOMEDCTInferenceJobsRequest generates a "aws/request.Request" representing the client's request for the ListSNOMEDCTInferenceJobs 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 ListSNOMEDCTInferenceJobs for more information on using the ListSNOMEDCTInferenceJobs 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 ListSNOMEDCTInferenceJobsRequest method.
req, resp := client.ListSNOMEDCTInferenceJobsRequest(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/ListSNOMEDCTInferenceJobs

func (*ComprehendMedical) ListSNOMEDCTInferenceJobsWithContext added in v1.42.9

func (c *ComprehendMedical) ListSNOMEDCTInferenceJobsWithContext(ctx aws.Context, input *ListSNOMEDCTInferenceJobsInput, opts ...request.Option) (*ListSNOMEDCTInferenceJobsOutput, error)

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

See ListSNOMEDCTInferenceJobs 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

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

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

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

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

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

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

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

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

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

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

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

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) StartSNOMEDCTInferenceJob added in v1.42.9

StartSNOMEDCTInferenceJob API operation for AWS Comprehend Medical.

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

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 StartSNOMEDCTInferenceJob 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/StartSNOMEDCTInferenceJob

func (*ComprehendMedical) StartSNOMEDCTInferenceJobRequest added in v1.42.9

func (c *ComprehendMedical) StartSNOMEDCTInferenceJobRequest(input *StartSNOMEDCTInferenceJobInput) (req *request.Request, output *StartSNOMEDCTInferenceJobOutput)

StartSNOMEDCTInferenceJobRequest generates a "aws/request.Request" representing the client's request for the StartSNOMEDCTInferenceJob 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 StartSNOMEDCTInferenceJob for more information on using the StartSNOMEDCTInferenceJob 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 StartSNOMEDCTInferenceJobRequest method.
req, resp := client.StartSNOMEDCTInferenceJobRequest(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/StartSNOMEDCTInferenceJob

func (*ComprehendMedical) StartSNOMEDCTInferenceJobWithContext added in v1.42.9

func (c *ComprehendMedical) StartSNOMEDCTInferenceJobWithContext(ctx aws.Context, input *StartSNOMEDCTInferenceJobInput, opts ...request.Option) (*StartSNOMEDCTInferenceJobOutput, error)

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

See StartSNOMEDCTInferenceJob 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

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

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

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

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

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

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

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

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

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

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

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

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.

func (*ComprehendMedical) StopSNOMEDCTInferenceJob added in v1.42.9

StopSNOMEDCTInferenceJob API operation for AWS Comprehend Medical.

Stops an InferSNOMEDCT 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 StopSNOMEDCTInferenceJob 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.

  • 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/StopSNOMEDCTInferenceJob

func (*ComprehendMedical) StopSNOMEDCTInferenceJobRequest added in v1.42.9

func (c *ComprehendMedical) StopSNOMEDCTInferenceJobRequest(input *StopSNOMEDCTInferenceJobInput) (req *request.Request, output *StopSNOMEDCTInferenceJobOutput)

StopSNOMEDCTInferenceJobRequest generates a "aws/request.Request" representing the client's request for the StopSNOMEDCTInferenceJob 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 StopSNOMEDCTInferenceJob for more information on using the StopSNOMEDCTInferenceJob 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 StopSNOMEDCTInferenceJobRequest method.
req, resp := client.StopSNOMEDCTInferenceJobRequest(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/StopSNOMEDCTInferenceJob

func (*ComprehendMedical) StopSNOMEDCTInferenceJobWithContext added in v1.42.9

func (c *ComprehendMedical) StopSNOMEDCTInferenceJobWithContext(ctx aws.Context, input *StopSNOMEDCTInferenceJobInput, opts ...request.Option) (*StopSNOMEDCTInferenceJobOutput, error)

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

See StopSNOMEDCTInferenceJob 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

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

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

SetJobName sets the JobName field's value.

func (*ComprehendMedicalAsyncJobFilter) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (*ComprehendMedicalAsyncJobFilter) SetSubmitTimeAfter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*ComprehendMedicalAsyncJobFilter) SetSubmitTimeBefore

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (ComprehendMedicalAsyncJobFilter) 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 (*ComprehendMedicalAsyncJobFilter) Validate

func (s *ComprehendMedicalAsyncJobFilter) Validate() error

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

type ComprehendMedicalAsyncJobProperties

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

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*ComprehendMedicalAsyncJobProperties) SetEndTime

SetEndTime sets the EndTime field's value.

func (*ComprehendMedicalAsyncJobProperties) SetExpirationTime

SetExpirationTime sets the ExpirationTime field's value.

func (*ComprehendMedicalAsyncJobProperties) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobId

SetJobId sets the JobId field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobName

SetJobName sets the JobName field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobStatus

SetJobStatus sets the JobStatus field's value.

func (*ComprehendMedicalAsyncJobProperties) SetKMSKey

SetKMSKey sets the KMSKey field's value.

func (*ComprehendMedicalAsyncJobProperties) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*ComprehendMedicalAsyncJobProperties) SetManifestFilePath

SetManifestFilePath sets the ManifestFilePath field's value.

func (*ComprehendMedicalAsyncJobProperties) SetMessage

SetMessage sets the Message field's value.

func (*ComprehendMedicalAsyncJobProperties) SetModelVersion

SetModelVersion sets the ModelVersion field's value.

func (*ComprehendMedicalAsyncJobProperties) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*ComprehendMedicalAsyncJobProperties) SetSubmitTime

SetSubmitTime sets the SubmitTime field's value.

func (ComprehendMedicalAsyncJobProperties) 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 DescribeEntitiesDetectionV2JobInput

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

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

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionV2JobInput) 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 (*DescribeEntitiesDetectionV2JobInput) Validate

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

type DescribeEntitiesDetectionV2JobOutput

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

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

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeEntitiesDetectionV2JobOutput) 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 DescribeICD10CMInferenceJobInput

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

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

SetJobId sets the JobId field's value.

func (DescribeICD10CMInferenceJobInput) 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 (*DescribeICD10CMInferenceJobInput) Validate

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

type DescribeICD10CMInferenceJobOutput

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

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

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeICD10CMInferenceJobOutput) 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 DescribePHIDetectionJobInput

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

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

SetJobId sets the JobId field's value.

func (DescribePHIDetectionJobInput) 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 (*DescribePHIDetectionJobInput) Validate

func (s *DescribePHIDetectionJobInput) Validate() error

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

type DescribePHIDetectionJobOutput

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

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

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribePHIDetectionJobOutput) 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 DescribeRxNormInferenceJobInput

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

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

SetJobId sets the JobId field's value.

func (DescribeRxNormInferenceJobInput) 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 (*DescribeRxNormInferenceJobInput) Validate

func (s *DescribeRxNormInferenceJobInput) Validate() error

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

type DescribeRxNormInferenceJobOutput

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

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

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeRxNormInferenceJobOutput) 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 DescribeSNOMEDCTInferenceJobInput added in v1.42.9

type DescribeSNOMEDCTInferenceJobInput struct {

	// The identifier that Amazon Comprehend Medical generated for the job. The
	// StartSNOMEDCTInferenceJob 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 (DescribeSNOMEDCTInferenceJobInput) GoString added in v1.42.9

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 (*DescribeSNOMEDCTInferenceJobInput) SetJobId added in v1.42.9

SetJobId sets the JobId field's value.

func (DescribeSNOMEDCTInferenceJobInput) String added in v1.42.9

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 (*DescribeSNOMEDCTInferenceJobInput) Validate added in v1.42.9

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

type DescribeSNOMEDCTInferenceJobOutput added in v1.42.9

type DescribeSNOMEDCTInferenceJobOutput struct {

	// Provides information about a detection job.
	ComprehendMedicalAsyncJobProperties *ComprehendMedicalAsyncJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeSNOMEDCTInferenceJobOutput) GoString added in v1.42.9

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 (*DescribeSNOMEDCTInferenceJobOutput) SetComprehendMedicalAsyncJobProperties added in v1.42.9

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeSNOMEDCTInferenceJobOutput) String added in v1.42.9

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

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

type DetectEntitiesV2Input struct {

	// A UTF-8 string containing the clinical content being examined for entities.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DetectEntitiesV2Input) GoString

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

SetText sets the Text field's value.

func (DetectEntitiesV2Input) String

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

func (s *DetectEntitiesV2Input) Validate() error

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

type DetectEntitiesV2Output

type DetectEntitiesV2Output struct {

	// The collection of medical entities extracted from the input text and their
	// associated information. For each entity, the response provides the entity
	// text, the entity category, where the entity text begins and ends, and the
	// level of confidence in the detection and analysis. Attributes and traits
	// of the entity are also returned.
	//
	// 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

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

SetEntities sets the Entities field's value.

func (*DetectEntitiesV2Output) SetModelVersion

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

SetModelVersion sets the ModelVersion field's value.

func (*DetectEntitiesV2Output) SetPaginationToken

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

SetPaginationToken sets the PaginationToken field's value.

func (*DetectEntitiesV2Output) SetUnmappedAttributes

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

SetUnmappedAttributes sets the UnmappedAttributes field's value.

func (DetectEntitiesV2Output) String

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

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

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

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

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

SetBeginOffset sets the BeginOffset field's value.

func (*ICD10CMAttribute) SetCategory

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

SetCategory sets the Category field's value.

func (*ICD10CMAttribute) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*ICD10CMAttribute) SetId

SetId sets the Id field's value.

func (*ICD10CMAttribute) SetRelationshipScore

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

SetRelationshipScore sets the RelationshipScore field's value.

func (*ICD10CMAttribute) SetRelationshipType

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

SetRelationshipType sets the RelationshipType field's value.

func (*ICD10CMAttribute) SetScore

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

SetScore sets the Score field's value.

func (*ICD10CMAttribute) SetText

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

SetText sets the Text field's value.

func (*ICD10CMAttribute) SetTraits

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

SetTraits sets the Traits field's value.

func (*ICD10CMAttribute) SetType

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

SetType sets the Type field's value.

func (ICD10CMAttribute) String

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

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

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

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

SetCode sets the Code field's value.

func (*ICD10CMConcept) SetDescription

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

SetDescription sets the Description field's value.

func (*ICD10CMConcept) SetScore

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

SetScore sets the Score field's value.

func (ICD10CMConcept) String

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

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

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

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

SetAttributes sets the Attributes field's value.

func (*ICD10CMEntity) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*ICD10CMEntity) SetCategory

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

SetCategory sets the Category field's value.

func (*ICD10CMEntity) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*ICD10CMEntity) SetICD10CMConcepts

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

SetICD10CMConcepts sets the ICD10CMConcepts field's value.

func (*ICD10CMEntity) SetId

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

SetId sets the Id field's value.

func (*ICD10CMEntity) SetScore

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

SetScore sets the Score field's value.

func (*ICD10CMEntity) SetText

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

SetText sets the Text field's value.

func (*ICD10CMEntity) SetTraits

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

SetTraits sets the Traits field's value.

func (*ICD10CMEntity) SetType

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

SetType sets the Type field's value.

func (ICD10CMEntity) String

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

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

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

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

SetName sets the Name field's value.

func (*ICD10CMTrait) SetScore

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

SetScore sets the Score field's value.

func (ICD10CMTrait) String

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

type InferICD10CMInput struct {

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

func (InferICD10CMInput) GoString

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

SetText sets the Text field's value.

func (InferICD10CMInput) String

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

func (s *InferICD10CMInput) Validate() error

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

type InferICD10CMOutput

type InferICD10CMOutput struct {

	// The medical conditions detected in the text linked to ICD-10-CM concepts.
	// If the action is successful, the service sends back an HTTP 200 response,
	// as well as the entities detected.
	//
	// 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

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

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

SetEntities sets the Entities field's value.

func (*InferICD10CMOutput) SetModelVersion

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

SetModelVersion sets the ModelVersion field's value.

func (*InferICD10CMOutput) SetPaginationToken

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

SetPaginationToken sets the PaginationToken field's value.

func (InferICD10CMOutput) String

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

type InferRxNormInput struct {

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

func (InferRxNormInput) GoString

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

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

SetText sets the Text field's value.

func (InferRxNormInput) String

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

func (s *InferRxNormInput) Validate() error

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

type InferRxNormOutput

type InferRxNormOutput struct {

	// The medication entities detected in the text linked to RxNorm concepts. If
	// the action is successful, the service sends back an HTTP 200 response, as
	// well as the entities detected.
	//
	// 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

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

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

SetEntities sets the Entities field's value.

func (*InferRxNormOutput) SetModelVersion

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

SetModelVersion sets the ModelVersion field's value.

func (*InferRxNormOutput) SetPaginationToken

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

SetPaginationToken sets the PaginationToken field's value.

func (InferRxNormOutput) String

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 InferSNOMEDCTInput added in v1.42.9

type InferSNOMEDCTInput struct {

	// The input text to be analyzed using InferSNOMEDCT.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InferSNOMEDCTInput) GoString added in v1.42.9

func (s InferSNOMEDCTInput) 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 (*InferSNOMEDCTInput) SetText added in v1.42.9

SetText sets the Text field's value.

func (InferSNOMEDCTInput) String added in v1.42.9

func (s InferSNOMEDCTInput) 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 (*InferSNOMEDCTInput) Validate added in v1.42.9

func (s *InferSNOMEDCTInput) Validate() error

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

type InferSNOMEDCTOutput added in v1.42.9

type InferSNOMEDCTOutput struct {

	// The number of characters in the input request documentation.
	Characters *Characters `type:"structure"`

	// The collection of medical concept 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 []*SNOMEDCTEntity `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 request is truncated, the pagination token can be used
	// to fetch the next page of entities.
	PaginationToken *string `min:"1" type:"string"`

	// The details of the SNOMED-CT revision, including the edition, language, and
	// version date.
	SNOMEDCTDetails *SNOMEDCTDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (InferSNOMEDCTOutput) GoString added in v1.42.9

func (s InferSNOMEDCTOutput) 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 (*InferSNOMEDCTOutput) SetCharacters added in v1.42.9

func (s *InferSNOMEDCTOutput) SetCharacters(v *Characters) *InferSNOMEDCTOutput

SetCharacters sets the Characters field's value.

func (*InferSNOMEDCTOutput) SetEntities added in v1.42.9

SetEntities sets the Entities field's value.

func (*InferSNOMEDCTOutput) SetModelVersion added in v1.42.9

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

SetModelVersion sets the ModelVersion field's value.

func (*InferSNOMEDCTOutput) SetPaginationToken added in v1.42.9

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

SetPaginationToken sets the PaginationToken field's value.

func (*InferSNOMEDCTOutput) SetSNOMEDCTDetails added in v1.42.9

func (s *InferSNOMEDCTOutput) SetSNOMEDCTDetails(v *SNOMEDCTDetails) *InferSNOMEDCTOutput

SetSNOMEDCTDetails sets the SNOMEDCTDetails field's value.

func (InferSNOMEDCTOutput) String added in v1.42.9

func (s InferSNOMEDCTOutput) 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

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

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

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

SetS3Bucket sets the S3Bucket field's value.

func (*InputDataConfig) SetS3Key

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

SetS3Key sets the S3Key field's value.

func (InputDataConfig) String

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

func (s *InputDataConfig) Validate() error

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

type InternalServerException

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

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

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

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String

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

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

func (s *InvalidEncodingException) Code() string

Code returns the exception type name.

func (*InvalidEncodingException) Error

func (s *InvalidEncodingException) Error() string

func (InvalidEncodingException) GoString

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

func (s *InvalidEncodingException) Message() string

Message returns the exception's message.

func (*InvalidEncodingException) OrigErr

func (s *InvalidEncodingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEncodingException) RequestID

func (s *InvalidEncodingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEncodingException) StatusCode

func (s *InvalidEncodingException) StatusCode() int

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

func (InvalidEncodingException) String

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

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

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

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

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

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

func (InvalidRequestException) String

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

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

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

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionV2JobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionV2JobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionV2JobsInput) 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 (*ListEntitiesDetectionV2JobsInput) Validate

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

type ListEntitiesDetectionV2JobsOutput

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

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

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListEntitiesDetectionV2JobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionV2JobsOutput) 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 ListICD10CMInferenceJobsInput

type ListICD10CMInferenceJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *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

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

SetFilter sets the Filter field's value.

func (*ListICD10CMInferenceJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListICD10CMInferenceJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListICD10CMInferenceJobsInput) 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 (*ListICD10CMInferenceJobsInput) Validate

func (s *ListICD10CMInferenceJobsInput) Validate() error

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

type ListICD10CMInferenceJobsOutput

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

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

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

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListICD10CMInferenceJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListICD10CMInferenceJobsOutput) 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 ListPHIDetectionJobsInput

type ListPHIDetectionJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *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

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

SetFilter sets the Filter field's value.

func (*ListPHIDetectionJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListPHIDetectionJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListPHIDetectionJobsInput) String

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

func (s *ListPHIDetectionJobsInput) Validate() error

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

type ListPHIDetectionJobsOutput

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

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

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

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListPHIDetectionJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListPHIDetectionJobsOutput) 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 ListRxNormInferenceJobsInput

type ListRxNormInferenceJobsInput struct {

	// Filters the jobs that are returned. You can filter jobs based on their names,
	// status, or the date and time that they were submitted. You can only set one
	// filter at a time.
	Filter *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

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

SetFilter sets the Filter field's value.

func (*ListRxNormInferenceJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListRxNormInferenceJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListRxNormInferenceJobsInput) 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 (*ListRxNormInferenceJobsInput) Validate

func (s *ListRxNormInferenceJobsInput) Validate() error

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

type ListRxNormInferenceJobsOutput

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

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

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

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListRxNormInferenceJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListRxNormInferenceJobsOutput) 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 ListSNOMEDCTInferenceJobsInput added in v1.42.9

type ListSNOMEDCTInferenceJobsInput struct {

	// Provides information for filtering a list of detection jobs.
	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 InferSNOMEDCT results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListSNOMEDCTInferenceJobsInput) GoString added in v1.42.9

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 (*ListSNOMEDCTInferenceJobsInput) SetFilter added in v1.42.9

SetFilter sets the Filter field's value.

func (*ListSNOMEDCTInferenceJobsInput) SetMaxResults added in v1.42.9

SetMaxResults sets the MaxResults field's value.

func (*ListSNOMEDCTInferenceJobsInput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (ListSNOMEDCTInferenceJobsInput) String added in v1.42.9

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 (*ListSNOMEDCTInferenceJobsInput) Validate added in v1.42.9

func (s *ListSNOMEDCTInferenceJobsInput) Validate() error

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

type ListSNOMEDCTInferenceJobsOutput added in v1.42.9

type ListSNOMEDCTInferenceJobsOutput 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 (ListSNOMEDCTInferenceJobsOutput) GoString added in v1.42.9

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 (*ListSNOMEDCTInferenceJobsOutput) SetComprehendMedicalAsyncJobPropertiesList added in v1.42.9

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListSNOMEDCTInferenceJobsOutput) SetNextToken added in v1.42.9

SetNextToken sets the NextToken field's value.

func (ListSNOMEDCTInferenceJobsOutput) String added in v1.42.9

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

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

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

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

SetS3Bucket sets the S3Bucket field's value.

func (*OutputDataConfig) SetS3Key

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

SetS3Key sets the S3Key field's value.

func (OutputDataConfig) String

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

func (s *OutputDataConfig) Validate() error

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

type ResourceNotFoundException

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

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

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

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

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

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 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 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

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

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

SetBeginOffset sets the BeginOffset field's value.

func (*RxNormAttribute) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*RxNormAttribute) SetId

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

SetId sets the Id field's value.

func (*RxNormAttribute) SetRelationshipScore

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

SetRelationshipScore sets the RelationshipScore field's value.

func (*RxNormAttribute) SetScore

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

SetScore sets the Score field's value.

func (*RxNormAttribute) SetText

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

SetText sets the Text field's value.

func (*RxNormAttribute) SetTraits

func (s *RxNormAttribute) SetTraits(v []*RxNormTrait) *RxNormAttribute

SetTraits sets the Traits field's value.

func (*RxNormAttribute) SetType

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

SetType sets the Type field's value.

func (RxNormAttribute) String

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

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

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

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

SetCode sets the Code field's value.

func (*RxNormConcept) SetDescription

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

SetDescription sets the Description field's value.

func (*RxNormConcept) SetScore

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

SetScore sets the Score field's value.

func (RxNormConcept) String

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

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

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

func (s *RxNormEntity) SetAttributes(v []*RxNormAttribute) *RxNormEntity

SetAttributes sets the Attributes field's value.

func (*RxNormEntity) SetBeginOffset

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

SetBeginOffset sets the BeginOffset field's value.

func (*RxNormEntity) SetCategory

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

SetCategory sets the Category field's value.

func (*RxNormEntity) SetEndOffset

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

SetEndOffset sets the EndOffset field's value.

func (*RxNormEntity) SetId

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

SetId sets the Id field's value.

func (*RxNormEntity) SetRxNormConcepts

func (s *RxNormEntity) SetRxNormConcepts(v []*RxNormConcept) *RxNormEntity

SetRxNormConcepts sets the RxNormConcepts field's value.

func (*RxNormEntity) SetScore

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

SetScore sets the Score field's value.

func (*RxNormEntity) SetText

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

SetText sets the Text field's value.

func (*RxNormEntity) SetTraits

func (s *RxNormEntity) SetTraits(v []*RxNormTrait) *RxNormEntity

SetTraits sets the Traits field's value.

func (*RxNormEntity) SetType

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

SetType sets the Type field's value.

func (RxNormEntity) String

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

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

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

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

SetName sets the Name field's value.

func (*RxNormTrait) SetScore

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

SetScore sets the Score field's value.

func (RxNormTrait) String

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 SNOMEDCTAttribute added in v1.42.9

type SNOMEDCTAttribute 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 the detected attribute. Possible categories include MEDICAL_CONDITION,
	// ANATOMY, and TEST_TREATMENT_PROCEDURE.
	Category *string `type:"string" enum:"SNOMEDCTEntityCategory"`

	// 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 that exists between the entity and the related attribute.
	RelationshipType *string `type:"string" enum:"SNOMEDCTRelationshipType"`

	// The SNOMED-CT concepts specific to an attribute, along with a score indicating
	// the likelihood of the match.
	SNOMEDCTConcepts []*SNOMEDCTConcept `type:"list"`

	// 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 an attribute. Examples include signs, symptoms,
	// diagnosis, and negation.
	Traits []*SNOMEDCTTrait `type:"list"`

	// The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION,
	// SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
	Type *string `type:"string" enum:"SNOMEDCTAttributeType"`
	// contains filtered or unexported fields
}

The extracted attributes that relate to an entity. 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.

func (SNOMEDCTAttribute) GoString added in v1.42.9

func (s SNOMEDCTAttribute) 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 (*SNOMEDCTAttribute) SetBeginOffset added in v1.42.9

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

SetBeginOffset sets the BeginOffset field's value.

func (*SNOMEDCTAttribute) SetCategory added in v1.42.9

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

SetCategory sets the Category field's value.

func (*SNOMEDCTAttribute) SetEndOffset added in v1.42.9

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

SetEndOffset sets the EndOffset field's value.

func (*SNOMEDCTAttribute) SetId added in v1.42.9

SetId sets the Id field's value.

func (*SNOMEDCTAttribute) SetRelationshipScore added in v1.42.9

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

SetRelationshipScore sets the RelationshipScore field's value.

func (*SNOMEDCTAttribute) SetRelationshipType added in v1.42.9

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

SetRelationshipType sets the RelationshipType field's value.

func (*SNOMEDCTAttribute) SetSNOMEDCTConcepts added in v1.42.9

func (s *SNOMEDCTAttribute) SetSNOMEDCTConcepts(v []*SNOMEDCTConcept) *SNOMEDCTAttribute

SetSNOMEDCTConcepts sets the SNOMEDCTConcepts field's value.

func (*SNOMEDCTAttribute) SetScore added in v1.42.9

SetScore sets the Score field's value.

func (*SNOMEDCTAttribute) SetText added in v1.42.9

SetText sets the Text field's value.

func (*SNOMEDCTAttribute) SetTraits added in v1.42.9

SetTraits sets the Traits field's value.

func (*SNOMEDCTAttribute) SetType added in v1.42.9

SetType sets the Type field's value.

func (SNOMEDCTAttribute) String added in v1.42.9

func (s SNOMEDCTAttribute) 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 SNOMEDCTConcept added in v1.42.9

type SNOMEDCTConcept struct {

	// The numeric ID for the SNOMED-CT concept.
	Code *string `min:"1" type:"string"`

	// The description of the SNOMED-CT concept.
	Description *string `min:"1" type:"string"`

	// The level of confidence Amazon Comprehend Medical has that the entity should
	// be linked to the identified SNOMED-CT concept.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.

func (SNOMEDCTConcept) GoString added in v1.42.9

func (s SNOMEDCTConcept) 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 (*SNOMEDCTConcept) SetCode added in v1.42.9

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

SetCode sets the Code field's value.

func (*SNOMEDCTConcept) SetDescription added in v1.42.9

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

SetDescription sets the Description field's value.

func (*SNOMEDCTConcept) SetScore added in v1.42.9

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

SetScore sets the Score field's value.

func (SNOMEDCTConcept) String added in v1.42.9

func (s SNOMEDCTConcept) 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 SNOMEDCTDetails added in v1.42.9

type SNOMEDCTDetails struct {

	// The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions
	// is the US edition.
	Edition *string `min:"1" type:"string"`

	// The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical
	// operations are US English (en).
	Language *string `min:"1" type:"string"`

	// The version date of the SNOMED-CT ontology used.
	VersionDate *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The information about the revision of the SNOMED-CT ontology in the response. Specifically, the details include the SNOMED-CT edition, language, and version date.

func (SNOMEDCTDetails) GoString added in v1.42.9

func (s SNOMEDCTDetails) 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 (*SNOMEDCTDetails) SetEdition added in v1.42.9

func (s *SNOMEDCTDetails) SetEdition(v string) *SNOMEDCTDetails

SetEdition sets the Edition field's value.

func (*SNOMEDCTDetails) SetLanguage added in v1.42.9

func (s *SNOMEDCTDetails) SetLanguage(v string) *SNOMEDCTDetails

SetLanguage sets the Language field's value.

func (*SNOMEDCTDetails) SetVersionDate added in v1.42.9

func (s *SNOMEDCTDetails) SetVersionDate(v string) *SNOMEDCTDetails

SetVersionDate sets the VersionDate field's value.

func (SNOMEDCTDetails) String added in v1.42.9

func (s SNOMEDCTDetails) 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 SNOMEDCTEntity added in v1.42.9

type SNOMEDCTEntity struct {

	// 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.
	Attributes []*SNOMEDCTAttribute `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 detected entity. Possible categories are MEDICAL_CONDITION,
	// ANATOMY, or TEST_TREATMENT_PROCEDURE.
	Category *string `type:"string" enum:"SNOMEDCTEntityCategory"`

	// 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 SNOMED concepts that the entity could refer to, along with a score indicating
	// the likelihood of the match.
	SNOMEDCTConcepts []*SNOMEDCTConcept `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 as this entity.
	Text *string `min:"1" type:"string"`

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

	// Describes the specific type of entity with category of entities. Possible
	// types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE,
	// TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
	Type *string `type:"string" enum:"SNOMEDCTEntityType"`
	// 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 (SNOMEDCTEntity) GoString added in v1.42.9

func (s SNOMEDCTEntity) 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 (*SNOMEDCTEntity) SetAttributes added in v1.42.9

func (s *SNOMEDCTEntity) SetAttributes(v []*SNOMEDCTAttribute) *SNOMEDCTEntity

SetAttributes sets the Attributes field's value.

func (*SNOMEDCTEntity) SetBeginOffset added in v1.42.9

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

SetBeginOffset sets the BeginOffset field's value.

func (*SNOMEDCTEntity) SetCategory added in v1.42.9

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

SetCategory sets the Category field's value.

func (*SNOMEDCTEntity) SetEndOffset added in v1.42.9

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

SetEndOffset sets the EndOffset field's value.

func (*SNOMEDCTEntity) SetId added in v1.42.9

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

SetId sets the Id field's value.

func (*SNOMEDCTEntity) SetSNOMEDCTConcepts added in v1.42.9

func (s *SNOMEDCTEntity) SetSNOMEDCTConcepts(v []*SNOMEDCTConcept) *SNOMEDCTEntity

SetSNOMEDCTConcepts sets the SNOMEDCTConcepts field's value.

func (*SNOMEDCTEntity) SetScore added in v1.42.9

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

SetScore sets the Score field's value.

func (*SNOMEDCTEntity) SetText added in v1.42.9

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

SetText sets the Text field's value.

func (*SNOMEDCTEntity) SetTraits added in v1.42.9

func (s *SNOMEDCTEntity) SetTraits(v []*SNOMEDCTTrait) *SNOMEDCTEntity

SetTraits sets the Traits field's value.

func (*SNOMEDCTEntity) SetType added in v1.42.9

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

SetType sets the Type field's value.

func (SNOMEDCTEntity) String added in v1.42.9

func (s SNOMEDCTEntity) 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 SNOMEDCTTrait added in v1.42.9

type SNOMEDCTTrait struct {

	// The name or contextual description of a detected trait.
	Name *string `type:"string" enum:"SNOMEDCTTraitName"`

	// The level of confidence that Amazon Comprehend Medical has in the accuracy
	// of a detected trait.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Contextual information for an entity.

func (SNOMEDCTTrait) GoString added in v1.42.9

func (s SNOMEDCTTrait) 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 (*SNOMEDCTTrait) SetName added in v1.42.9

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

SetName sets the Name field's value.

func (*SNOMEDCTTrait) SetScore added in v1.42.9

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

SetScore sets the Score field's value.

func (SNOMEDCTTrait) String added in v1.42.9

func (s SNOMEDCTTrait) 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

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

Code returns the exception type name.

func (*ServiceUnavailableException) Error

func (ServiceUnavailableException) GoString

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

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode

func (s *ServiceUnavailableException) StatusCode() int

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

func (ServiceUnavailableException) 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 StartEntitiesDetectionV2JobInput

type StartEntitiesDetectionV2JobInput struct {

	// A unique identifier for the request. If you don't set the client request
	// token, Amazon Comprehend Medical generates one for you.
	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"`

	// The input configuration that 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.
	// Amazon Comprehend Medical processes files in US English (en).
	//
	// LanguageCode is a required field
	LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

	// The output configuration that 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

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionV2JobInput) SetDataAccessRoleArn

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionV2JobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionV2JobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionV2JobInput) SetKMSKey

SetKMSKey sets the KMSKey field's value.

func (*StartEntitiesDetectionV2JobInput) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionV2JobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartEntitiesDetectionV2JobInput) 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 (*StartEntitiesDetectionV2JobInput) Validate

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

type StartEntitiesDetectionV2JobOutput

type StartEntitiesDetectionV2JobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the DescribeEntitiesDetectionV2Job operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartEntitiesDetectionV2JobOutput) GoString

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

SetJobId sets the JobId field's value.

func (StartEntitiesDetectionV2JobOutput) 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 StartICD10CMInferenceJobInput

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

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartICD10CMInferenceJobInput) SetDataAccessRoleArn

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartICD10CMInferenceJobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartICD10CMInferenceJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartICD10CMInferenceJobInput) SetKMSKey

SetKMSKey sets the KMSKey field's value.

func (*StartICD10CMInferenceJobInput) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*StartICD10CMInferenceJobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartICD10CMInferenceJobInput) 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 (*StartICD10CMInferenceJobInput) Validate

func (s *StartICD10CMInferenceJobInput) Validate() error

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

type StartICD10CMInferenceJobOutput

type StartICD10CMInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the StartICD10CMInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartICD10CMInferenceJobOutput) GoString

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

SetJobId sets the JobId field's value.

func (StartICD10CMInferenceJobOutput) 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 StartPHIDetectionJobInput

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

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

func (s *StartPHIDetectionJobInput) SetClientRequestToken(v string) *StartPHIDetectionJobInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartPHIDetectionJobInput) SetDataAccessRoleArn

func (s *StartPHIDetectionJobInput) SetDataAccessRoleArn(v string) *StartPHIDetectionJobInput

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartPHIDetectionJobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartPHIDetectionJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartPHIDetectionJobInput) SetKMSKey

SetKMSKey sets the KMSKey field's value.

func (*StartPHIDetectionJobInput) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*StartPHIDetectionJobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartPHIDetectionJobInput) String

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

func (s *StartPHIDetectionJobInput) Validate() error

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

type StartPHIDetectionJobOutput

type StartPHIDetectionJobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the DescribePHIDetectionJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartPHIDetectionJobOutput) GoString

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

SetJobId sets the JobId field's value.

func (StartPHIDetectionJobOutput) 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 StartRxNormInferenceJobInput

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

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartRxNormInferenceJobInput) SetDataAccessRoleArn

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartRxNormInferenceJobInput) SetInputDataConfig

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartRxNormInferenceJobInput) SetJobName

SetJobName sets the JobName field's value.

func (*StartRxNormInferenceJobInput) SetKMSKey

SetKMSKey sets the KMSKey field's value.

func (*StartRxNormInferenceJobInput) SetLanguageCode

SetLanguageCode sets the LanguageCode field's value.

func (*StartRxNormInferenceJobInput) SetOutputDataConfig

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartRxNormInferenceJobInput) 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 (*StartRxNormInferenceJobInput) Validate

func (s *StartRxNormInferenceJobInput) Validate() error

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

type StartRxNormInferenceJobOutput

type StartRxNormInferenceJobOutput struct {

	// The identifier of the job.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartRxNormInferenceJobOutput) GoString

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

SetJobId sets the JobId field's value.

func (StartRxNormInferenceJobOutput) 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 StartSNOMEDCTInferenceJobInput added in v1.42.9

type StartSNOMEDCTInferenceJobInput 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.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

	// 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.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The user generated name the asynchronous InferSNOMEDCT job.
	JobName *string `min:"1" type:"string"`

	// An AWS Key Management Service key used to encrypt your output files. If you
	// do not specify a key, the files are written in plain text.
	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"`

	// The output properties for a detection job.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartSNOMEDCTInferenceJobInput) GoString added in v1.42.9

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 (*StartSNOMEDCTInferenceJobInput) SetClientRequestToken added in v1.42.9

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartSNOMEDCTInferenceJobInput) SetDataAccessRoleArn added in v1.42.9

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartSNOMEDCTInferenceJobInput) SetInputDataConfig added in v1.42.9

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartSNOMEDCTInferenceJobInput) SetJobName added in v1.42.9

SetJobName sets the JobName field's value.

func (*StartSNOMEDCTInferenceJobInput) SetKMSKey added in v1.42.9

SetKMSKey sets the KMSKey field's value.

func (*StartSNOMEDCTInferenceJobInput) SetLanguageCode added in v1.42.9

SetLanguageCode sets the LanguageCode field's value.

func (*StartSNOMEDCTInferenceJobInput) SetOutputDataConfig added in v1.42.9

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartSNOMEDCTInferenceJobInput) String added in v1.42.9

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 (*StartSNOMEDCTInferenceJobInput) Validate added in v1.42.9

func (s *StartSNOMEDCTInferenceJobInput) Validate() error

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

type StartSNOMEDCTInferenceJobOutput added in v1.42.9

type StartSNOMEDCTInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of a job, use this
	// identifier with the StartSNOMEDCTInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StartSNOMEDCTInferenceJobOutput) GoString added in v1.42.9

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 (*StartSNOMEDCTInferenceJobOutput) SetJobId added in v1.42.9

SetJobId sets the JobId field's value.

func (StartSNOMEDCTInferenceJobOutput) String added in v1.42.9

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

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

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

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionV2JobInput) 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 (*StopEntitiesDetectionV2JobInput) Validate

func (s *StopEntitiesDetectionV2JobInput) Validate() error

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

type StopEntitiesDetectionV2JobOutput

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

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

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionV2JobOutput) 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 StopICD10CMInferenceJobInput

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

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

SetJobId sets the JobId field's value.

func (StopICD10CMInferenceJobInput) 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 (*StopICD10CMInferenceJobInput) Validate

func (s *StopICD10CMInferenceJobInput) Validate() error

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

type StopICD10CMInferenceJobOutput

type StopICD10CMInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeICD10CMInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopICD10CMInferenceJobOutput) GoString

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

SetJobId sets the JobId field's value.

func (StopICD10CMInferenceJobOutput) 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 StopPHIDetectionJobInput

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

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

SetJobId sets the JobId field's value.

func (StopPHIDetectionJobInput) String

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

func (s *StopPHIDetectionJobInput) Validate() error

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

type StopPHIDetectionJobOutput

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

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

SetJobId sets the JobId field's value.

func (StopPHIDetectionJobOutput) String

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

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

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

SetJobId sets the JobId field's value.

func (StopRxNormInferenceJobInput) 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 (*StopRxNormInferenceJobInput) Validate

func (s *StopRxNormInferenceJobInput) Validate() error

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

type StopRxNormInferenceJobOutput

type StopRxNormInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeRxNormInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopRxNormInferenceJobOutput) GoString

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

SetJobId sets the JobId field's value.

func (StopRxNormInferenceJobOutput) 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 StopSNOMEDCTInferenceJobInput added in v1.42.9

type StopSNOMEDCTInferenceJobInput struct {

	// The job id of the asynchronous InferSNOMEDCT job to be stopped.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopSNOMEDCTInferenceJobInput) GoString added in v1.42.9

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 (*StopSNOMEDCTInferenceJobInput) SetJobId added in v1.42.9

SetJobId sets the JobId field's value.

func (StopSNOMEDCTInferenceJobInput) String added in v1.42.9

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 (*StopSNOMEDCTInferenceJobInput) Validate added in v1.42.9

func (s *StopSNOMEDCTInferenceJobInput) Validate() error

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

type StopSNOMEDCTInferenceJobOutput added in v1.42.9

type StopSNOMEDCTInferenceJobOutput struct {

	// The identifier generated for the job. To get the status of job, use this
	// identifier with the DescribeSNOMEDCTInferenceJob operation.
	JobId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (StopSNOMEDCTInferenceJobOutput) GoString added in v1.42.9

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 (*StopSNOMEDCTInferenceJobOutput) SetJobId added in v1.42.9

SetJobId sets the JobId field's value.

func (StopSNOMEDCTInferenceJobOutput) String added in v1.42.9

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

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

Code returns the exception type name.

func (*TextSizeLimitExceededException) Error

func (TextSizeLimitExceededException) GoString

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

Message returns the exception's message.

func (*TextSizeLimitExceededException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TextSizeLimitExceededException) RequestID

func (s *TextSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TextSizeLimitExceededException) StatusCode

func (s *TextSizeLimitExceededException) StatusCode() int

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

func (TextSizeLimitExceededException) 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 TooManyRequestsException

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

func (s *TooManyRequestsException) Code() string

Code returns the exception type name.

func (*TooManyRequestsException) Error

func (s *TooManyRequestsException) Error() string

func (TooManyRequestsException) GoString

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

func (s *TooManyRequestsException) Message() string

Message returns the exception's message.

func (*TooManyRequestsException) OrigErr

func (s *TooManyRequestsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyRequestsException) RequestID

func (s *TooManyRequestsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyRequestsException) StatusCode

func (s *TooManyRequestsException) StatusCode() int

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

func (TooManyRequestsException) String

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 unmapped 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 was extracted, but Amazon Comprehend Medical was 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

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

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

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

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String

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
y or Y : Canonical URL