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// Describes the Regions that are enabled for your account, or all Regions. For a
15// list of the Regions supported by Amazon EC2, see  Regions and Endpoints
16// (https://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). For
17// information about enabling and disabling Regions for your account, see Managing
18// AWS Regions (https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in
19// the AWS General Reference.
20func (c *Client) DescribeRegions(ctx context.Context, params *DescribeRegionsInput, optFns ...func(*Options)) (*DescribeRegionsOutput, error) {
21	if params == nil {
22		params = &DescribeRegionsInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeRegions", params, optFns, addOperationDescribeRegionsMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeRegionsOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type DescribeRegionsInput struct {
36
37	// Indicates whether to display all Regions, including Regions that are disabled
38	// for your account.
39	AllRegions bool
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 filters.
48	//
49	// * endpoint - The endpoint of the Region (for example,
50	// ec2.us-east-1.amazonaws.com).
51	//
52	// * opt-in-status - The opt-in status of the Region
53	// (opt-in-not-required | opted-in | not-opted-in).
54	//
55	// * region-name - The name of
56	// the Region (for example, us-east-1).
57	Filters []types.Filter
58
59	// The names of the Regions. You can specify any Regions, whether they are enabled
60	// and disabled for your account.
61	RegionNames []string
62}
63
64type DescribeRegionsOutput struct {
65
66	// Information about the Regions.
67	Regions []types.Region
68
69	// Metadata pertaining to the operation's result.
70	ResultMetadata middleware.Metadata
71}
72
73func addOperationDescribeRegionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
74	err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeRegions{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeRegions{}, middleware.After)
79	if err != nil {
80		return err
81	}
82	if err = addSetLoggerMiddleware(stack, options); err != nil {
83		return err
84	}
85	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
86		return err
87	}
88	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
89		return err
90	}
91	if err = addResolveEndpointMiddleware(stack, options); err != nil {
92		return err
93	}
94	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
95		return err
96	}
97	if err = addRetryMiddlewares(stack, options); err != nil {
98		return err
99	}
100	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
104		return err
105	}
106	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
107		return err
108	}
109	if err = addClientUserAgent(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeRegions(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_opDescribeRegions(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "ec2",
138		OperationName: "DescribeRegions",
139	}
140}
141