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 an array of Challenge-Handshake Authentication Protocol (CHAP)
15// credentials information for a specified iSCSI target, one for each
16// target-initiator pair. This operation is supported in the volume and tape
17// gateway types.
18func (c *Client) DescribeChapCredentials(ctx context.Context, params *DescribeChapCredentialsInput, optFns ...func(*Options)) (*DescribeChapCredentialsOutput, error) {
19	if params == nil {
20		params = &DescribeChapCredentialsInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "DescribeChapCredentials", params, optFns, addOperationDescribeChapCredentialsMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*DescribeChapCredentialsOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33// A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume
34// target.
35type DescribeChapCredentialsInput struct {
36
37	// The Amazon Resource Name (ARN) of the iSCSI volume target. Use the
38	// DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for
39	// specified VolumeARN.
40	//
41	// This member is required.
42	TargetARN *string
43}
44
45// A JSON object containing the following fields:
46type DescribeChapCredentialsOutput struct {
47
48	// An array of ChapInfo objects that represent CHAP credentials. Each object in the
49	// array contains CHAP credential information for one target-initiator pair. If no
50	// CHAP credentials are set, an empty array is returned. CHAP credential
51	// information is provided in a JSON object with the following fields:
52	//
53	// *
54	// InitiatorName: The iSCSI initiator that connects to the target.
55	//
56	// *
57	// SecretToAuthenticateInitiator: The secret key that the initiator (for example,
58	// the Windows client) must provide to participate in mutual CHAP with the
59	// target.
60	//
61	// * SecretToAuthenticateTarget: The secret key that the target must
62	// provide to participate in mutual CHAP with the initiator (e.g. Windows
63	// client).
64	//
65	// * TargetARN: The Amazon Resource Name (ARN) of the storage volume.
66	ChapCredentials []types.ChapInfo
67
68	// Metadata pertaining to the operation's result.
69	ResultMetadata middleware.Metadata
70}
71
72func addOperationDescribeChapCredentialsMiddlewares(stack *middleware.Stack, options Options) (err error) {
73	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeChapCredentials{}, middleware.After)
74	if err != nil {
75		return err
76	}
77	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeChapCredentials{}, 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 = addOpDescribeChapCredentialsValidationMiddleware(stack); err != nil {
118		return err
119	}
120	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeChapCredentials(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_opDescribeChapCredentials(region string) *awsmiddleware.RegisterServiceMetadata {
136	return &awsmiddleware.RegisterServiceMetadata{
137		Region:        region,
138		ServiceID:     ServiceID,
139		SigningName:   "storagegateway",
140		OperationName: "DescribeChapCredentials",
141	}
142}
143