1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package kms
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/smithy-go/middleware"
10	smithyhttp "github.com/aws/smithy-go/transport/http"
11)
12
13// Cancels the deletion of a customer master key (CMK). When this operation
14// succeeds, the key state of the CMK is Disabled. To enable the CMK, use
15// EnableKey. For more information about scheduling and canceling deletion of a
16// CMK, see Deleting Customer Master Keys
17// (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in
18// the AWS Key Management Service Developer Guide. The CMK that you use for this
19// operation must be in a compatible key state. For details, see How Key State
20// Affects Use of a Customer Master Key
21// (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the
22// AWS Key Management Service Developer Guide. Cross-account use: No. You cannot
23// perform this operation on a CMK in a different AWS account. Required
24// permissions: kms:CancelKeyDeletion
25// (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html)
26// (key policy) Related operations: ScheduleKeyDeletion
27func (c *Client) CancelKeyDeletion(ctx context.Context, params *CancelKeyDeletionInput, optFns ...func(*Options)) (*CancelKeyDeletionOutput, error) {
28	if params == nil {
29		params = &CancelKeyDeletionInput{}
30	}
31
32	result, metadata, err := c.invokeOperation(ctx, "CancelKeyDeletion", params, optFns, addOperationCancelKeyDeletionMiddlewares)
33	if err != nil {
34		return nil, err
35	}
36
37	out := result.(*CancelKeyDeletionOutput)
38	out.ResultMetadata = metadata
39	return out, nil
40}
41
42type CancelKeyDeletionInput struct {
43
44	// The unique identifier for the customer master key (CMK) for which to cancel
45	// deletion. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For
46	// example:
47	//
48	// * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
49	//
50	// * Key ARN:
51	// arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
52	//
53	// To
54	// get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
55	//
56	// This member is required.
57	KeyId *string
58}
59
60type CancelKeyDeletionOutput struct {
61
62	// The Amazon Resource Name (key ARN
63	// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
64	// of the CMK whose deletion is canceled.
65	KeyId *string
66
67	// Metadata pertaining to the operation's result.
68	ResultMetadata middleware.Metadata
69}
70
71func addOperationCancelKeyDeletionMiddlewares(stack *middleware.Stack, options Options) (err error) {
72	err = stack.Serialize.Add(&awsAwsjson11_serializeOpCancelKeyDeletion{}, middleware.After)
73	if err != nil {
74		return err
75	}
76	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCancelKeyDeletion{}, middleware.After)
77	if err != nil {
78		return err
79	}
80	if err = addSetLoggerMiddleware(stack, options); err != nil {
81		return err
82	}
83	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
84		return err
85	}
86	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
87		return err
88	}
89	if err = addResolveEndpointMiddleware(stack, options); err != nil {
90		return err
91	}
92	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
93		return err
94	}
95	if err = addRetryMiddlewares(stack, options); err != nil {
96		return err
97	}
98	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
99		return err
100	}
101	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
102		return err
103	}
104	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
105		return err
106	}
107	if err = addClientUserAgent(stack); err != nil {
108		return err
109	}
110	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
111		return err
112	}
113	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
114		return err
115	}
116	if err = addOpCancelKeyDeletionValidationMiddleware(stack); err != nil {
117		return err
118	}
119	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCancelKeyDeletion(options.Region), middleware.Before); err != nil {
120		return err
121	}
122	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
123		return err
124	}
125	if err = addResponseErrorMiddleware(stack); err != nil {
126		return err
127	}
128	if err = addRequestResponseLogging(stack, options); err != nil {
129		return err
130	}
131	return nil
132}
133
134func newServiceMetadataMiddleware_opCancelKeyDeletion(region string) *awsmiddleware.RegisterServiceMetadata {
135	return &awsmiddleware.RegisterServiceMetadata{
136		Region:        region,
137		ServiceID:     ServiceID,
138		SigningName:   "kms",
139		OperationName: "CancelKeyDeletion",
140	}
141}
142