1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package cognitosync
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/cognitosync/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Gets meta data about a dataset by identity and dataset name. With Amazon Cognito
15// Sync, each identity has access only to its own data. Thus, the credentials used
16// to make this API call need to have access to the identity data. This API can be
17// called with temporary user credentials provided by Cognito Identity or with
18// developer credentials. You should use Cognito Identity credentials to make this
19// API call.
20func (c *Client) DescribeDataset(ctx context.Context, params *DescribeDatasetInput, optFns ...func(*Options)) (*DescribeDatasetOutput, error) {
21	if params == nil {
22		params = &DescribeDatasetInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "DescribeDataset", params, optFns, addOperationDescribeDatasetMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*DescribeDatasetOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35// A request for meta data about a dataset (creation date, number of records, size)
36// by owner and dataset name.
37type DescribeDatasetInput struct {
38
39	// A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
40	// (underscore), '-' (dash), and '.' (dot).
41	//
42	// This member is required.
43	DatasetName *string
44
45	// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
46	// created by Amazon Cognito. GUID generation is unique within a region.
47	//
48	// This member is required.
49	IdentityId *string
50
51	// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
52	// created by Amazon Cognito. GUID generation is unique within a region.
53	//
54	// This member is required.
55	IdentityPoolId *string
56}
57
58// Response to a successful DescribeDataset request.
59type DescribeDatasetOutput struct {
60
61	// Meta data for a collection of data for an identity. An identity can have
62	// multiple datasets. A dataset can be general or associated with a particular
63	// entity in an application (like a saved game). Datasets are automatically created
64	// if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB
65	// of key-value pairs.
66	Dataset *types.Dataset
67
68	// Metadata pertaining to the operation's result.
69	ResultMetadata middleware.Metadata
70}
71
72func addOperationDescribeDatasetMiddlewares(stack *middleware.Stack, options Options) (err error) {
73	err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeDataset{}, middleware.After)
74	if err != nil {
75		return err
76	}
77	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeDataset{}, middleware.After)
78	if err != nil {
79		return err
80	}
81	if err = addSetLoggerMiddleware(stack, options); err != nil {
82		return err
83	}
84	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
85		return err
86	}
87	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
88		return err
89	}
90	if err = addResolveEndpointMiddleware(stack, options); err != nil {
91		return err
92	}
93	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
94		return err
95	}
96	if err = addRetryMiddlewares(stack, options); err != nil {
97		return err
98	}
99	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
100		return err
101	}
102	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
106		return err
107	}
108	if err = addClientUserAgent(stack); err != nil {
109		return err
110	}
111	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addOpDescribeDatasetValidationMiddleware(stack); err != nil {
118		return err
119	}
120	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDataset(options.Region), middleware.Before); err != nil {
121		return err
122	}
123	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
124		return err
125	}
126	if err = addResponseErrorMiddleware(stack); err != nil {
127		return err
128	}
129	if err = addRequestResponseLogging(stack, options); err != nil {
130		return err
131	}
132	return nil
133}
134
135func newServiceMetadataMiddleware_opDescribeDataset(region string) *awsmiddleware.RegisterServiceMetadata {
136	return &awsmiddleware.RegisterServiceMetadata{
137		Region:        region,
138		ServiceID:     ServiceID,
139		SigningName:   "cognito-sync",
140		OperationName: "DescribeDataset",
141	}
142}
143