1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package storagegateway
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/storagegateway/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Describes the snapshot schedule for the specified gateway volume. The snapshot
15// schedule information includes intervals at which snapshots are automatically
16// initiated on the volume. This operation is only supported in the cached volume
17// and stored volume types.
18func (c *Client) DescribeSnapshotSchedule(ctx context.Context, params *DescribeSnapshotScheduleInput, optFns ...func(*Options)) (*DescribeSnapshotScheduleOutput, error) {
19	if params == nil {
20		params = &DescribeSnapshotScheduleInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "DescribeSnapshotSchedule", params, optFns, addOperationDescribeSnapshotScheduleMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*DescribeSnapshotScheduleOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33// A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the
34// volume.
35type DescribeSnapshotScheduleInput struct {
36
37	// The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to
38	// return a list of gateway volumes.
39	//
40	// This member is required.
41	VolumeARN *string
42}
43
44type DescribeSnapshotScheduleOutput struct {
45
46	// The snapshot description.
47	Description *string
48
49	// The number of hours between snapshots.
50	RecurrenceInHours *int32
51
52	// The hour of the day at which the snapshot schedule begins represented as hh,
53	// where hh is the hour (0 to 23). The hour of the day is in the time zone of the
54	// gateway.
55	StartAt *int32
56
57	// A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically
58	// by key name. Each tag is a key-value pair. For a gateway with more than 10 tags
59	// assigned, you can view all tags using the ListTagsForResource API operation.
60	Tags []types.Tag
61
62	// A value that indicates the time zone of the gateway.
63	Timezone *string
64
65	// The Amazon Resource Name (ARN) of the volume that was specified in the request.
66	VolumeARN *string
67
68	// Metadata pertaining to the operation's result.
69	ResultMetadata middleware.Metadata
70}
71
72func addOperationDescribeSnapshotScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
73	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeSnapshotSchedule{}, middleware.After)
74	if err != nil {
75		return err
76	}
77	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeSnapshotSchedule{}, middleware.After)
78	if err != nil {
79		return err
80	}
81	if err = addSetLoggerMiddleware(stack, options); err != nil {
82		return err
83	}
84	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
85		return err
86	}
87	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
88		return err
89	}
90	if err = addResolveEndpointMiddleware(stack, options); err != nil {
91		return err
92	}
93	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
94		return err
95	}
96	if err = addRetryMiddlewares(stack, options); err != nil {
97		return err
98	}
99	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
106		return err
107	}
108	if err = addClientUserAgent(stack); err != nil {
109		return err
110	}
111	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addOpDescribeSnapshotScheduleValidationMiddleware(stack); err != nil {
118		return err
119	}
120	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeSnapshotSchedule(options.Region), middleware.Before); err != nil {
121		return err
122	}
123	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addResponseErrorMiddleware(stack); err != nil {
127		return err
128	}
129	if err = addRequestResponseLogging(stack, options); err != nil {
130		return err
131	}
132	return nil
133}
134
135func newServiceMetadataMiddleware_opDescribeSnapshotSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
136	return &awsmiddleware.RegisterServiceMetadata{
137		Region:        region,
138		ServiceID:     ServiceID,
139		SigningName:   "storagegateway",
140		OperationName: "DescribeSnapshotSchedule",
141	}
142}
143