1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package identitystore
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// Retrieves the group metadata and attributes from GroupId in an identity store.
14func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error) {
15	if params == nil {
16		params = &DescribeGroupInput{}
17	}
18
19	result, metadata, err := c.invokeOperation(ctx, "DescribeGroup", params, optFns, c.addOperationDescribeGroupMiddlewares)
20	if err != nil {
21		return nil, err
22	}
23
24	out := result.(*DescribeGroupOutput)
25	out.ResultMetadata = metadata
26	return out, nil
27}
28
29type DescribeGroupInput struct {
30
31	// The identifier for a group in the identity store.
32	//
33	// This member is required.
34	GroupId *string
35
36	// The globally unique identifier for the identity store, such as d-1234567890. In
37	// this example, d- is a fixed prefix, and 1234567890 is a randomly generated
38	// string that contains number and lower case letters. This value is generated at
39	// the time that a new identity store is created.
40	//
41	// This member is required.
42	IdentityStoreId *string
43
44	noSmithyDocumentSerde
45}
46
47type DescribeGroupOutput struct {
48
49	// Contains the group’s display name value. The length limit is 1,024 characters.
50	// This value can consist of letters, accented characters, symbols, numbers,
51	// punctuation, tab, new line, carriage return, space, and nonbreaking space in
52	// this attribute. The characters <>;:% are excluded. This value is specified at
53	// the time that the group is created and stored as an attribute of the group
54	// object in the identity store.
55	//
56	// This member is required.
57	DisplayName *string
58
59	// The identifier for a group in the identity store.
60	//
61	// This member is required.
62	GroupId *string
63
64	// Metadata pertaining to the operation's result.
65	ResultMetadata middleware.Metadata
66
67	noSmithyDocumentSerde
68}
69
70func (c *Client) addOperationDescribeGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeGroup{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeGroup{}, 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 = addOpDescribeGroupValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeGroup(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_opDescribeGroup(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "identitystore",
138		OperationName: "DescribeGroup",
139	}
140}
141