-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_DescribeVault.go
233 lines (192 loc) · 8.13 KB
/
api_op_DescribeVault.go
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package glacier
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
// Provides options for retrieving metadata for a specific vault in Amazon Glacier.
type DescribeVaultInput struct {
_ struct{} `type:"structure"`
// The AccountId value is the AWS account ID of the account that owns the vault.
// You can either specify an AWS account ID or optionally a single '-' (hyphen),
// in which case Amazon S3 Glacier uses the AWS account ID associated with the
// credentials used to sign the request. If you use an account ID, do not include
// any hyphens ('-') in the ID.
//
// AccountId is a required field
AccountId *string `location:"uri" locationName:"accountId" type:"string" required:"true"`
// The name of the vault.
//
// VaultName is a required field
VaultName *string `location:"uri" locationName:"vaultName" type:"string" required:"true"`
}
// String returns the string representation
func (s DescribeVaultInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeVaultInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeVaultInput"}
if s.AccountId == nil {
invalidParams.Add(aws.NewErrParamRequired("AccountId"))
}
if s.VaultName == nil {
invalidParams.Add(aws.NewErrParamRequired("VaultName"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DescribeVaultInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.AccountId != nil {
v := *s.AccountId
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "accountId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.VaultName != nil {
v := *s.VaultName
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "vaultName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// Contains the Amazon S3 Glacier response to your request.
type DescribeVaultOutput struct {
_ struct{} `type:"structure"`
// The Universal Coordinated Time (UTC) date when the vault was created. This
// value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.
CreationDate *string `type:"string"`
// The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed
// the last vault inventory. This value should be a string in the ISO 8601 date
// format, for example 2012-03-20T17:03:43.221Z.
LastInventoryDate *string `type:"string"`
// The number of archives in the vault as of the last inventory date. This field
// will return null if an inventory has not yet run on the vault, for example
// if you just created the vault.
NumberOfArchives *int64 `type:"long"`
// Total size, in bytes, of the archives in the vault as of the last inventory
// date. This field will return null if an inventory has not yet run on the
// vault, for example if you just created the vault.
SizeInBytes *int64 `type:"long"`
// The Amazon Resource Name (ARN) of the vault.
VaultARN *string `type:"string"`
// The name of the vault.
VaultName *string `type:"string"`
}
// String returns the string representation
func (s DescribeVaultOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s DescribeVaultOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.CreationDate != nil {
v := *s.CreationDate
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "CreationDate", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.LastInventoryDate != nil {
v := *s.LastInventoryDate
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "LastInventoryDate", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.NumberOfArchives != nil {
v := *s.NumberOfArchives
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "NumberOfArchives", protocol.Int64Value(v), metadata)
}
if s.SizeInBytes != nil {
v := *s.SizeInBytes
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "SizeInBytes", protocol.Int64Value(v), metadata)
}
if s.VaultARN != nil {
v := *s.VaultARN
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "VaultARN", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if s.VaultName != nil {
v := *s.VaultName
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "VaultName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
const opDescribeVault = "DescribeVault"
// DescribeVaultRequest returns a request value for making API operation for
// Amazon Glacier.
//
// This operation returns information about a vault, including the vault's Amazon
// Resource Name (ARN), the date the vault was created, the number of archives
// it contains, and the total size of all the archives in the vault. The number
// of archives and their total size are as of the last inventory generation.
// This means that if you add or remove an archive from a vault, and then immediately
// use Describe Vault, the change in contents will not be immediately reflected.
// If you want to retrieve the latest inventory of the vault, use InitiateJob.
// Amazon S3 Glacier generates vault inventories approximately daily. For more
// information, see Downloading a Vault Inventory in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html).
//
// An AWS account has full permission to perform all operations (actions). However,
// AWS Identity and Access Management (IAM) users don't have any permissions
// by default. You must grant them explicit permission to perform specific actions.
// For more information, see Access Control Using AWS Identity and Access Management
// (IAM) (https://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html).
//
// For conceptual information and underlying REST API, see Retrieving Vault
// Metadata in Amazon S3 Glacier (https://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html)
// and Describe Vault (https://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html)
// in the Amazon Glacier Developer Guide.
//
// // Example sending a request using DescribeVaultRequest.
// req := client.DescribeVaultRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
func (c *Client) DescribeVaultRequest(input *DescribeVaultInput) DescribeVaultRequest {
op := &aws.Operation{
Name: opDescribeVault,
HTTPMethod: "GET",
HTTPPath: "/{accountId}/vaults/{vaultName}",
}
if input == nil {
input = &DescribeVaultInput{}
}
req := c.newRequest(op, input, &DescribeVaultOutput{})
return DescribeVaultRequest{Request: req, Input: input, Copy: c.DescribeVaultRequest}
}
// DescribeVaultRequest is the request type for the
// DescribeVault API operation.
type DescribeVaultRequest struct {
*aws.Request
Input *DescribeVaultInput
Copy func(*DescribeVaultInput) DescribeVaultRequest
}
// Send marshals and sends the DescribeVault API request.
func (r DescribeVaultRequest) Send(ctx context.Context) (*DescribeVaultResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &DescribeVaultResponse{
DescribeVaultOutput: r.Request.Data.(*DescribeVaultOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// DescribeVaultResponse is the response type for the
// DescribeVault API operation.
type DescribeVaultResponse struct {
*DescribeVaultOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// DescribeVault request.
func (r *DescribeVaultResponse) SDKResponseMetdata() *aws.Response {
return r.response
}