1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package backup
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/backup/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// This action creates a legal hold on a recovery point (backup). A legal hold is
// a restraint on altering or deleting a backup until an authorized user cancels
// the legal hold. Any actions to delete or disassociate a recovery point will fail
// with an error if one or more active legal holds are on the recovery point.
func (c *Client) CreateLegalHold(ctx context.Context, params *CreateLegalHoldInput, optFns ...func(*Options)) (*CreateLegalHoldOutput, error) {
if params == nil {
params = &CreateLegalHoldInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateLegalHold", params, optFns, c.addOperationCreateLegalHoldMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateLegalHoldOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateLegalHoldInput struct {
// This is the string description of the legal hold.
//
// This member is required.
Description *string
// This is the string title of the legal hold.
//
// This member is required.
Title *string
// This is a user-chosen string used to distinguish between otherwise identical
// calls. Retrying a successful request with the same idempotency token results in
// a success message with no action taken.
IdempotencyToken *string
// This specifies criteria to assign a set of resources, such as resource types or
// backup vaults.
RecoveryPointSelection *types.RecoveryPointSelection
// Optional tags to include. A tag is a key-value pair you can use to manage,
// filter, and search for your resources. Allowed characters include UTF-8 letters,
// numbers, spaces, and the following characters: + - = . _ : /.
Tags map[string]string
noSmithyDocumentSerde
}
type CreateLegalHoldOutput struct {
// Time in number format when legal hold was created.
CreationDate *time.Time
// This is the returned string description of the legal hold.
Description *string
// This is the ARN (Amazon Resource Number) of the created legal hold.
LegalHoldArn *string
// Legal hold ID returned for the specified legal hold on a recovery point.
LegalHoldId *string
// This specifies criteria to assign a set of resources, such as resource types or
// backup vaults.
RecoveryPointSelection *types.RecoveryPointSelection
// This displays the status of the legal hold returned after creating the legal
// hold. Statuses can be ACTIVE , PENDING , CANCELED , CANCELING , or FAILED .
Status types.LegalHoldStatus
// This is the string title of the legal hold returned after creating the legal
// hold.
Title *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateLegalHoldMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateLegalHold{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateLegalHold{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateLegalHold"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateLegalHoldValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateLegalHold(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateLegalHold(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateLegalHold",
}
}
|