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/smithy-go/middleware"
10	smithyhttp "github.com/aws/smithy-go/transport/http"
11)
12
13// Returns information about the working storage of a gateway. This operation is
14// only supported in the stored volumes gateway type. This operation is deprecated
15// in cached volumes API version (20120630). Use DescribeUploadBuffer instead.
16// Working storage is also referred to as upload buffer. You can also use the
17// DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.
18// The response includes disk IDs that are configured as working storage, and it
19// includes the amount of working storage allocated and used.
20func (c *Client) DescribeWorkingStorage(ctx context.Context, params *DescribeWorkingStorageInput, optFns ...func(*Options)) (*DescribeWorkingStorageOutput, error) {
21	if params == nil {
22		params = &DescribeWorkingStorageInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeWorkingStorage", params, optFns, addOperationDescribeWorkingStorageMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeWorkingStorageOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35// A JSON object containing the Amazon Resource Name (ARN) of the gateway.
36type DescribeWorkingStorageInput struct {
37
38	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to
39	// return a list of gateways for your account and AWS Region.
40	//
41	// This member is required.
42	GatewayARN *string
43}
44
45// A JSON object containing the following fields:
46type DescribeWorkingStorageOutput struct {
47
48	// An array of the gateway's local disk IDs that are configured as working storage.
49	// Each local disk ID is specified as a string (minimum length of 1 and maximum
50	// length of 300). If no local disks are configured as working storage, then the
51	// DiskIds array is empty.
52	DiskIds []string
53
54	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to
55	// return a list of gateways for your account and AWS Region.
56	GatewayARN *string
57
58	// The total working storage in bytes allocated for the gateway. If no working
59	// storage is configured for the gateway, this field returns 0.
60	WorkingStorageAllocatedInBytes int64
61
62	// The total working storage in bytes in use by the gateway. If no working storage
63	// is configured for the gateway, this field returns 0.
64	WorkingStorageUsedInBytes int64
65
66	// Metadata pertaining to the operation's result.
67	ResultMetadata middleware.Metadata
68}
69
70func addOperationDescribeWorkingStorageMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeWorkingStorage{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeWorkingStorage{}, 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 = addOpDescribeWorkingStorageValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeWorkingStorage(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_opDescribeWorkingStorage(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "storagegateway",
138		OperationName: "DescribeWorkingStorage",
139	}
140}
141