-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_DescribeDBClusterSnapshots.go
199 lines (169 loc) · 6.97 KB
/
api_op_DescribeDBClusterSnapshots.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package docdb
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Represents the input to DescribeDBClusterSnapshots.
type DescribeDBClusterSnapshotsInput struct {
_ struct{} `type:"structure"`
// The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
// This parameter can't be used with the DBClusterSnapshotIdentifier parameter.
// This parameter is not case sensitive.
//
// Constraints:
//
// * If provided, must match the identifier of an existing DBCluster.
DBClusterIdentifier *string `type:"string"`
// A specific DB cluster snapshot identifier to describe. This parameter can't
// be used with the DBClusterIdentifier parameter. This value is stored as a
// lowercase string.
//
// Constraints:
//
// * If provided, must match the identifier of an existing DBClusterSnapshot.
//
// * If this identifier is for an automated snapshot, the SnapshotType parameter
// must also be specified.
DBClusterSnapshotIdentifier *string `type:"string"`
// This parameter is not currently supported.
Filters []Filter `locationNameList:"Filter" type:"list"`
// Set to true to include manual DB cluster snapshots that are public and can
// be copied or restored by any AWS account, and otherwise false. The default
// is false.
IncludePublic *bool `type:"boolean"`
// Set to true to include shared manual DB cluster snapshots from other AWS
// accounts that this AWS account has been given permission to copy or restore,
// and otherwise false. The default is false.
IncludeShared *bool `type:"boolean"`
// An optional pagination token provided by a previous request. If this parameter
// is specified, the response includes only records beyond the marker, up to
// the value specified by MaxRecords.
Marker *string `type:"string"`
// The maximum number of records to include in the response. If more records
// exist than the specified MaxRecords value, a pagination token (marker) is
// included in the response so that the remaining results can be retrieved.
//
// Default: 100
//
// Constraints: Minimum 20, maximum 100.
MaxRecords *int64 `type:"integer"`
// The type of DB cluster snapshots to be returned. You can specify one of the
// following values:
//
// * automated - Return all DB cluster snapshots that Amazon DocumentDB has
// automatically created for your AWS account.
//
// * manual - Return all DB cluster snapshots that you have manually created
// for your AWS account.
//
// * shared - Return all manual DB cluster snapshots that have been shared
// to your AWS account.
//
// * public - Return all DB cluster snapshots that have been marked as public.
//
// If you don't specify a SnapshotType value, then both automated and manual
// DB cluster snapshots are returned. You can include shared DB cluster snapshots
// with these results by setting the IncludeShared parameter to true. You can
// include public DB cluster snapshots with these results by setting the IncludePublic
// parameter to true.
//
// The IncludeShared and IncludePublic parameters don't apply for SnapshotType
// values of manual or automated. The IncludePublic parameter doesn't apply
// when SnapshotType is set to shared. The IncludeShared parameter doesn't apply
// when SnapshotType is set to public.
SnapshotType *string `type:"string"`
}
// String returns the string representation
func (s DescribeDBClusterSnapshotsInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeDBClusterSnapshotsInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeDBClusterSnapshotsInput"}
if s.Filters != nil {
for i, v := range s.Filters {
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(aws.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Represents the output of DescribeDBClusterSnapshots.
type DescribeDBClusterSnapshotsOutput struct {
_ struct{} `type:"structure"`
// Provides a list of DB cluster snapshots.
DBClusterSnapshots []DBClusterSnapshot `locationNameList:"DBClusterSnapshot" type:"list"`
// An optional pagination token provided by a previous request. If this parameter
// is specified, the response includes only records beyond the marker, up to
// the value specified by MaxRecords.
Marker *string `type:"string"`
}
// String returns the string representation
func (s DescribeDBClusterSnapshotsOutput) String() string {
return awsutil.Prettify(s)
}
const opDescribeDBClusterSnapshots = "DescribeDBClusterSnapshots"
// DescribeDBClusterSnapshotsRequest returns a request value for making API operation for
// Amazon DocumentDB with MongoDB compatibility.
//
// Returns information about DB cluster snapshots. This API operation supports
// pagination.
//
// // Example sending a request using DescribeDBClusterSnapshotsRequest.
// req := client.DescribeDBClusterSnapshotsRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshots
func (c *Client) DescribeDBClusterSnapshotsRequest(input *DescribeDBClusterSnapshotsInput) DescribeDBClusterSnapshotsRequest {
op := &aws.Operation{
Name: opDescribeDBClusterSnapshots,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribeDBClusterSnapshotsInput{}
}
req := c.newRequest(op, input, &DescribeDBClusterSnapshotsOutput{})
return DescribeDBClusterSnapshotsRequest{Request: req, Input: input, Copy: c.DescribeDBClusterSnapshotsRequest}
}
// DescribeDBClusterSnapshotsRequest is the request type for the
// DescribeDBClusterSnapshots API operation.
type DescribeDBClusterSnapshotsRequest struct {
*aws.Request
Input *DescribeDBClusterSnapshotsInput
Copy func(*DescribeDBClusterSnapshotsInput) DescribeDBClusterSnapshotsRequest
}
// Send marshals and sends the DescribeDBClusterSnapshots API request.
func (r DescribeDBClusterSnapshotsRequest) Send(ctx context.Context) (*DescribeDBClusterSnapshotsResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &DescribeDBClusterSnapshotsResponse{
DescribeDBClusterSnapshotsOutput: r.Request.Data.(*DescribeDBClusterSnapshotsOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// DescribeDBClusterSnapshotsResponse is the response type for the
// DescribeDBClusterSnapshots API operation.
type DescribeDBClusterSnapshotsResponse struct {
*DescribeDBClusterSnapshotsOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// DescribeDBClusterSnapshots request.
func (r *DescribeDBClusterSnapshotsResponse) SDKResponseMetdata() *aws.Response {
return r.response
}