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, c.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	noSmithyDocumentSerde
40}
41
42type DescribePHIDetectionJobOutput struct {
43
44	// An object that contains the properties associated with a detection job.
45	ComprehendMedicalAsyncJobProperties *types.ComprehendMedicalAsyncJobProperties
46
47	// Metadata pertaining to the operation's result.
48	ResultMetadata middleware.Metadata
49
50	noSmithyDocumentSerde
51}
52
53func (c *Client) addOperationDescribePHIDetectionJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
54	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribePHIDetectionJob{}, middleware.After)
55	if err != nil {
56		return err
57	}
58	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribePHIDetectionJob{}, middleware.After)
59	if err != nil {
60		return err
61	}
62	if err = addSetLoggerMiddleware(stack, options); err != nil {
63		return err
64	}
65	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
66		return err
67	}
68	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
69		return err
70	}
71	if err = addResolveEndpointMiddleware(stack, options); err != nil {
72		return err
73	}
74	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
75		return err
76	}
77	if err = addRetryMiddlewares(stack, options); err != nil {
78		return err
79	}
80	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
81		return err
82	}
83	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
84		return err
85	}
86	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
87		return err
88	}
89	if err = addClientUserAgent(stack); err != nil {
90		return err
91	}
92	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
93		return err
94	}
95	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
96		return err
97	}
98	if err = addOpDescribePHIDetectionJobValidationMiddleware(stack); err != nil {
99		return err
100	}
101	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePHIDetectionJob(options.Region), middleware.Before); err != nil {
102		return err
103	}
104	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
105		return err
106	}
107	if err = addResponseErrorMiddleware(stack); err != nil {
108		return err
109	}
110	if err = addRequestResponseLogging(stack, options); err != nil {
111		return err
112	}
113	return nil
114}
115
116func newServiceMetadataMiddleware_opDescribePHIDetectionJob(region string) *awsmiddleware.RegisterServiceMetadata {
117	return &awsmiddleware.RegisterServiceMetadata{
118		Region:        region,
119		ServiceID:     ServiceID,
120		SigningName:   "comprehendmedical",
121		OperationName: "DescribePHIDetectionJob",
122	}
123}
124