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, 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 which 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
45type DescribeGroupOutput struct {
46
47	// Contains the group’s display name value. The length limit is 1024 characters.
48	// This value can consist of letters, accented characters, symbols, numbers,
49	// punctuation, tab, new line, carriage return, space and non breaking space in
50	// this attribute. The characters “<>;:%” are excluded. This value is specified at
51	// the time the group is created and stored as an attribute of the group object in
52	// the identity store.
53	//
54	// This member is required.
55	DisplayName *string
56
57	// The identifier for a group in the identity store.
58	//
59	// This member is required.
60	GroupId *string
61
62	// Metadata pertaining to the operation's result.
63	ResultMetadata middleware.Metadata
64}
65
66func addOperationDescribeGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
67	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeGroup{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeGroup{}, 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 = addOpDescribeGroupValidationMiddleware(stack); err != nil {
112		return err
113	}
114	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeGroup(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_opDescribeGroup(region string) *awsmiddleware.RegisterServiceMetadata {
130	return &awsmiddleware.RegisterServiceMetadata{
131		Region:        region,
132		ServiceID:     ServiceID,
133		SigningName:   "identitystore",
134		OperationName: "DescribeGroup",
135	}
136}
137