1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package comprehend
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/comprehend/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Stops a sentiment detection job in progress. If the job state is IN_PROGRESS the
15// job is marked for termination and put into the STOP_REQUESTED state. If the job
16// completes before it can be stopped, it is put into the COMPLETED state;
17// otherwise the job is be stopped and put into the STOPPED state. If the job is in
18// the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob
19// operation, the operation returns a 400 Internal Request Exception. When a job is
20// stopped, any documents already processed are written to the output location.
21func (c *Client) StopSentimentDetectionJob(ctx context.Context, params *StopSentimentDetectionJobInput, optFns ...func(*Options)) (*StopSentimentDetectionJobOutput, error) {
22	if params == nil {
23		params = &StopSentimentDetectionJobInput{}
24	}
25
26	result, metadata, err := c.invokeOperation(ctx, "StopSentimentDetectionJob", params, optFns, c.addOperationStopSentimentDetectionJobMiddlewares)
27	if err != nil {
28		return nil, err
29	}
30
31	out := result.(*StopSentimentDetectionJobOutput)
32	out.ResultMetadata = metadata
33	return out, nil
34}
35
36type StopSentimentDetectionJobInput struct {
37
38	// The identifier of the sentiment detection job to stop.
39	//
40	// This member is required.
41	JobId *string
42
43	noSmithyDocumentSerde
44}
45
46type StopSentimentDetectionJobOutput struct {
47
48	// The identifier of the sentiment detection job to stop.
49	JobId *string
50
51	// Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
52	// previously stopped with the StopSentimentDetectionJob operation.
53	JobStatus types.JobStatus
54
55	// Metadata pertaining to the operation's result.
56	ResultMetadata middleware.Metadata
57
58	noSmithyDocumentSerde
59}
60
61func (c *Client) addOperationStopSentimentDetectionJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
62	err = stack.Serialize.Add(&awsAwsjson11_serializeOpStopSentimentDetectionJob{}, middleware.After)
63	if err != nil {
64		return err
65	}
66	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStopSentimentDetectionJob{}, middleware.After)
67	if err != nil {
68		return err
69	}
70	if err = addSetLoggerMiddleware(stack, options); err != nil {
71		return err
72	}
73	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
74		return err
75	}
76	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
77		return err
78	}
79	if err = addResolveEndpointMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
83		return err
84	}
85	if err = addRetryMiddlewares(stack, options); err != nil {
86		return err
87	}
88	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
89		return err
90	}
91	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
95		return err
96	}
97	if err = addClientUserAgent(stack); err != nil {
98		return err
99	}
100	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
101		return err
102	}
103	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
104		return err
105	}
106	if err = addOpStopSentimentDetectionJobValidationMiddleware(stack); err != nil {
107		return err
108	}
109	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStopSentimentDetectionJob(options.Region), middleware.Before); err != nil {
110		return err
111	}
112	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addResponseErrorMiddleware(stack); err != nil {
116		return err
117	}
118	if err = addRequestResponseLogging(stack, options); err != nil {
119		return err
120	}
121	return nil
122}
123
124func newServiceMetadataMiddleware_opStopSentimentDetectionJob(region string) *awsmiddleware.RegisterServiceMetadata {
125	return &awsmiddleware.RegisterServiceMetadata{
126		Region:        region,
127		ServiceID:     ServiceID,
128		SigningName:   "comprehend",
129		OperationName: "StopSentimentDetectionJob",
130	}
131}
132