1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package iotthingsgraph
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/iotthingsgraph/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Gets definitions of the specified entities. Uses the latest version of the
15// user's namespace by default. This API returns the following TDM entities.
16//
17// *
18// Properties
19//
20// * States
21//
22// * Events
23//
24// * Actions
25//
26// * Capabilities
27//
28// * Mappings
29//
30// *
31// Devices
32//
33// * Device Models
34//
35// * Services
36//
37// This action doesn't return definitions for
38// systems, flows, and deployments.
39func (c *Client) GetEntities(ctx context.Context, params *GetEntitiesInput, optFns ...func(*Options)) (*GetEntitiesOutput, error) {
40	if params == nil {
41		params = &GetEntitiesInput{}
42	}
43
44	result, metadata, err := c.invokeOperation(ctx, "GetEntities", params, optFns, addOperationGetEntitiesMiddlewares)
45	if err != nil {
46		return nil, err
47	}
48
49	out := result.(*GetEntitiesOutput)
50	out.ResultMetadata = metadata
51	return out, nil
52}
53
54type GetEntitiesInput struct {
55
56	// An array of entity IDs. The IDs should be in the following format.
57	// urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
58	//
59	// This member is required.
60	Ids []string
61
62	// The version of the user's namespace. Defaults to the latest version of the
63	// user's namespace.
64	NamespaceVersion *int64
65}
66
67type GetEntitiesOutput struct {
68
69	// An array of descriptions for the specified entities.
70	Descriptions []types.EntityDescription
71
72	// Metadata pertaining to the operation's result.
73	ResultMetadata middleware.Metadata
74}
75
76func addOperationGetEntitiesMiddlewares(stack *middleware.Stack, options Options) (err error) {
77	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetEntities{}, middleware.After)
78	if err != nil {
79		return err
80	}
81	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetEntities{}, middleware.After)
82	if err != nil {
83		return err
84	}
85	if err = addSetLoggerMiddleware(stack, options); err != nil {
86		return err
87	}
88	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
89		return err
90	}
91	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
92		return err
93	}
94	if err = addResolveEndpointMiddleware(stack, options); err != nil {
95		return err
96	}
97	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
98		return err
99	}
100	if err = addRetryMiddlewares(stack, options); err != nil {
101		return err
102	}
103	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
104		return err
105	}
106	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
107		return err
108	}
109	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
110		return err
111	}
112	if err = addClientUserAgent(stack); err != nil {
113		return err
114	}
115	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
116		return err
117	}
118	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addOpGetEntitiesValidationMiddleware(stack); err != nil {
122		return err
123	}
124	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEntities(options.Region), middleware.Before); err != nil {
125		return err
126	}
127	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
128		return err
129	}
130	if err = addResponseErrorMiddleware(stack); err != nil {
131		return err
132	}
133	if err = addRequestResponseLogging(stack, options); err != nil {
134		return err
135	}
136	return nil
137}
138
139func newServiceMetadataMiddleware_opGetEntities(region string) *awsmiddleware.RegisterServiceMetadata {
140	return &awsmiddleware.RegisterServiceMetadata{
141		Region:        region,
142		ServiceID:     ServiceID,
143		SigningName:   "iotthingsgraph",
144		OperationName: "GetEntities",
145	}
146}
147