1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package comprehendmedical
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/comprehendmedical/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Gets the properties associated with a protected health information (PHI)
15// detection job. Use this operation to get the status of a detection job.
16func (c *Client) DescribePHIDetectionJob(ctx context.Context, params *DescribePHIDetectionJobInput, optFns ...func(*Options)) (*DescribePHIDetectionJobOutput, error) {
17	if params == nil {
18		params = &DescribePHIDetectionJobInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribePHIDetectionJob", params, optFns, addOperationDescribePHIDetectionJobMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribePHIDetectionJobOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribePHIDetectionJobInput struct {
32
33	// The identifier that Amazon Comprehend Medical generated for the job. The
34	// StartPHIDetectionJob operation returns this identifier in its response.
35	//
36	// This member is required.
37	JobId *string
38}
39
40type DescribePHIDetectionJobOutput struct {
41
42	// An object that contains the properties associated with a detection job.
43	ComprehendMedicalAsyncJobProperties *types.ComprehendMedicalAsyncJobProperties
44
45	// Metadata pertaining to the operation's result.
46	ResultMetadata middleware.Metadata
47}
48
49func addOperationDescribePHIDetectionJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
50	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribePHIDetectionJob{}, middleware.After)
51	if err != nil {
52		return err
53	}
54	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribePHIDetectionJob{}, middleware.After)
55	if err != nil {
56		return err
57	}
58	if err = addSetLoggerMiddleware(stack, options); err != nil {
59		return err
60	}
61	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
62		return err
63	}
64	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
65		return err
66	}
67	if err = addResolveEndpointMiddleware(stack, options); err != nil {
68		return err
69	}
70	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
71		return err
72	}
73	if err = addRetryMiddlewares(stack, options); err != nil {
74		return err
75	}
76	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
77		return err
78	}
79	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
83		return err
84	}
85	if err = addClientUserAgent(stack); err != nil {
86		return err
87	}
88	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
89		return err
90	}
91	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
92		return err
93	}
94	if err = addOpDescribePHIDetectionJobValidationMiddleware(stack); err != nil {
95		return err
96	}
97	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePHIDetectionJob(options.Region), middleware.Before); err != nil {
98		return err
99	}
100	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
101		return err
102	}
103	if err = addResponseErrorMiddleware(stack); err != nil {
104		return err
105	}
106	if err = addRequestResponseLogging(stack, options); err != nil {
107		return err
108	}
109	return nil
110}
111
112func newServiceMetadataMiddleware_opDescribePHIDetectionJob(region string) *awsmiddleware.RegisterServiceMetadata {
113	return &awsmiddleware.RegisterServiceMetadata{
114		Region:        region,
115		ServiceID:     ServiceID,
116		SigningName:   "comprehendmedical",
117		OperationName: "DescribePHIDetectionJob",
118	}
119}
120