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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package memorydb
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/memorydb/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns information about cluster snapshots. By default, DescribeSnapshots lists
// all of your snapshots; it can optionally describe a single snapshot, or just the
// snapshots associated with a particular cluster.
func (c *Client) DescribeSnapshots(ctx context.Context, params *DescribeSnapshotsInput, optFns ...func(*Options)) (*DescribeSnapshotsOutput, error) {
if params == nil {
params = &DescribeSnapshotsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeSnapshots", params, optFns, c.addOperationDescribeSnapshotsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeSnapshotsOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeSnapshotsInput struct {
// A user-supplied cluster identifier. If this parameter is specified, only
// snapshots associated with that specific cluster are described.
ClusterName *string
// The maximum number of records to include in the response. If more records exist
// than the specified MaxResults value, a token is included in the response so that
// the remaining results can be retrieved.
MaxResults *int32
// An optional argument to pass in case the total number of records exceeds the
// value of MaxResults. If nextToken is returned, there are more results available.
// The value of nextToken is a unique pagination token for each page. Make the call
// again using the returned token to retrieve the next page. Keep all other
// arguments unchanged.
NextToken *string
// A Boolean value which if true, the shard configuration is included in the
// snapshot description.
ShowDetail *bool
// A user-supplied name of the snapshot. If this parameter is specified, only this
// named snapshot is described.
SnapshotName *string
// If set to system, the output shows snapshots that were automatically created by
// MemoryDB. If set to user the output shows snapshots that were manually created.
// If omitted, the output shows both automatically and manually created snapshots.
Source *string
noSmithyDocumentSerde
}
type DescribeSnapshotsOutput struct {
// An optional argument to pass in case the total number of records exceeds the
// value of MaxResults. If nextToken is returned, there are more results available.
// The value of nextToken is a unique pagination token for each page. Make the call
// again using the returned token to retrieve the next page. Keep all other
// arguments unchanged.
NextToken *string
// A list of snapshots. Each item in the list contains detailed information about
// one snapshot.
Snapshots []types.Snapshot
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeSnapshotsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeSnapshots{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeSnapshots{}, middleware.After)
if 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.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeSnapshots(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opDescribeSnapshots(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "memorydb",
OperationName: "DescribeSnapshots",
}
}
|