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, c.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 Region.
47	//
48	// This member is required.
49	GatewayARN *string
50
51	noSmithyDocumentSerde
52}
53
54type DescribeBandwidthRateLimitScheduleOutput struct {
55
56	// An array that contains the bandwidth rate limit intervals for a tape or volume
57	// gateway.
58	BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval
59
60	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to
61	// return a list of gateways for your account and Region.
62	GatewayARN *string
63
64	// Metadata pertaining to the operation's result.
65	ResultMetadata middleware.Metadata
66
67	noSmithyDocumentSerde
68}
69
70func (c *Client) addOperationDescribeBandwidthRateLimitScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeBandwidthRateLimitSchedule{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeBandwidthRateLimitSchedule{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addOpDescribeBandwidthRateLimitScheduleValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeBandwidthRateLimitSchedule(options.Region), middleware.Before); err != nil {
119		return err
120	}
121	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addResponseErrorMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addRequestResponseLogging(stack, options); err != nil {
128		return err
129	}
130	return nil
131}
132
133func newServiceMetadataMiddleware_opDescribeBandwidthRateLimitSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "storagegateway",
138		OperationName: "DescribeBandwidthRateLimitSchedule",
139	}
140}
141