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// Returns information about the bandwidth rate limit schedule of a gateway. By
15// default, gateways do not have bandwidth rate limit schedules, which means no
16// bandwidth rate limiting is in effect. This operation is supported only in the
17// volume and tape gateway types. This operation returns information about a
18// gateway's bandwidth rate limit schedule. A bandwidth rate limit schedule
19// consists of one or more bandwidth rate limit intervals. A bandwidth rate limit
20// interval defines a period of time on one or more days of the week, during which
21// bandwidth rate limits are specified for uploading, downloading, or both. A
22// bandwidth rate limit interval consists of one or more days of the week, a start
23// hour and minute, an ending hour and minute, and bandwidth rate limits for
24// uploading and downloading If no bandwidth rate limit schedule intervals are set
25// for the gateway, this operation returns an empty response. To specify which
26// gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your
27// request.
28func (c *Client) DescribeBandwidthRateLimitSchedule(ctx context.Context, params *DescribeBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*DescribeBandwidthRateLimitScheduleOutput, error) {
29	if params == nil {
30		params = &DescribeBandwidthRateLimitScheduleInput{}
31	}
32
33	result, metadata, err := c.invokeOperation(ctx, "DescribeBandwidthRateLimitSchedule", params, optFns, addOperationDescribeBandwidthRateLimitScheduleMiddlewares)
34	if err != nil {
35		return nil, err
36	}
37
38	out := result.(*DescribeBandwidthRateLimitScheduleOutput)
39	out.ResultMetadata = metadata
40	return out, nil
41}
42
43type DescribeBandwidthRateLimitScheduleInput struct {
44
45	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to
46	// return a list of gateways for your account and AWS Region.
47	//
48	// This member is required.
49	GatewayARN *string
50}
51
52type DescribeBandwidthRateLimitScheduleOutput struct {
53
54	// An array that contains the bandwidth rate limit intervals for a tape or volume
55	// gateway.
56	BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval
57
58	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to
59	// return a list of gateways for your account and AWS Region.
60	GatewayARN *string
61
62	// Metadata pertaining to the operation's result.
63	ResultMetadata middleware.Metadata
64}
65
66func addOperationDescribeBandwidthRateLimitScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
67	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeBandwidthRateLimitSchedule{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeBandwidthRateLimitSchedule{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	if err = addSetLoggerMiddleware(stack, options); err != nil {
76		return err
77	}
78	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
79		return err
80	}
81	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
82		return err
83	}
84	if err = addResolveEndpointMiddleware(stack, options); err != nil {
85		return err
86	}
87	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
88		return err
89	}
90	if err = addRetryMiddlewares(stack, options); err != nil {
91		return err
92	}
93	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
94		return err
95	}
96	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
100		return err
101	}
102	if err = addClientUserAgent(stack); err != nil {
103		return err
104	}
105	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
109		return err
110	}
111	if err = addOpDescribeBandwidthRateLimitScheduleValidationMiddleware(stack); err != nil {
112		return err
113	}
114	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeBandwidthRateLimitSchedule(options.Region), middleware.Before); err != nil {
115		return err
116	}
117	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addResponseErrorMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addRequestResponseLogging(stack, options); err != nil {
124		return err
125	}
126	return nil
127}
128
129func newServiceMetadataMiddleware_opDescribeBandwidthRateLimitSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
130	return &awsmiddleware.RegisterServiceMetadata{
131		Region:        region,
132		ServiceID:     ServiceID,
133		SigningName:   "storagegateway",
134		OperationName: "DescribeBandwidthRateLimitSchedule",
135	}
136}
137