AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ComprehendMedical

import "github.com/aws/aws-sdk-go/service/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.

Client

Type: *client.Client

Method

DetectEntities

func (c *ComprehendMedical) DetectEntities(input *DetectEntitiesInput) (*DetectEntitiesOutput, error)

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

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

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

  • ErrCodeTooManyRequestsException "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.

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

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

  • ErrCodeTextSizeLimitExceededException "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

DetectEntitiesRequest

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

DetectEntitiesWithContext

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.

See Also

For more information about using this API, see AWS API Documentation.

DetectPHI

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

DetectPHI API operation for AWS Comprehend Medical.

Inspects the clinical text for personal health information (PHI) entities and 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 DetectPHI for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerException "InternalServerException" An internal server error occurred. Retry your request.

  • ErrCodeServiceUnavailableException "ServiceUnavailableException" The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

  • ErrCodeTooManyRequestsException "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.

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

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

  • ErrCodeTextSizeLimitExceededException "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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: