1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cloudhsmv2
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/cloudhsmv2/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Modifies attributes for AWS CloudHSM backup.
15func (c *Client) ModifyBackupAttributes(ctx context.Context, params *ModifyBackupAttributesInput, optFns ...func(*Options)) (*ModifyBackupAttributesOutput, error) {
16	if params == nil {
17		params = &ModifyBackupAttributesInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "ModifyBackupAttributes", params, optFns, addOperationModifyBackupAttributesMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*ModifyBackupAttributesOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type ModifyBackupAttributesInput struct {
31
32	// The identifier (ID) of the backup to modify. To find the ID of a backup, use the
33	// DescribeBackups operation.
34	//
35	// This member is required.
36	BackupId *string
37
38	// Specifies whether the service should exempt a backup from the retention policy
39	// for the cluster. True exempts a backup from the retention policy. False means
40	// the service applies the backup retention policy defined at the cluster.
41	//
42	// This member is required.
43	NeverExpires *bool
44}
45
46type ModifyBackupAttributesOutput struct {
47
48	// Contains information about a backup of an AWS CloudHSM cluster. All backup
49	// objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp
50	// parameters. Backups that were copied into a destination region additionally
51	// contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion
52	// parameters. A backup that is pending deletion will include the DeleteTimestamp
53	// parameter.
54	Backup *types.Backup
55
56	// Metadata pertaining to the operation's result.
57	ResultMetadata middleware.Metadata
58}
59
60func addOperationModifyBackupAttributesMiddlewares(stack *middleware.Stack, options Options) (err error) {
61	err = stack.Serialize.Add(&awsAwsjson11_serializeOpModifyBackupAttributes{}, middleware.After)
62	if err != nil {
63		return err
64	}
65	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpModifyBackupAttributes{}, middleware.After)
66	if err != nil {
67		return err
68	}
69	if err = addSetLoggerMiddleware(stack, options); err != nil {
70		return err
71	}
72	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
73		return err
74	}
75	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
76		return err
77	}
78	if err = addResolveEndpointMiddleware(stack, options); err != nil {
79		return err
80	}
81	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
82		return err
83	}
84	if err = addRetryMiddlewares(stack, options); err != nil {
85		return err
86	}
87	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
91		return err
92	}
93	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
94		return err
95	}
96	if err = addClientUserAgent(stack); err != nil {
97		return err
98	}
99	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
100		return err
101	}
102	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
103		return err
104	}
105	if err = addOpModifyBackupAttributesValidationMiddleware(stack); err != nil {
106		return err
107	}
108	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyBackupAttributes(options.Region), middleware.Before); err != nil {
109		return err
110	}
111	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addResponseErrorMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addRequestResponseLogging(stack, options); err != nil {
118		return err
119	}
120	return nil
121}
122
123func newServiceMetadataMiddleware_opModifyBackupAttributes(region string) *awsmiddleware.RegisterServiceMetadata {
124	return &awsmiddleware.RegisterServiceMetadata{
125		Region:        region,
126		ServiceID:     ServiceID,
127		SigningName:   "cloudhsm",
128		OperationName: "ModifyBackupAttributes",
129	}
130}
131