1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package opsworks
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/opsworks/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Describes an instance's Amazon EBS volumes. This call accepts only one
15// resource-identifying parameter. Required Permissions: To use this action, an IAM
16// user must have a Show, Deploy, or Manage permissions level for the stack, or an
17// attached policy that explicitly grants permissions. For more information about
18// user permissions, see Managing User Permissions
19// (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html).
20func (c *Client) DescribeVolumes(ctx context.Context, params *DescribeVolumesInput, optFns ...func(*Options)) (*DescribeVolumesOutput, error) {
21	if params == nil {
22		params = &DescribeVolumesInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeVolumes", params, optFns, addOperationDescribeVolumesMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeVolumesOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type DescribeVolumesInput struct {
36
37	// The instance ID. If you use this parameter, DescribeVolumes returns descriptions
38	// of the volumes associated with the specified instance.
39	InstanceId *string
40
41	// The RAID array ID. If you use this parameter, DescribeVolumes returns
42	// descriptions of the volumes associated with the specified RAID array.
43	RaidArrayId *string
44
45	// A stack ID. The action describes the stack's registered Amazon EBS volumes.
46	StackId *string
47
48	// Am array of volume IDs. If you use this parameter, DescribeVolumes returns
49	// descriptions of the specified volumes. Otherwise, it returns a description of
50	// every volume.
51	VolumeIds []string
52}
53
54// Contains the response to a DescribeVolumes request.
55type DescribeVolumesOutput struct {
56
57	// An array of volume IDs.
58	Volumes []types.Volume
59
60	// Metadata pertaining to the operation's result.
61	ResultMetadata middleware.Metadata
62}
63
64func addOperationDescribeVolumesMiddlewares(stack *middleware.Stack, options Options) (err error) {
65	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeVolumes{}, middleware.After)
66	if err != nil {
67		return err
68	}
69	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeVolumes{}, middleware.After)
70	if err != nil {
71		return err
72	}
73	if err = addSetLoggerMiddleware(stack, options); err != nil {
74		return err
75	}
76	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
77		return err
78	}
79	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
80		return err
81	}
82	if err = addResolveEndpointMiddleware(stack, options); err != nil {
83		return err
84	}
85	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
86		return err
87	}
88	if err = addRetryMiddlewares(stack, options); err != nil {
89		return err
90	}
91	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
95		return err
96	}
97	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
98		return err
99	}
100	if err = addClientUserAgent(stack); err != nil {
101		return err
102	}
103	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
107		return err
108	}
109	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeVolumes(options.Region), middleware.Before); err != nil {
110		return err
111	}
112	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addResponseErrorMiddleware(stack); err != nil {
116		return err
117	}
118	if err = addRequestResponseLogging(stack, options); err != nil {
119		return err
120	}
121	return nil
122}
123
124func newServiceMetadataMiddleware_opDescribeVolumes(region string) *awsmiddleware.RegisterServiceMetadata {
125	return &awsmiddleware.RegisterServiceMetadata{
126		Region:        region,
127		ServiceID:     ServiceID,
128		SigningName:   "opsworks",
129		OperationName: "DescribeVolumes",
130	}
131}
132