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
188
189
190
191
192
193
194
195
196
197
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package ebs
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/ebs/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"io"
)
// Writes a block of data to a snapshot. If the specified block contains data, the
// existing data is overwritten. The target snapshot must be in the pending state.
// Data written to a snapshot must be aligned with 512-KiB sectors. You should
// always retry requests that receive server ( 5xx ) error responses, and
// ThrottlingException and RequestThrottledException client error responses. For
// more information see Error retries (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/error-retries.html)
// in the Amazon Elastic Compute Cloud User Guide.
func (c *Client) PutSnapshotBlock(ctx context.Context, params *PutSnapshotBlockInput, optFns ...func(*Options)) (*PutSnapshotBlockOutput, error) {
if params == nil {
params = &PutSnapshotBlockInput{}
}
result, metadata, err := c.invokeOperation(ctx, "PutSnapshotBlock", params, optFns, c.addOperationPutSnapshotBlockMiddlewares)
if err != nil {
return nil, err
}
out := result.(*PutSnapshotBlockOutput)
out.ResultMetadata = metadata
return out, nil
}
type PutSnapshotBlockInput struct {
// The data to write to the block. The block data is not signed as part of the
// Signature Version 4 signing process. As a result, you must generate and provide
// a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum
// header. Also, you must specify the checksum algorithm using the
// x-amz-Checksum-Algorithm header. The checksum that you provide is part of the
// Signature Version 4 signing process. It is validated against a checksum
// generated by Amazon EBS to ensure the validity and authenticity of the data. If
// the checksums do not correspond, the request fails. For more information, see
// Using checksums with the EBS direct APIs (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums)
// in the Amazon Elastic Compute Cloud User Guide.
//
// This member is required.
BlockData io.Reader
// The block index of the block in which to write the data. A block index is a
// logical index in units of 512 KiB blocks. To identify the block index, divide
// the logical offset of the data in the logical volume by the block size (logical
// offset of data/ 524288 ). The logical offset of the data must be 512 KiB
// aligned.
//
// This member is required.
BlockIndex *int32
// A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are
// supported.
//
// This member is required.
Checksum *string
// The algorithm used to generate the checksum. Currently, the only supported
// algorithm is SHA256 .
//
// This member is required.
ChecksumAlgorithm types.ChecksumAlgorithm
// The size of the data to write to the block, in bytes. Currently, the only
// supported size is 524288 bytes. Valid values: 524288
//
// This member is required.
DataLength *int32
// The ID of the snapshot. If the specified snapshot is encrypted, you must have
// permission to use the KMS key that was used to encrypt the snapshot. For more
// information, see Using encryption (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html)
// in the Amazon Elastic Compute Cloud User Guide..
//
// This member is required.
SnapshotId *string
// The progress of the write process, as a percentage.
Progress *int32
noSmithyDocumentSerde
}
type PutSnapshotBlockOutput struct {
// The SHA256 checksum generated for the block data by Amazon EBS.
Checksum *string
// The algorithm used by Amazon EBS to generate the checksum.
ChecksumAlgorithm types.ChecksumAlgorithm
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationPutSnapshotBlockMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpPutSnapshotBlock{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpPutSnapshotBlock{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "PutSnapshotBlock"); 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.AddUnsignedPayloadMiddleware(stack); err != nil {
return err
}
if err = v4.AddContentSHA256HeaderMiddleware(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 = addOpPutSnapshotBlockValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutSnapshotBlock(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_opPutSnapshotBlock(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "PutSnapshotBlock",
}
}
|
