1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package lexmodelsv2
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/lexmodelsv2/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Provides metadata information about a bot.
16func (c *Client) DescribeBot(ctx context.Context, params *DescribeBotInput, optFns ...func(*Options)) (*DescribeBotOutput, error) {
17	if params == nil {
18		params = &DescribeBotInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeBot", params, optFns, addOperationDescribeBotMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeBotOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeBotInput struct {
32
33	// The unique identifier of the bot to describe.
34	//
35	// This member is required.
36	BotId *string
37}
38
39type DescribeBotOutput struct {
40
41	// The unique identifier of the bot.
42	BotId *string
43
44	// The name of the bot.
45	BotName *string
46
47	// The current status of the bot. When the status is Available the bot is ready to
48	// be used in conversations with users.
49	BotStatus types.BotStatus
50
51	// A timestamp of the date and time that the bot was created.
52	CreationDateTime *time.Time
53
54	// Settings for managing data privacy of the bot and its conversations with users.
55	DataPrivacy *types.DataPrivacy
56
57	// The description of the bot.
58	Description *string
59
60	// The maximum time in seconds that Amazon Lex retains the data gathered in a
61	// conversation.
62	IdleSessionTTLInSeconds *int32
63
64	// A timestamp of the date and time that the bot was last updated.
65	LastUpdatedDateTime *time.Time
66
67	// The Amazon Resource Name (ARN) of an IAM role that has permission to access the
68	// bot.
69	RoleArn *string
70
71	// Metadata pertaining to the operation's result.
72	ResultMetadata middleware.Metadata
73}
74
75func addOperationDescribeBotMiddlewares(stack *middleware.Stack, options Options) (err error) {
76	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeBot{}, middleware.After)
77	if err != nil {
78		return err
79	}
80	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeBot{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	if err = addSetLoggerMiddleware(stack, options); err != nil {
85		return err
86	}
87	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
88		return err
89	}
90	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
91		return err
92	}
93	if err = addResolveEndpointMiddleware(stack, options); err != nil {
94		return err
95	}
96	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
97		return err
98	}
99	if err = addRetryMiddlewares(stack, options); err != nil {
100		return err
101	}
102	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
109		return err
110	}
111	if err = addClientUserAgent(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addOpDescribeBotValidationMiddleware(stack); err != nil {
121		return err
122	}
123	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeBot(options.Region), middleware.Before); err != nil {
124		return err
125	}
126	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
127		return err
128	}
129	if err = addResponseErrorMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addRequestResponseLogging(stack, options); err != nil {
133		return err
134	}
135	return nil
136}
137
138func newServiceMetadataMiddleware_opDescribeBot(region string) *awsmiddleware.RegisterServiceMetadata {
139	return &awsmiddleware.RegisterServiceMetadata{
140		Region:        region,
141		ServiceID:     ServiceID,
142		SigningName:   "lex",
143		OperationName: "DescribeBot",
144	}
145}
146