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
182
183
184
185
186
187
|
// 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/service/backup/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Returns the framework details for the specified FrameworkName .
func (c *Client) DescribeFramework(ctx context.Context, params *DescribeFrameworkInput, optFns ...func(*Options)) (*DescribeFrameworkOutput, error) {
if params == nil {
params = &DescribeFrameworkInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeFramework", params, optFns, c.addOperationDescribeFrameworkMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeFrameworkOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeFrameworkInput struct {
// The unique name of a framework.
//
// This member is required.
FrameworkName *string
noSmithyDocumentSerde
}
type DescribeFrameworkOutput struct {
// The date and time that a framework is created, in ISO 8601 representation. The
// value of CreationTime is accurate to milliseconds. For example,
// 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8
// hours behind UTC.
CreationTime *time.Time
// The deployment status of a framework. The statuses are:
//
// CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |
// FAILED
DeploymentStatus *string
// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
// of the ARN depends on the resource type.
FrameworkArn *string
// A list of the controls that make up the framework. Each control in the list has
// a name, input parameters, and scope.
FrameworkControls []types.FrameworkControl
// An optional description of the framework.
FrameworkDescription *string
// The unique name of a framework.
FrameworkName *string
// A framework consists of one or more controls. Each control governs a resource,
// such as backup plans, backup selections, backup vaults, or recovery points. You
// can also turn Config recording on or off for each resource. The statuses are:
//
// - ACTIVE when recording is turned on for all resources governed by the
// framework.
//
// - PARTIALLY_ACTIVE when recording is turned off for at least one resource
// governed by the framework.
//
// - INACTIVE when recording is turned off for all resources governed by the
// framework.
//
// - UNAVAILABLE when Backup is unable to validate recording status at this time.
FrameworkStatus *string
// A customer-chosen string that you can use to distinguish between otherwise
// identical calls to DescribeFrameworkOutput . Retrying a successful request with
// the same idempotency token results in a success message with no action taken.
IdempotencyToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeFrameworkMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeFramework{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeFramework{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeFramework"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpDescribeFrameworkValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeFramework(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opDescribeFramework(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeFramework",
}
}
|
