1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package workmail
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/workmail/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Provides information regarding the user.
16func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error) {
17	if params == nil {
18		params = &DescribeUserInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeUser", params, optFns, addOperationDescribeUserMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeUserOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeUserInput struct {
32
33	// The identifier for the organization under which the user exists.
34	//
35	// This member is required.
36	OrganizationId *string
37
38	// The identifier for the user to be described.
39	//
40	// This member is required.
41	UserId *string
42}
43
44type DescribeUserOutput struct {
45
46	// The date and time at which the user was disabled for Amazon WorkMail usage, in
47	// UNIX epoch time format.
48	DisabledDate *time.Time
49
50	// The display name of the user.
51	DisplayName *string
52
53	// The email of the user.
54	Email *string
55
56	// The date and time at which the user was enabled for Amazon WorkMail usage, in
57	// UNIX epoch time format.
58	EnabledDate *time.Time
59
60	// The name for the user.
61	Name *string
62
63	// The state of a user: enabled (registered to Amazon WorkMail) or disabled
64	// (deregistered or never registered to WorkMail).
65	State types.EntityState
66
67	// The identifier for the described user.
68	UserId *string
69
70	// In certain cases, other entities are modeled as users. If interoperability is
71	// enabled, resources are imported into Amazon WorkMail as users. Because different
72	// WorkMail organizations rely on different directory types, administrators can
73	// distinguish between an unregistered user (account is disabled and has a user
74	// role) and the directory administrators. The values are USER, RESOURCE, and
75	// SYSTEM_USER.
76	UserRole types.UserRole
77
78	// Metadata pertaining to the operation's result.
79	ResultMetadata middleware.Metadata
80}
81
82func addOperationDescribeUserMiddlewares(stack *middleware.Stack, options Options) (err error) {
83	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeUser{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeUser{}, middleware.After)
88	if err != nil {
89		return err
90	}
91	if err = addSetLoggerMiddleware(stack, options); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
95		return err
96	}
97	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
98		return err
99	}
100	if err = addResolveEndpointMiddleware(stack, options); err != nil {
101		return err
102	}
103	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
104		return err
105	}
106	if err = addRetryMiddlewares(stack, options); err != nil {
107		return err
108	}
109	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
110		return err
111	}
112	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
113		return err
114	}
115	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
116		return err
117	}
118	if err = addClientUserAgent(stack); err != nil {
119		return err
120	}
121	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
122		return err
123	}
124	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addOpDescribeUserValidationMiddleware(stack); err != nil {
128		return err
129	}
130	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeUser(options.Region), middleware.Before); err != nil {
131		return err
132	}
133	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
134		return err
135	}
136	if err = addResponseErrorMiddleware(stack); err != nil {
137		return err
138	}
139	if err = addRequestResponseLogging(stack, options); err != nil {
140		return err
141	}
142	return nil
143}
144
145func newServiceMetadataMiddleware_opDescribeUser(region string) *awsmiddleware.RegisterServiceMetadata {
146	return &awsmiddleware.RegisterServiceMetadata{
147		Region:        region,
148		ServiceID:     ServiceID,
149		SigningName:   "workmail",
150		OperationName: "DescribeUser",
151	}
152}
153