/
api_op_DescribeClusterSnapshots.go
177 lines (153 loc) · 7.67 KB
/
api_op_DescribeClusterSnapshots.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package redshift
import (
"context"
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/redshift/types"
"github.com/awslabs/smithy-go/middleware"
smithyhttp "github.com/awslabs/smithy-go/transport/http"
"time"
)
// Returns one or more snapshot objects, which contain metadata about your cluster
// snapshots. By default, this operation returns information about all snapshots of
// all clusters that are owned by you AWS customer account. No information is
// returned for snapshots owned by inactive AWS customer accounts. If you specify
// both tag keys and tag values in the same request, Amazon Redshift returns all
// snapshots that match any combination of the specified keys and values. For
// example, if you have owner and environment for tag keys, and admin and test for
// tag values, all snapshots that have any combination of those values are
// returned. Only snapshots that you own are returned in the response; shared
// snapshots are not returned with the tag key and tag value request parameters. If
// both tag keys and values are omitted from the request, snapshots are returned
// regardless of whether they have tag keys or values associated with them.
func (c *Client) DescribeClusterSnapshots(ctx context.Context, params *DescribeClusterSnapshotsInput, optFns ...func(*Options)) (*DescribeClusterSnapshotsOutput, error) {
if params == nil {
params = &DescribeClusterSnapshotsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeClusterSnapshots", params, optFns, addOperationDescribeClusterSnapshotsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeClusterSnapshotsOutput)
out.ResultMetadata = metadata
return out, nil
}
//
type DescribeClusterSnapshotsInput struct {
// A value that indicates whether to return snapshots only for an existing cluster.
// You can perform table-level restore only by using a snapshot of an existing
// cluster, that is, a cluster that has not been deleted. Values for this parameter
// work as follows:
//
// * If ClusterExists is set to true, ClusterIdentifier is
// required.
//
// * If ClusterExists is set to false and ClusterIdentifier isn't
// specified, all snapshots associated with deleted clusters (orphaned snapshots)
// are returned.
//
// * If ClusterExists is set to false and ClusterIdentifier is
// specified for a deleted cluster, snapshots associated with that cluster are
// returned.
//
// * If ClusterExists is set to false and ClusterIdentifier is specified
// for an existing cluster, no snapshots are returned.
ClusterExists *bool
// The identifier of the cluster which generated the requested snapshots.
ClusterIdentifier *string
// A time value that requests only snapshots created at or before the specified
// time. The time value is specified in ISO 8601 format. For more information about
// ISO 8601, go to the ISO8601 Wikipedia page.
// (http://en.wikipedia.org/wiki/ISO_8601) Example: 2012-07-16T18:00:00Z
EndTime *time.Time
// An optional parameter that specifies the starting point to return a set of
// response records. When the results of a DescribeClusterSnapshots request exceed
// the value specified in MaxRecords, AWS returns a value in the Marker field of
// the response. You can retrieve the next set of response records by providing the
// returned marker value in the Marker parameter and retrying the request.
Marker *string
// The maximum number of response records to return in each call. If the number of
// remaining response records exceeds the specified MaxRecords value, a value is
// returned in a marker field of the response. You can retrieve the next set of
// records by retrying the command with the returned marker value. Default: 100
// Constraints: minimum 20, maximum 100.
MaxRecords *int32
// The AWS customer account used to create or copy the snapshot. Use this field to
// filter the results to snapshots owned by a particular account. To describe
// snapshots you own, either specify your AWS customer account, or do not specify
// the parameter.
OwnerAccount *string
// The snapshot identifier of the snapshot about which to return information.
SnapshotIdentifier *string
// The type of snapshots for which you are requesting information. By default,
// snapshots of all types are returned. Valid Values: automated | manual
SnapshotType *string
//
SortingEntities []*types.SnapshotSortingEntity
// A value that requests only snapshots created at or after the specified time. The
// time value is specified in ISO 8601 format. For more information about ISO 8601,
// go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)
// Example: 2012-07-16T18:00:00Z
StartTime *time.Time
// A tag key or keys for which you want to return all matching cluster snapshots
// that are associated with the specified key or keys. For example, suppose that
// you have snapshots that are tagged with keys called owner and environment. If
// you specify both of these tag keys in the request, Amazon Redshift returns a
// response with the snapshots that have either or both of these tag keys
// associated with them.
TagKeys []*string
// A tag value or values for which you want to return all matching cluster
// snapshots that are associated with the specified tag value or values. For
// example, suppose that you have snapshots that are tagged with values called
// admin and test. If you specify both of these tag values in the request, Amazon
// Redshift returns a response with the snapshots that have either or both of these
// tag values associated with them.
TagValues []*string
}
// Contains the output from the DescribeClusterSnapshots action.
type DescribeClusterSnapshotsOutput struct {
// A value that indicates the starting point for the next set of response records
// in a subsequent request. If a value is returned in a response, you can retrieve
// the next set of records by providing this returned marker value in the Marker
// parameter and retrying the command. If the Marker field is empty, all response
// records have been retrieved for the request.
Marker *string
// A list of Snapshot instances.
Snapshots []*types.Snapshot
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
}
func addOperationDescribeClusterSnapshotsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeClusterSnapshots{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeClusterSnapshots{}, middleware.After)
if err != nil {
return err
}
awsmiddleware.AddRequestInvocationIDMiddleware(stack)
smithyhttp.AddContentLengthMiddleware(stack)
addResolveEndpointMiddleware(stack, options)
v4.AddComputePayloadSHA256Middleware(stack)
addRetryMiddlewares(stack, options)
addHTTPSignerV4Middleware(stack, options)
awsmiddleware.AddAttemptClockSkewMiddleware(stack)
addClientUserAgent(stack)
smithyhttp.AddErrorCloseResponseBodyMiddleware(stack)
smithyhttp.AddCloseResponseBodyMiddleware(stack)
addOpDescribeClusterSnapshotsValidationMiddleware(stack)
stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeClusterSnapshots(options.Region), middleware.Before)
addRequestIDRetrieverMiddleware(stack)
addResponseErrorMiddleware(stack)
return nil
}
func newServiceMetadataMiddleware_opDescribeClusterSnapshots(region string) awsmiddleware.RegisterServiceMetadata {
return awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "redshift",
OperationName: "DescribeClusterSnapshots",
}
}