1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package ec2
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/ec2/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Updates the description of an ingress (inbound) security group rule. You can
15// replace an existing description, or add a description to a rule that did not
16// have one previously. You specify the description as part of the IP permissions
17// structure. You can remove a description for a security group rule by omitting
18// the description parameter in the request.
19func (c *Client) UpdateSecurityGroupRuleDescriptionsIngress(ctx context.Context, params *UpdateSecurityGroupRuleDescriptionsIngressInput, optFns ...func(*Options)) (*UpdateSecurityGroupRuleDescriptionsIngressOutput, error) {
20	if params == nil {
21		params = &UpdateSecurityGroupRuleDescriptionsIngressInput{}
22	}
23
24	result, metadata, err := c.invokeOperation(ctx, "UpdateSecurityGroupRuleDescriptionsIngress", params, optFns, addOperationUpdateSecurityGroupRuleDescriptionsIngressMiddlewares)
25	if err != nil {
26		return nil, err
27	}
28
29	out := result.(*UpdateSecurityGroupRuleDescriptionsIngressOutput)
30	out.ResultMetadata = metadata
31	return out, nil
32}
33
34type UpdateSecurityGroupRuleDescriptionsIngressInput struct {
35
36	// The IP permissions for the security group rule.
37	//
38	// This member is required.
39	IpPermissions []types.IpPermission
40
41	// Checks whether you have the required permissions for the action, without
42	// actually making the request, and provides an error response. If you have the
43	// required permissions, the error response is DryRunOperation. Otherwise, it is
44	// UnauthorizedOperation.
45	DryRun bool
46
47	// The ID of the security group. You must specify either the security group ID or
48	// the security group name in the request. For security groups in a nondefault VPC,
49	// you must specify the security group ID.
50	GroupId *string
51
52	// [EC2-Classic, default VPC] The name of the security group. You must specify
53	// either the security group ID or the security group name in the request.
54	GroupName *string
55}
56
57type UpdateSecurityGroupRuleDescriptionsIngressOutput struct {
58
59	// Returns true if the request succeeds; otherwise, returns an error.
60	Return bool
61
62	// Metadata pertaining to the operation's result.
63	ResultMetadata middleware.Metadata
64}
65
66func addOperationUpdateSecurityGroupRuleDescriptionsIngressMiddlewares(stack *middleware.Stack, options Options) (err error) {
67	err = stack.Serialize.Add(&awsEc2query_serializeOpUpdateSecurityGroupRuleDescriptionsIngress{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	err = stack.Deserialize.Add(&awsEc2query_deserializeOpUpdateSecurityGroupRuleDescriptionsIngress{}, 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 = addOpUpdateSecurityGroupRuleDescriptionsIngressValidationMiddleware(stack); err != nil {
112		return err
113	}
114	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateSecurityGroupRuleDescriptionsIngress(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_opUpdateSecurityGroupRuleDescriptionsIngress(region string) *awsmiddleware.RegisterServiceMetadata {
130	return &awsmiddleware.RegisterServiceMetadata{
131		Region:        region,
132		ServiceID:     ServiceID,
133		SigningName:   "ec2",
134		OperationName: "UpdateSecurityGroupRuleDescriptionsIngress",
135	}
136}
137