1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package translate
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/translate/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Stops an asynchronous batch translation job that is in progress. If the job's
15// state is IN_PROGRESS, the job will be marked for termination and put into the
16// STOP_REQUESTED state. If the job completes before it can be stopped, it is put
17// into the COMPLETED state. Otherwise, the job is put into the STOPPED state.
18// Asynchronous batch translation jobs are started with the StartTextTranslationJob
19// operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs
20// operations to get a batch translation job's JobId.
21func (c *Client) StopTextTranslationJob(ctx context.Context, params *StopTextTranslationJobInput, optFns ...func(*Options)) (*StopTextTranslationJobOutput, error) {
22	if params == nil {
23		params = &StopTextTranslationJobInput{}
24	}
25
26	result, metadata, err := c.invokeOperation(ctx, "StopTextTranslationJob", params, optFns, addOperationStopTextTranslationJobMiddlewares)
27	if err != nil {
28		return nil, err
29	}
30
31	out := result.(*StopTextTranslationJobOutput)
32	out.ResultMetadata = metadata
33	return out, nil
34}
35
36type StopTextTranslationJobInput struct {
37
38	// The job ID of the job to be stopped.
39	//
40	// This member is required.
41	JobId *string
42}
43
44type StopTextTranslationJobOutput struct {
45
46	// The job ID of the stopped batch translation job.
47	JobId *string
48
49	// The status of the designated job. Upon successful completion, the job's status
50	// will be STOPPED.
51	JobStatus types.JobStatus
52
53	// Metadata pertaining to the operation's result.
54	ResultMetadata middleware.Metadata
55}
56
57func addOperationStopTextTranslationJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
58	err = stack.Serialize.Add(&awsAwsjson11_serializeOpStopTextTranslationJob{}, middleware.After)
59	if err != nil {
60		return err
61	}
62	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpStopTextTranslationJob{}, middleware.After)
63	if err != nil {
64		return err
65	}
66	if err = addSetLoggerMiddleware(stack, options); err != nil {
67		return err
68	}
69	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
70		return err
71	}
72	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
73		return err
74	}
75	if err = addResolveEndpointMiddleware(stack, options); err != nil {
76		return err
77	}
78	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
79		return err
80	}
81	if err = addRetryMiddlewares(stack, options); err != nil {
82		return err
83	}
84	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
85		return err
86	}
87	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
91		return err
92	}
93	if err = addClientUserAgent(stack); err != nil {
94		return err
95	}
96	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
97		return err
98	}
99	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
100		return err
101	}
102	if err = addOpStopTextTranslationJobValidationMiddleware(stack); err != nil {
103		return err
104	}
105	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStopTextTranslationJob(options.Region), middleware.Before); err != nil {
106		return err
107	}
108	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
109		return err
110	}
111	if err = addResponseErrorMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addRequestResponseLogging(stack, options); err != nil {
115		return err
116	}
117	return nil
118}
119
120func newServiceMetadataMiddleware_opStopTextTranslationJob(region string) *awsmiddleware.RegisterServiceMetadata {
121	return &awsmiddleware.RegisterServiceMetadata{
122		Region:        region,
123		ServiceID:     ServiceID,
124		SigningName:   "translate",
125		OperationName: "StopTextTranslationJob",
126	}
127}
128