aws-sdk-go: github.com/aws/aws-sdk-go/service/comprehendmedical Index | Files | Directories

package comprehendmedical

import "github.com/aws/aws-sdk-go/service/comprehendmedical"

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

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

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

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

Using the Client

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

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

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

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

Index

Package Files

api.go doc.go errors.go service.go

Constants

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"
)
const (
    // EntitySubTypeName is a EntitySubType enum value
    EntitySubTypeName = "NAME"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // EntitySubTypeQuantity is a EntitySubType enum value
    EntitySubTypeQuantity = "QUANTITY"
)
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"
)
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"
)
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"
)
const (
    ServiceName = "ComprehendMedical" // Name of service.
    EndpointsID = "comprehendmedical" // ID to lookup a service endpoint with.
    ServiceID   = "ComprehendMedical" // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // LanguageCodeEn is a LanguageCode enum value
    LanguageCodeEn = "en"
)

type Attribute Uses

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

func (s Attribute) GoString() string

GoString returns the string representation

func (*Attribute) SetBeginOffset Uses

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

SetBeginOffset sets the BeginOffset field's value.

func (*Attribute) SetEndOffset Uses

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

SetEndOffset sets the EndOffset field's value.

func (*Attribute) SetId Uses

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

SetId sets the Id field's value.

func (*Attribute) SetRelationshipScore Uses

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

SetRelationshipScore sets the RelationshipScore field's value.

func (*Attribute) SetScore Uses

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

SetScore sets the Score field's value.

func (*Attribute) SetText Uses

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

SetText sets the Text field's value.

func (*Attribute) SetTraits Uses

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

SetTraits sets the Traits field's value.

func (*Attribute) SetType Uses

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

SetType sets the Type field's value.

func (Attribute) String Uses

func (s Attribute) String() string

String returns the string representation

type ComprehendMedical Uses

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 Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ComprehendMedical

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:

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

func (c *ComprehendMedical) DescribeEntitiesDetectionV2Job(input *DescribeEntitiesDetectionV2JobInput) (*DescribeEntitiesDetectionV2JobOutput, error)

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

* ErrCodeInvalidRequestException "InvalidRequestException"
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the 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.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DescribePHIDetectionJob Uses

func (c *ComprehendMedical) DescribePHIDetectionJob(input *DescribePHIDetectionJobInput) (*DescribePHIDetectionJobOutput, error)

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

* ErrCodeInvalidRequestException "InvalidRequestException"
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the 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.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) DetectEntities Uses

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

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

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The Amazon 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

Deprecated: This operation is deprecated, use DetectEntitiesV2 instead.

func (*ComprehendMedical) DetectEntitiesRequest Uses

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 Uses

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.

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. It does not return the Quality or Quantity entities.

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

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

* ErrCodeServiceUnavailableException "ServiceUnavailableException"
The Amazon 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/DetectEntitiesV2

func (*ComprehendMedical) DetectEntitiesV2Request Uses

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 Uses

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 Uses

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 Uses

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

func (*ComprehendMedical) DetectPHIRequest Uses

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 Uses

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) ListEntitiesDetectionV2Jobs Uses

func (c *ComprehendMedical) ListEntitiesDetectionV2Jobs(input *ListEntitiesDetectionV2JobsInput) (*ListEntitiesDetectionV2JobsOutput, error)

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

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

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

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) ListPHIDetectionJobs Uses

func (c *ComprehendMedical) ListPHIDetectionJobs(input *ListPHIDetectionJobsInput) (*ListPHIDetectionJobsOutput, error)

ListPHIDetectionJobs API operation for AWS Comprehend Medical.

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

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

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

Returned Error Codes:

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

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

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StartEntitiesDetectionV2Job Uses

func (c *ComprehendMedical) StartEntitiesDetectionV2Job(input *StartEntitiesDetectionV2JobInput) (*StartEntitiesDetectionV2JobOutput, error)

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

* ErrCodeInvalidRequestException "InvalidRequestException"
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the 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.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StartPHIDetectionJob Uses

func (c *ComprehendMedical) StartPHIDetectionJob(input *StartPHIDetectionJobInput) (*StartPHIDetectionJobOutput, error)

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

* ErrCodeInvalidRequestException "InvalidRequestException"
The request that you made is invalid. Check your request to determine why
it's invalid and then retry the 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.

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StopEntitiesDetectionV2Job Uses

func (c *ComprehendMedical) StopEntitiesDetectionV2Job(input *StopEntitiesDetectionV2JobInput) (*StopEntitiesDetectionV2JobOutput, error)

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

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

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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) StopPHIDetectionJob Uses

func (c *ComprehendMedical) StopPHIDetectionJob(input *StopPHIDetectionJobInput) (*StopPHIDetectionJobOutput, error)

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

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

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

* ErrCodeInternalServerException "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 Uses

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 Uses

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.

type ComprehendMedicalAsyncJobFilter Uses

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 Uses

func (s ComprehendMedicalAsyncJobFilter) GoString() string

GoString returns the string representation

func (*ComprehendMedicalAsyncJobFilter) SetJobName Uses

func (s *ComprehendMedicalAsyncJobFilter) SetJobName(v string) *ComprehendMedicalAsyncJobFilter

SetJobName sets the JobName field's value.

func (*ComprehendMedicalAsyncJobFilter) SetJobStatus Uses

func (s *ComprehendMedicalAsyncJobFilter) SetJobStatus(v string) *ComprehendMedicalAsyncJobFilter

SetJobStatus sets the JobStatus field's value.

func (*ComprehendMedicalAsyncJobFilter) SetSubmitTimeAfter Uses

func (s *ComprehendMedicalAsyncJobFilter) SetSubmitTimeAfter(v time.Time) *ComprehendMedicalAsyncJobFilter

SetSubmitTimeAfter sets the SubmitTimeAfter field's value.

func (*ComprehendMedicalAsyncJobFilter) SetSubmitTimeBefore Uses

func (s *ComprehendMedicalAsyncJobFilter) SetSubmitTimeBefore(v time.Time) *ComprehendMedicalAsyncJobFilter

SetSubmitTimeBefore sets the SubmitTimeBefore field's value.

func (ComprehendMedicalAsyncJobFilter) String Uses

func (s ComprehendMedicalAsyncJobFilter) String() string

String returns the string representation

func (*ComprehendMedicalAsyncJobFilter) Validate Uses

func (s *ComprehendMedicalAsyncJobFilter) Validate() error

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

type ComprehendMedicalAsyncJobProperties Uses

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 Uses

func (s ComprehendMedicalAsyncJobProperties) GoString() string

GoString returns the string representation

func (*ComprehendMedicalAsyncJobProperties) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*ComprehendMedicalAsyncJobProperties) SetEndTime Uses

func (s *ComprehendMedicalAsyncJobProperties) SetEndTime(v time.Time) *ComprehendMedicalAsyncJobProperties

SetEndTime sets the EndTime field's value.

func (*ComprehendMedicalAsyncJobProperties) SetExpirationTime Uses

func (s *ComprehendMedicalAsyncJobProperties) SetExpirationTime(v time.Time) *ComprehendMedicalAsyncJobProperties

SetExpirationTime sets the ExpirationTime field's value.

func (*ComprehendMedicalAsyncJobProperties) SetInputDataConfig Uses

func (s *ComprehendMedicalAsyncJobProperties) SetInputDataConfig(v *InputDataConfig) *ComprehendMedicalAsyncJobProperties

SetInputDataConfig sets the InputDataConfig field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobId Uses

func (s *ComprehendMedicalAsyncJobProperties) SetJobId(v string) *ComprehendMedicalAsyncJobProperties

SetJobId sets the JobId field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobName Uses

func (s *ComprehendMedicalAsyncJobProperties) SetJobName(v string) *ComprehendMedicalAsyncJobProperties

SetJobName sets the JobName field's value.

func (*ComprehendMedicalAsyncJobProperties) SetJobStatus Uses

func (s *ComprehendMedicalAsyncJobProperties) SetJobStatus(v string) *ComprehendMedicalAsyncJobProperties

SetJobStatus sets the JobStatus field's value.

func (*ComprehendMedicalAsyncJobProperties) SetKMSKey Uses

func (s *ComprehendMedicalAsyncJobProperties) SetKMSKey(v string) *ComprehendMedicalAsyncJobProperties

SetKMSKey sets the KMSKey field's value.

func (*ComprehendMedicalAsyncJobProperties) SetLanguageCode Uses

func (s *ComprehendMedicalAsyncJobProperties) SetLanguageCode(v string) *ComprehendMedicalAsyncJobProperties

SetLanguageCode sets the LanguageCode field's value.

func (*ComprehendMedicalAsyncJobProperties) SetManifestFilePath Uses

func (s *ComprehendMedicalAsyncJobProperties) SetManifestFilePath(v string) *ComprehendMedicalAsyncJobProperties

SetManifestFilePath sets the ManifestFilePath field's value.

func (*ComprehendMedicalAsyncJobProperties) SetMessage Uses

func (s *ComprehendMedicalAsyncJobProperties) SetMessage(v string) *ComprehendMedicalAsyncJobProperties

SetMessage sets the Message field's value.

func (*ComprehendMedicalAsyncJobProperties) SetModelVersion Uses

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

SetModelVersion sets the ModelVersion field's value.

func (*ComprehendMedicalAsyncJobProperties) SetOutputDataConfig Uses

func (s *ComprehendMedicalAsyncJobProperties) SetOutputDataConfig(v *OutputDataConfig) *ComprehendMedicalAsyncJobProperties

SetOutputDataConfig sets the OutputDataConfig field's value.

func (*ComprehendMedicalAsyncJobProperties) SetSubmitTime Uses

func (s *ComprehendMedicalAsyncJobProperties) SetSubmitTime(v time.Time) *ComprehendMedicalAsyncJobProperties

SetSubmitTime sets the SubmitTime field's value.

func (ComprehendMedicalAsyncJobProperties) String Uses

func (s ComprehendMedicalAsyncJobProperties) String() string

String returns the string representation

type DescribeEntitiesDetectionV2JobInput Uses

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 Uses

func (s DescribeEntitiesDetectionV2JobInput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionV2JobInput) SetJobId Uses

func (s *DescribeEntitiesDetectionV2JobInput) SetJobId(v string) *DescribeEntitiesDetectionV2JobInput

SetJobId sets the JobId field's value.

func (DescribeEntitiesDetectionV2JobInput) String Uses

func (s DescribeEntitiesDetectionV2JobInput) String() string

String returns the string representation

func (*DescribeEntitiesDetectionV2JobInput) Validate Uses

func (s *DescribeEntitiesDetectionV2JobInput) Validate() error

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

type DescribeEntitiesDetectionV2JobOutput Uses

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 Uses

func (s DescribeEntitiesDetectionV2JobOutput) GoString() string

GoString returns the string representation

func (*DescribeEntitiesDetectionV2JobOutput) SetComprehendMedicalAsyncJobProperties Uses

func (s *DescribeEntitiesDetectionV2JobOutput) SetComprehendMedicalAsyncJobProperties(v *ComprehendMedicalAsyncJobProperties) *DescribeEntitiesDetectionV2JobOutput

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribeEntitiesDetectionV2JobOutput) String Uses

func (s DescribeEntitiesDetectionV2JobOutput) String() string

String returns the string representation

type DescribePHIDetectionJobInput Uses

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 Uses

func (s DescribePHIDetectionJobInput) GoString() string

GoString returns the string representation

func (*DescribePHIDetectionJobInput) SetJobId Uses

func (s *DescribePHIDetectionJobInput) SetJobId(v string) *DescribePHIDetectionJobInput

SetJobId sets the JobId field's value.

func (DescribePHIDetectionJobInput) String Uses

func (s DescribePHIDetectionJobInput) String() string

String returns the string representation

func (*DescribePHIDetectionJobInput) Validate Uses

func (s *DescribePHIDetectionJobInput) Validate() error

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

type DescribePHIDetectionJobOutput Uses

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 Uses

func (s DescribePHIDetectionJobOutput) GoString() string

GoString returns the string representation

func (*DescribePHIDetectionJobOutput) SetComprehendMedicalAsyncJobProperties Uses

func (s *DescribePHIDetectionJobOutput) SetComprehendMedicalAsyncJobProperties(v *ComprehendMedicalAsyncJobProperties) *DescribePHIDetectionJobOutput

SetComprehendMedicalAsyncJobProperties sets the ComprehendMedicalAsyncJobProperties field's value.

func (DescribePHIDetectionJobOutput) String Uses

func (s DescribePHIDetectionJobOutput) String() string

String returns the string representation

type DetectEntitiesInput Uses

type DetectEntitiesInput struct {

    // A UTF-8 text string containing the clinical content being examined for entities.
    // Each string must contain fewer than 20,000 bytes of characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectEntitiesInput) GoString Uses

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation

func (*DetectEntitiesInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectEntitiesInput) String Uses

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate Uses

func (s *DetectEntitiesInput) Validate() error

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

type DetectEntitiesOutput Uses

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 Uses

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation

func (*DetectEntitiesOutput) SetEntities Uses

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

SetEntities sets the Entities field's value.

func (*DetectEntitiesOutput) SetModelVersion Uses

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

SetModelVersion sets the ModelVersion field's value.

func (*DetectEntitiesOutput) SetPaginationToken Uses

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

SetPaginationToken sets the PaginationToken field's value.

func (*DetectEntitiesOutput) SetUnmappedAttributes Uses

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

SetUnmappedAttributes sets the UnmappedAttributes field's value.

func (DetectEntitiesOutput) String Uses

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectEntitiesV2Input Uses

type DetectEntitiesV2Input struct {

    // A UTF-8 string containing the clinical content being examined for entities.
    // Each string must contain fewer than 20,000 bytes of characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectEntitiesV2Input) GoString Uses

func (s DetectEntitiesV2Input) GoString() string

GoString returns the string representation

func (*DetectEntitiesV2Input) SetText Uses

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

SetText sets the Text field's value.

func (DetectEntitiesV2Input) String Uses

func (s DetectEntitiesV2Input) String() string

String returns the string representation

func (*DetectEntitiesV2Input) Validate Uses

func (s *DetectEntitiesV2Input) Validate() error

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

type DetectEntitiesV2Output Uses

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 Uses

func (s DetectEntitiesV2Output) GoString() string

GoString returns the string representation

func (*DetectEntitiesV2Output) SetEntities Uses

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

SetEntities sets the Entities field's value.

func (*DetectEntitiesV2Output) SetModelVersion Uses

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

SetModelVersion sets the ModelVersion field's value.

func (*DetectEntitiesV2Output) SetPaginationToken Uses

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

SetPaginationToken sets the PaginationToken field's value.

func (*DetectEntitiesV2Output) SetUnmappedAttributes Uses

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

SetUnmappedAttributes sets the UnmappedAttributes field's value.

func (DetectEntitiesV2Output) String Uses

func (s DetectEntitiesV2Output) String() string

String returns the string representation

type DetectPHIInput Uses

type DetectPHIInput struct {

    // A UTF-8 text string containing the clinical content being examined for PHI
    // entities. Each string must contain fewer than 20,000 bytes of characters.
    //
    // Text is a required field
    Text *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DetectPHIInput) GoString Uses

func (s DetectPHIInput) GoString() string

GoString returns the string representation

func (*DetectPHIInput) SetText Uses

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

SetText sets the Text field's value.

func (DetectPHIInput) String Uses

func (s DetectPHIInput) String() string

String returns the string representation

func (*DetectPHIInput) Validate Uses

func (s *DetectPHIInput) Validate() error

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

type DetectPHIOutput Uses

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 Uses

func (s DetectPHIOutput) GoString() string

GoString returns the string representation

func (*DetectPHIOutput) SetEntities Uses

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

SetEntities sets the Entities field's value.

func (*DetectPHIOutput) SetModelVersion Uses

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

SetModelVersion sets the ModelVersion field's value.

func (*DetectPHIOutput) SetPaginationToken Uses

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

SetPaginationToken sets the PaginationToken field's value.

func (DetectPHIOutput) String Uses

func (s DetectPHIOutput) String() string

String returns the string representation

type Entity Uses

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 Uses

func (s Entity) GoString() string

GoString returns the string representation

func (*Entity) SetAttributes Uses

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

SetAttributes sets the Attributes field's value.

func (*Entity) SetBeginOffset Uses

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

SetBeginOffset sets the BeginOffset field's value.

func (*Entity) SetCategory Uses

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

SetCategory sets the Category field's value.

func (*Entity) SetEndOffset Uses

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

SetEndOffset sets the EndOffset field's value.

func (*Entity) SetId Uses

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

SetId sets the Id field's value.

func (*Entity) SetScore Uses

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

SetScore sets the Score field's value.

func (*Entity) SetText Uses

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

SetText sets the Text field's value.

func (*Entity) SetTraits Uses

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

SetTraits sets the Traits field's value.

func (*Entity) SetType Uses

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

SetType sets the Type field's value.

func (Entity) String Uses

func (s Entity) String() string

String returns the string representation

type InputDataConfig Uses

type InputDataConfig struct {

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

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

The input properties for an entities detection job

func (InputDataConfig) GoString Uses

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (*InputDataConfig) SetS3Bucket Uses

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

SetS3Bucket sets the S3Bucket field's value.

func (*InputDataConfig) SetS3Key Uses

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

SetS3Key sets the S3Key field's value.

func (InputDataConfig) String Uses

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate Uses

func (s *InputDataConfig) Validate() error

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

type ListEntitiesDetectionV2JobsInput Uses

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 Uses

func (s ListEntitiesDetectionV2JobsInput) GoString() string

GoString returns the string representation

func (*ListEntitiesDetectionV2JobsInput) SetFilter Uses

func (s *ListEntitiesDetectionV2JobsInput) SetFilter(v *ComprehendMedicalAsyncJobFilter) *ListEntitiesDetectionV2JobsInput

SetFilter sets the Filter field's value.

func (*ListEntitiesDetectionV2JobsInput) SetMaxResults Uses

func (s *ListEntitiesDetectionV2JobsInput) SetMaxResults(v int64) *ListEntitiesDetectionV2JobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListEntitiesDetectionV2JobsInput) SetNextToken Uses

func (s *ListEntitiesDetectionV2JobsInput) SetNextToken(v string) *ListEntitiesDetectionV2JobsInput

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionV2JobsInput) String Uses

func (s ListEntitiesDetectionV2JobsInput) String() string

String returns the string representation

func (*ListEntitiesDetectionV2JobsInput) Validate Uses

func (s *ListEntitiesDetectionV2JobsInput) Validate() error

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

type ListEntitiesDetectionV2JobsOutput Uses

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 Uses

func (s ListEntitiesDetectionV2JobsOutput) GoString() string

GoString returns the string representation

func (*ListEntitiesDetectionV2JobsOutput) SetComprehendMedicalAsyncJobPropertiesList Uses

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

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListEntitiesDetectionV2JobsOutput) SetNextToken Uses

func (s *ListEntitiesDetectionV2JobsOutput) SetNextToken(v string) *ListEntitiesDetectionV2JobsOutput

SetNextToken sets the NextToken field's value.

func (ListEntitiesDetectionV2JobsOutput) String Uses

func (s ListEntitiesDetectionV2JobsOutput) String() string

String returns the string representation

type ListPHIDetectionJobsInput Uses

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 Uses

func (s ListPHIDetectionJobsInput) GoString() string

GoString returns the string representation

func (*ListPHIDetectionJobsInput) SetFilter Uses

func (s *ListPHIDetectionJobsInput) SetFilter(v *ComprehendMedicalAsyncJobFilter) *ListPHIDetectionJobsInput

SetFilter sets the Filter field's value.

func (*ListPHIDetectionJobsInput) SetMaxResults Uses

func (s *ListPHIDetectionJobsInput) SetMaxResults(v int64) *ListPHIDetectionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPHIDetectionJobsInput) SetNextToken Uses

func (s *ListPHIDetectionJobsInput) SetNextToken(v string) *ListPHIDetectionJobsInput

SetNextToken sets the NextToken field's value.

func (ListPHIDetectionJobsInput) String Uses

func (s ListPHIDetectionJobsInput) String() string

String returns the string representation

func (*ListPHIDetectionJobsInput) Validate Uses

func (s *ListPHIDetectionJobsInput) Validate() error

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

type ListPHIDetectionJobsOutput Uses

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 Uses

func (s ListPHIDetectionJobsOutput) GoString() string

GoString returns the string representation

func (*ListPHIDetectionJobsOutput) SetComprehendMedicalAsyncJobPropertiesList Uses

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

SetComprehendMedicalAsyncJobPropertiesList sets the ComprehendMedicalAsyncJobPropertiesList field's value.

func (*ListPHIDetectionJobsOutput) SetNextToken Uses

func (s *ListPHIDetectionJobsOutput) SetNextToken(v string) *ListPHIDetectionJobsOutput

SetNextToken sets the NextToken field's value.

func (ListPHIDetectionJobsOutput) String Uses

func (s ListPHIDetectionJobsOutput) String() string

String returns the string representation

type OutputDataConfig Uses

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 Uses

func (s OutputDataConfig) GoString() string

GoString returns the string representation

func (*OutputDataConfig) SetS3Bucket Uses

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

SetS3Bucket sets the S3Bucket field's value.

func (*OutputDataConfig) SetS3Key Uses

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

SetS3Key sets the S3Key field's value.

func (OutputDataConfig) String Uses

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate Uses

func (s *OutputDataConfig) Validate() error

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

type StartEntitiesDetectionV2JobInput Uses

type StartEntitiesDetectionV2JobInput struct {

    // A unique identifier for the request. If you don't set the client request
    // token, Amazon Comprehend Medical generates one.
    ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

    // The Amazon Resource Name (ARN) of the AWS Identity and Access Management
    // (IAM) role that grants Amazon Comprehend Medical read access to your input
    // data. For more information, see Role-Based Permissions Required for Asynchronous
    // Operations (https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med).
    //
    // DataAccessRoleArn is a required field
    DataAccessRoleArn *string `min:"20" type:"string" required:"true"`

    // Specifies the format and location of the input data for the job.
    //
    // InputDataConfig is a required field
    InputDataConfig *InputDataConfig `type:"structure" required:"true"`

    // The identifier of the job.
    JobName *string `min:"1" type:"string"`

    // An AWS Key Management Service key to encrypt your output files. If you do
    // not specify a key, the files are written in plain text.
    KMSKey *string `min:"1" type:"string"`

    // The language of the input documents. All documents must be in the same language.
    //
    // LanguageCode is a required field
    LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"`

    // Specifies where to send the output files.
    //
    // OutputDataConfig is a required field
    OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

func (StartEntitiesDetectionV2JobInput) GoString Uses

func (s StartEntitiesDetectionV2JobInput) GoString() string

GoString returns the string representation

func (*StartEntitiesDetectionV2JobInput) SetClientRequestToken Uses

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartEntitiesDetectionV2JobInput) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartEntitiesDetectionV2JobInput) SetInputDataConfig Uses

func (s *StartEntitiesDetectionV2JobInput) SetInputDataConfig(v *InputDataConfig) *StartEntitiesDetectionV2JobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartEntitiesDetectionV2JobInput) SetJobName Uses

func (s *StartEntitiesDetectionV2JobInput) SetJobName(v string) *StartEntitiesDetectionV2JobInput

SetJobName sets the JobName field's value.

func (*StartEntitiesDetectionV2JobInput) SetKMSKey Uses

func (s *StartEntitiesDetectionV2JobInput) SetKMSKey(v string) *StartEntitiesDetectionV2JobInput

SetKMSKey sets the KMSKey field's value.

func (*StartEntitiesDetectionV2JobInput) SetLanguageCode Uses

func (s *StartEntitiesDetectionV2JobInput) SetLanguageCode(v string) *StartEntitiesDetectionV2JobInput

SetLanguageCode sets the LanguageCode field's value.

func (*StartEntitiesDetectionV2JobInput) SetOutputDataConfig Uses

func (s *StartEntitiesDetectionV2JobInput) SetOutputDataConfig(v *OutputDataConfig) *StartEntitiesDetectionV2JobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartEntitiesDetectionV2JobInput) String Uses

func (s StartEntitiesDetectionV2JobInput) String() string

String returns the string representation

func (*StartEntitiesDetectionV2JobInput) Validate Uses

func (s *StartEntitiesDetectionV2JobInput) Validate() error

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

type StartEntitiesDetectionV2JobOutput Uses

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 Uses

func (s StartEntitiesDetectionV2JobOutput) GoString() string

GoString returns the string representation

func (*StartEntitiesDetectionV2JobOutput) SetJobId Uses

func (s *StartEntitiesDetectionV2JobOutput) SetJobId(v string) *StartEntitiesDetectionV2JobOutput

SetJobId sets the JobId field's value.

func (StartEntitiesDetectionV2JobOutput) String Uses

func (s StartEntitiesDetectionV2JobOutput) String() string

String returns the string representation

type StartPHIDetectionJobInput Uses

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 Uses

func (s StartPHIDetectionJobInput) GoString() string

GoString returns the string representation

func (*StartPHIDetectionJobInput) SetClientRequestToken Uses

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

SetClientRequestToken sets the ClientRequestToken field's value.

func (*StartPHIDetectionJobInput) SetDataAccessRoleArn Uses

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

SetDataAccessRoleArn sets the DataAccessRoleArn field's value.

func (*StartPHIDetectionJobInput) SetInputDataConfig Uses

func (s *StartPHIDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartPHIDetectionJobInput

SetInputDataConfig sets the InputDataConfig field's value.

func (*StartPHIDetectionJobInput) SetJobName Uses

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

SetJobName sets the JobName field's value.

func (*StartPHIDetectionJobInput) SetKMSKey Uses

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

SetKMSKey sets the KMSKey field's value.

func (*StartPHIDetectionJobInput) SetLanguageCode Uses

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

SetLanguageCode sets the LanguageCode field's value.

func (*StartPHIDetectionJobInput) SetOutputDataConfig Uses

func (s *StartPHIDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartPHIDetectionJobInput

SetOutputDataConfig sets the OutputDataConfig field's value.

func (StartPHIDetectionJobInput) String Uses

func (s StartPHIDetectionJobInput) String() string

String returns the string representation

func (*StartPHIDetectionJobInput) Validate Uses

func (s *StartPHIDetectionJobInput) Validate() error

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

type StartPHIDetectionJobOutput Uses

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 Uses

func (s StartPHIDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StartPHIDetectionJobOutput) SetJobId Uses

func (s *StartPHIDetectionJobOutput) SetJobId(v string) *StartPHIDetectionJobOutput

SetJobId sets the JobId field's value.

func (StartPHIDetectionJobOutput) String Uses

func (s StartPHIDetectionJobOutput) String() string

String returns the string representation

type StopEntitiesDetectionV2JobInput Uses

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 Uses

func (s StopEntitiesDetectionV2JobInput) GoString() string

GoString returns the string representation

func (*StopEntitiesDetectionV2JobInput) SetJobId Uses

func (s *StopEntitiesDetectionV2JobInput) SetJobId(v string) *StopEntitiesDetectionV2JobInput

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionV2JobInput) String Uses

func (s StopEntitiesDetectionV2JobInput) String() string

String returns the string representation

func (*StopEntitiesDetectionV2JobInput) Validate Uses

func (s *StopEntitiesDetectionV2JobInput) Validate() error

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

type StopEntitiesDetectionV2JobOutput Uses

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 Uses

func (s StopEntitiesDetectionV2JobOutput) GoString() string

GoString returns the string representation

func (*StopEntitiesDetectionV2JobOutput) SetJobId Uses

func (s *StopEntitiesDetectionV2JobOutput) SetJobId(v string) *StopEntitiesDetectionV2JobOutput

SetJobId sets the JobId field's value.

func (StopEntitiesDetectionV2JobOutput) String Uses

func (s StopEntitiesDetectionV2JobOutput) String() string

String returns the string representation

type StopPHIDetectionJobInput Uses

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 Uses

func (s StopPHIDetectionJobInput) GoString() string

GoString returns the string representation

func (*StopPHIDetectionJobInput) SetJobId Uses

func (s *StopPHIDetectionJobInput) SetJobId(v string) *StopPHIDetectionJobInput

SetJobId sets the JobId field's value.

func (StopPHIDetectionJobInput) String Uses

func (s StopPHIDetectionJobInput) String() string

String returns the string representation

func (*StopPHIDetectionJobInput) Validate Uses

func (s *StopPHIDetectionJobInput) Validate() error

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

type StopPHIDetectionJobOutput Uses

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 Uses

func (s StopPHIDetectionJobOutput) GoString() string

GoString returns the string representation

func (*StopPHIDetectionJobOutput) SetJobId Uses

func (s *StopPHIDetectionJobOutput) SetJobId(v string) *StopPHIDetectionJobOutput

SetJobId sets the JobId field's value.

func (StopPHIDetectionJobOutput) String Uses

func (s StopPHIDetectionJobOutput) String() string

String returns the string representation

type Trait Uses

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 Uses

func (s Trait) GoString() string

GoString returns the string representation

func (*Trait) SetName Uses

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

SetName sets the Name field's value.

func (*Trait) SetScore Uses

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

SetScore sets the Score field's value.

func (Trait) String Uses

func (s Trait) String() string

String returns the string representation

type UnmappedAttribute Uses

type UnmappedAttribute struct {

    // The specific attribute that has been extracted but not mapped to an entity.
    Attribute *Attribute `type:"structure"`

    // The type of the attribute, could be one of the following values: "MEDICATION",
    // "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
    Type *string `type:"string" enum:"EntityType"`
    // contains filtered or unexported fields
}

An attribute that we extracted, but were unable to relate to an entity.

func (UnmappedAttribute) GoString Uses

func (s UnmappedAttribute) GoString() string

GoString returns the string representation

func (*UnmappedAttribute) SetAttribute Uses

func (s *UnmappedAttribute) SetAttribute(v *Attribute) *UnmappedAttribute

SetAttribute sets the Attribute field's value.

func (*UnmappedAttribute) SetType Uses

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

SetType sets the Type field's value.

func (UnmappedAttribute) String Uses

func (s UnmappedAttribute) String() string

String returns the string representation

Directories

PathSynopsis
comprehendmedicalifacePackage comprehendmedicaliface provides an interface to enable mocking the AWS Comprehend Medical service client for testing your code.

Package comprehendmedical imports 8 packages (graph) and is imported by 10 packages. Updated 2019-11-04. Refresh now. Tools for package owners.