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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package auditmanager
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/auditmanager/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a share request for a custom framework in Audit Manager. The share
// request specifies a recipient and notifies them that a custom framework is
// available. Recipients have 120 days to accept or decline the request. If no
// action is taken, the share request expires. When you create a share request,
// Audit Manager stores a snapshot of your custom framework in the US East (N.
// Virginia) Amazon Web Services Region. Audit Manager also stores a backup of the
// same snapshot in the US West (Oregon) Amazon Web Services Region. Audit Manager
// deletes the snapshot and the backup snapshot when one of the following events
// occurs:
// - The sender revokes the share request.
// - The recipient declines the share request.
// - The recipient encounters an error and doesn't successfully accept the share
// request.
// - The share request expires before the recipient responds to the request.
//
// When a sender resends a share request (https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend)
// , the snapshot is replaced with an updated version that corresponds with the
// latest version of the custom framework. When a recipient accepts a share
// request, the snapshot is replicated into their Amazon Web Services account under
// the Amazon Web Services Region that was specified in the share request. When you
// invoke the StartAssessmentFrameworkShare API, you are about to share a custom
// framework with another Amazon Web Services account. You may not share a custom
// framework that is derived from a standard framework if the standard framework is
// designated as not eligible for sharing by Amazon Web Services, unless you have
// obtained permission to do so from the owner of the standard framework. To learn
// more about which standard frameworks are eligible for sharing, see Framework
// sharing eligibility (https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility)
// in the Audit Manager User Guide.
func (c *Client) StartAssessmentFrameworkShare(ctx context.Context, params *StartAssessmentFrameworkShareInput, optFns ...func(*Options)) (*StartAssessmentFrameworkShareOutput, error) {
if params == nil {
params = &StartAssessmentFrameworkShareInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartAssessmentFrameworkShare", params, optFns, c.addOperationStartAssessmentFrameworkShareMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartAssessmentFrameworkShareOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartAssessmentFrameworkShareInput struct {
// The Amazon Web Services account of the recipient.
//
// This member is required.
DestinationAccount *string
// The Amazon Web Services Region of the recipient.
//
// This member is required.
DestinationRegion *string
// The unique identifier for the custom framework to be shared.
//
// This member is required.
FrameworkId *string
// An optional comment from the sender about the share request.
Comment *string
noSmithyDocumentSerde
}
type StartAssessmentFrameworkShareOutput struct {
// The share request that's created by the StartAssessmentFrameworkShare API.
AssessmentFrameworkShareRequest *types.AssessmentFrameworkShareRequest
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartAssessmentFrameworkShareMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartAssessmentFrameworkShare{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartAssessmentFrameworkShare{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartAssessmentFrameworkShare"); 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 = addOpStartAssessmentFrameworkShareValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartAssessmentFrameworkShare(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_opStartAssessmentFrameworkShare(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartAssessmentFrameworkShare",
}
}
|
