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// Deregisters an Amazon ECS container instance from the specified cluster. This
15// instance is no longer available to run tasks. If you intend to use the container
16// instance for some other purpose after deregistration, you should stop all of the
17// tasks running on the container instance before deregistration. That prevents any
18// orphaned tasks from consuming resources. Deregistering a container instance
19// removes the instance from a cluster, but it does not terminate the EC2 instance.
20// If you are finished using the instance, be sure to terminate it in the Amazon
21// EC2 console to stop billing. If you terminate a running container instance,
22// Amazon ECS automatically deregisters the instance from your cluster (stopped
23// container instances or instances with disconnected agents are not automatically
24// deregistered when terminated).
25func (c *Client) DeregisterContainerInstance(ctx context.Context, params *DeregisterContainerInstanceInput, optFns ...func(*Options)) (*DeregisterContainerInstanceOutput, error) {
26	if params == nil {
27		params = &DeregisterContainerInstanceInput{}
28	}
29
30	result, metadata, err := c.invokeOperation(ctx, "DeregisterContainerInstance", params, optFns, addOperationDeregisterContainerInstanceMiddlewares)
31	if err != nil {
32		return nil, err
33	}
34
35	out := result.(*DeregisterContainerInstanceOutput)
36	out.ResultMetadata = metadata
37	return out, nil
38}
39
40type DeregisterContainerInstanceInput struct {
41
42	// The container instance ID or full ARN of the container instance to deregister.
43	// The ARN contains the arn:aws:ecs namespace, followed by the Region of the
44	// container instance, the AWS account ID of the container instance owner, the
45	// container-instance namespace, and then the container instance ID. For example,
46	// arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
47	//
48	// This member is required.
49	ContainerInstance *string
50
51	// The short name or full Amazon Resource Name (ARN) of the cluster that hosts the
52	// container instance to deregister. If you do not specify a cluster, the default
53	// cluster is assumed.
54	Cluster *string
55
56	// Forces the deregistration of the container instance. If you have tasks running
57	// on the container instance when you deregister it with the force option, these
58	// tasks remain running until you terminate the instance or the tasks stop through
59	// some other means, but they are orphaned (no longer monitored or accounted for by
60	// Amazon ECS). If an orphaned task on your container instance is part of an Amazon
61	// ECS service, then the service scheduler starts another copy of that task, on a
62	// different container instance if possible. Any containers in orphaned service
63	// tasks that are registered with a Classic Load Balancer or an Application Load
64	// Balancer target group are deregistered. They begin connection draining according
65	// to the settings on the load balancer or target group.
66	Force *bool
67}
68
69type DeregisterContainerInstanceOutput struct {
70
71	// The container instance that was deregistered.
72	ContainerInstance *types.ContainerInstance
73
74	// Metadata pertaining to the operation's result.
75	ResultMetadata middleware.Metadata
76}
77
78func addOperationDeregisterContainerInstanceMiddlewares(stack *middleware.Stack, options Options) (err error) {
79	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeregisterContainerInstance{}, middleware.After)
80	if err != nil {
81		return err
82	}
83	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeregisterContainerInstance{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	if err = addSetLoggerMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
91		return err
92	}
93	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
94		return err
95	}
96	if err = addResolveEndpointMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
100		return err
101	}
102	if err = addRetryMiddlewares(stack, options); err != nil {
103		return err
104	}
105	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
112		return err
113	}
114	if err = addClientUserAgent(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addOpDeregisterContainerInstanceValidationMiddleware(stack); err != nil {
124		return err
125	}
126	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeregisterContainerInstance(options.Region), middleware.Before); err != nil {
127		return err
128	}
129	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addResponseErrorMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addRequestResponseLogging(stack, options); err != nil {
136		return err
137	}
138	return nil
139}
140
141func newServiceMetadataMiddleware_opDeregisterContainerInstance(region string) *awsmiddleware.RegisterServiceMetadata {
142	return &awsmiddleware.RegisterServiceMetadata{
143		Region:        region,
144		ServiceID:     ServiceID,
145		SigningName:   "ecs",
146		OperationName: "DeregisterContainerInstance",
147	}
148}
149