1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package dynamodb
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/dynamodb/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Returns information about contributor insights, for a given table or global
16// secondary index.
17func (c *Client) DescribeContributorInsights(ctx context.Context, params *DescribeContributorInsightsInput, optFns ...func(*Options)) (*DescribeContributorInsightsOutput, error) {
18	if params == nil {
19		params = &DescribeContributorInsightsInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "DescribeContributorInsights", params, optFns, addOperationDescribeContributorInsightsMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*DescribeContributorInsightsOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type DescribeContributorInsightsInput struct {
33
34	// The name of the table to describe.
35	//
36	// This member is required.
37	TableName *string
38
39	// The name of the global secondary index to describe, if applicable.
40	IndexName *string
41}
42
43type DescribeContributorInsightsOutput struct {
44
45	// List of names of the associated Alpine rules.
46	ContributorInsightsRuleList []string
47
48	// Current Status contributor insights.
49	ContributorInsightsStatus types.ContributorInsightsStatus
50
51	// Returns information about the last failure that encountered. The most common
52	// exceptions for a FAILED status are:
53	//
54	// * LimitExceededException - Per-account
55	// Amazon CloudWatch Contributor Insights rule limit reached. Please disable
56	// Contributor Insights for other tables/indexes OR disable Contributor Insights
57	// rules before retrying.
58	//
59	// * AccessDeniedException - Amazon CloudWatch Contributor
60	// Insights rules cannot be modified due to insufficient permissions.
61	//
62	// *
63	// AccessDeniedException - Failed to create service-linked role for Contributor
64	// Insights due to insufficient permissions.
65	//
66	// * InternalServerError - Failed to
67	// create Amazon CloudWatch Contributor Insights rules. Please retry request.
68	FailureException *types.FailureException
69
70	// The name of the global secondary index being described.
71	IndexName *string
72
73	// Timestamp of the last time the status was changed.
74	LastUpdateDateTime *time.Time
75
76	// The name of the table being described.
77	TableName *string
78
79	// Metadata pertaining to the operation's result.
80	ResultMetadata middleware.Metadata
81}
82
83func addOperationDescribeContributorInsightsMiddlewares(stack *middleware.Stack, options Options) (err error) {
84	err = stack.Serialize.Add(&awsAwsjson10_serializeOpDescribeContributorInsights{}, middleware.After)
85	if err != nil {
86		return err
87	}
88	err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpDescribeContributorInsights{}, middleware.After)
89	if err != nil {
90		return err
91	}
92	if err = addSetLoggerMiddleware(stack, options); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
96		return err
97	}
98	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
99		return err
100	}
101	if err = addResolveEndpointMiddleware(stack, options); err != nil {
102		return err
103	}
104	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
105		return err
106	}
107	if err = addRetryMiddlewares(stack, options); err != nil {
108		return err
109	}
110	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
111		return err
112	}
113	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
114		return err
115	}
116	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
117		return err
118	}
119	if err = addClientUserAgent(stack); err != nil {
120		return err
121	}
122	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
123		return err
124	}
125	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
126		return err
127	}
128	if err = addOpDescribeContributorInsightsValidationMiddleware(stack); err != nil {
129		return err
130	}
131	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeContributorInsights(options.Region), middleware.Before); err != nil {
132		return err
133	}
134	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
135		return err
136	}
137	if err = addResponseErrorMiddleware(stack); err != nil {
138		return err
139	}
140	if err = addValidateResponseChecksum(stack, options); err != nil {
141		return err
142	}
143	if err = addAcceptEncodingGzip(stack, options); err != nil {
144		return err
145	}
146	if err = addRequestResponseLogging(stack, options); err != nil {
147		return err
148	}
149	return nil
150}
151
152func newServiceMetadataMiddleware_opDescribeContributorInsights(region string) *awsmiddleware.RegisterServiceMetadata {
153	return &awsmiddleware.RegisterServiceMetadata{
154		Region:        region,
155		ServiceID:     ServiceID,
156		SigningName:   "dynamodb",
157		OperationName: "DescribeContributorInsights",
158	}
159}
160