1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package iot
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/iot/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Tests if a specified principal is authorized to perform an AWS IoT action on a
15// specified resource. Use this to test and debug the authorization behavior of
16// devices that connect to the AWS IoT device gateway.
17func (c *Client) TestAuthorization(ctx context.Context, params *TestAuthorizationInput, optFns ...func(*Options)) (*TestAuthorizationOutput, error) {
18	if params == nil {
19		params = &TestAuthorizationInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "TestAuthorization", params, optFns, addOperationTestAuthorizationMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*TestAuthorizationOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type TestAuthorizationInput struct {
33
34	// A list of authorization info objects. Simulating authorization will create a
35	// response for each authInfo object in the list.
36	//
37	// This member is required.
38	AuthInfos []types.AuthInfo
39
40	// The MQTT client ID.
41	ClientId *string
42
43	// The Cognito identity pool ID.
44	CognitoIdentityPoolId *string
45
46	// When testing custom authorization, the policies specified here are treated as if
47	// they are attached to the principal being authorized.
48	PolicyNamesToAdd []string
49
50	// When testing custom authorization, the policies specified here are treated as if
51	// they are not attached to the principal being authorized.
52	PolicyNamesToSkip []string
53
54	// The principal. Valid principals are CertificateArn
55	// (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn
56	// (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).
57	Principal *string
58}
59
60type TestAuthorizationOutput struct {
61
62	// The authentication results.
63	AuthResults []types.AuthResult
64
65	// Metadata pertaining to the operation's result.
66	ResultMetadata middleware.Metadata
67}
68
69func addOperationTestAuthorizationMiddlewares(stack *middleware.Stack, options Options) (err error) {
70	err = stack.Serialize.Add(&awsRestjson1_serializeOpTestAuthorization{}, middleware.After)
71	if err != nil {
72		return err
73	}
74	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpTestAuthorization{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	if err = addSetLoggerMiddleware(stack, options); err != nil {
79		return err
80	}
81	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
82		return err
83	}
84	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
85		return err
86	}
87	if err = addResolveEndpointMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
91		return err
92	}
93	if err = addRetryMiddlewares(stack, options); err != nil {
94		return err
95	}
96	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
103		return err
104	}
105	if err = addClientUserAgent(stack); err != nil {
106		return err
107	}
108	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
109		return err
110	}
111	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
112		return err
113	}
114	if err = addOpTestAuthorizationValidationMiddleware(stack); err != nil {
115		return err
116	}
117	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opTestAuthorization(options.Region), middleware.Before); err != nil {
118		return err
119	}
120	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addResponseErrorMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addRequestResponseLogging(stack, options); err != nil {
127		return err
128	}
129	return nil
130}
131
132func newServiceMetadataMiddleware_opTestAuthorization(region string) *awsmiddleware.RegisterServiceMetadata {
133	return &awsmiddleware.RegisterServiceMetadata{
134		Region:        region,
135		ServiceID:     ServiceID,
136		SigningName:   "execute-api",
137		OperationName: "TestAuthorization",
138	}
139}
140