1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package codepipeline
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/codepipeline/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Represents the success of a job as returned to the pipeline by a job worker.
15// Used for custom actions only.
16func (c *Client) PutJobSuccessResult(ctx context.Context, params *PutJobSuccessResultInput, optFns ...func(*Options)) (*PutJobSuccessResultOutput, error) {
17	if params == nil {
18		params = &PutJobSuccessResultInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "PutJobSuccessResult", params, optFns, c.addOperationPutJobSuccessResultMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*PutJobSuccessResultOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31// Represents the input of a PutJobSuccessResult action.
32type PutJobSuccessResultInput struct {
33
34	// The unique system-generated ID of the job that succeeded. This is the same ID
35	// returned from PollForJobs.
36	//
37	// This member is required.
38	JobId *string
39
40	// A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that
41	// a successful job provides to identify a custom action in progress. Future jobs
42	// use this token to identify the running instance of the action. It can be reused
43	// to return more information about the progress of the custom action. When the
44	// action is complete, no continuation token should be supplied.
45	ContinuationToken *string
46
47	// The ID of the current revision of the artifact successfully worked on by the
48	// job.
49	CurrentRevision *types.CurrentRevision
50
51	// The execution details of the successful job, such as the actions taken by the
52	// job worker.
53	ExecutionDetails *types.ExecutionDetails
54
55	// Key-value pairs produced as output by a job worker that can be made available to
56	// a downstream action configuration. outputVariables can be included only when
57	// there is no continuation token on the request.
58	OutputVariables map[string]string
59
60	noSmithyDocumentSerde
61}
62
63type PutJobSuccessResultOutput struct {
64	// Metadata pertaining to the operation's result.
65	ResultMetadata middleware.Metadata
66
67	noSmithyDocumentSerde
68}
69
70func (c *Client) addOperationPutJobSuccessResultMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpPutJobSuccessResult{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpPutJobSuccessResult{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addOpPutJobSuccessResultValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutJobSuccessResult(options.Region), middleware.Before); err != nil {
119		return err
120	}
121	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addResponseErrorMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addRequestResponseLogging(stack, options); err != nil {
128		return err
129	}
130	return nil
131}
132
133func newServiceMetadataMiddleware_opPutJobSuccessResult(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "codepipeline",
138		OperationName: "PutJobSuccessResult",
139	}
140}
141