1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package ecs
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/ecs/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Runs a command remotely on a container within a task.
15func (c *Client) ExecuteCommand(ctx context.Context, params *ExecuteCommandInput, optFns ...func(*Options)) (*ExecuteCommandOutput, error) {
16	if params == nil {
17		params = &ExecuteCommandInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "ExecuteCommand", params, optFns, addOperationExecuteCommandMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*ExecuteCommandOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type ExecuteCommandInput struct {
31
32	// The command to run on the container.
33	//
34	// This member is required.
35	Command *string
36
37	// Use this flag to run your command in interactive mode.
38	//
39	// This member is required.
40	Interactive bool
41
42	// The Amazon Resource Name (ARN) or ID of the task the container is part of.
43	//
44	// This member is required.
45	Task *string
46
47	// The Amazon Resource Name (ARN) or short name of the cluster the task is running
48	// in. If you do not specify a cluster, the default cluster is assumed.
49	Cluster *string
50
51	// The name of the container to execute the command on. A container name only needs
52	// to be specified for tasks containing multiple containers.
53	Container *string
54}
55
56type ExecuteCommandOutput struct {
57
58	// The Amazon Resource Name (ARN) of the cluster.
59	ClusterArn *string
60
61	// The Amazon Resource Name (ARN) of the container.
62	ContainerArn *string
63
64	// The name of the container.
65	ContainerName *string
66
67	// Whether or not the execute command session is running in interactive mode.
68	Interactive bool
69
70	// The details of the SSM session that was created for this instance of
71	// execute-command.
72	Session *types.Session
73
74	// The Amazon Resource Name (ARN) of the task.
75	TaskArn *string
76
77	// Metadata pertaining to the operation's result.
78	ResultMetadata middleware.Metadata
79}
80
81func addOperationExecuteCommandMiddlewares(stack *middleware.Stack, options Options) (err error) {
82	err = stack.Serialize.Add(&awsAwsjson11_serializeOpExecuteCommand{}, middleware.After)
83	if err != nil {
84		return err
85	}
86	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpExecuteCommand{}, middleware.After)
87	if err != nil {
88		return err
89	}
90	if err = addSetLoggerMiddleware(stack, options); err != nil {
91		return err
92	}
93	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
94		return err
95	}
96	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
97		return err
98	}
99	if err = addResolveEndpointMiddleware(stack, options); err != nil {
100		return err
101	}
102	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
103		return err
104	}
105	if err = addRetryMiddlewares(stack, options); err != nil {
106		return err
107	}
108	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
112		return err
113	}
114	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
115		return err
116	}
117	if err = addClientUserAgent(stack); err != nil {
118		return err
119	}
120	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
121		return err
122	}
123	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addOpExecuteCommandValidationMiddleware(stack); err != nil {
127		return err
128	}
129	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opExecuteCommand(options.Region), middleware.Before); err != nil {
130		return err
131	}
132	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addResponseErrorMiddleware(stack); err != nil {
136		return err
137	}
138	if err = addRequestResponseLogging(stack, options); err != nil {
139		return err
140	}
141	return nil
142}
143
144func newServiceMetadataMiddleware_opExecuteCommand(region string) *awsmiddleware.RegisterServiceMetadata {
145	return &awsmiddleware.RegisterServiceMetadata{
146		Region:        region,
147		ServiceID:     ServiceID,
148		SigningName:   "ecs",
149		OperationName: "ExecuteCommand",
150	}
151}
152