@aws-sdk/client-cognito-sync 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { BulkPublishRequest, BulkPublishResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BulkPublishCommand}.
8
10
  */
9
11
  export interface BulkPublishCommandInput extends BulkPublishRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BulkPublishCommand}.
13
17
  */
14
18
  export interface BulkPublishCommandOutput extends BulkPublishResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BulkPublishCommandOutput extends BulkPublishResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param BulkPublishCommandInput - {@link BulkPublishCommandInput}
34
+ * @returns {@link BulkPublishCommandOutput}
28
35
  * @see {@link BulkPublishCommandInput} for command's `input` shape.
29
36
  * @see {@link BulkPublishCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -56,11 +63,20 @@ export interface BulkPublishCommandOutput extends BulkPublishResponse, __Metadat
56
63
  export declare class BulkPublishCommand extends $Command<BulkPublishCommandInput, BulkPublishCommandOutput, CognitoSyncClientResolvedConfig> {
57
64
  readonly input: BulkPublishCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: BulkPublishCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BulkPublishCommandInput, BulkPublishCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { DeleteDatasetRequest, DeleteDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDatasetCommand}.
8
10
  */
9
11
  export interface DeleteDatasetCommandInput extends DeleteDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDatasetCommand}.
13
17
  */
14
18
  export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specific dataset. The dataset will be deleted permanently, and the action can't
18
23
  * be undone. Datasets that this dataset was merged with will no longer report the merge. Any
19
24
  * subsequent operation on this dataset will result in a
@@ -29,6 +34,8 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteDatasetCommandInput - {@link DeleteDatasetCommandInput}
38
+ * @returns {@link DeleteDatasetCommandOutput}
32
39
  * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
34
41
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -62,11 +69,20 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
62
69
  export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, CognitoSyncClientResolvedConfig> {
63
70
  readonly input: DeleteDatasetCommandInput;
64
71
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
65
75
  constructor(input: DeleteDatasetCommandInput);
66
76
  /**
67
77
  * @internal
68
78
  */
69
79
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetCommandInput, DeleteDatasetCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
70
83
  private serialize;
84
+ /**
85
+ * @internal
86
+ */
71
87
  private deserialize;
72
88
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { DescribeDatasetRequest, DescribeDatasetResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDatasetCommand}.
8
10
  */
9
11
  export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDatasetCommand}.
13
17
  */
14
18
  export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each
18
23
  * identity has access only to its own data. Thus, the credentials used to make this API call
19
24
  * need to have access to the identity data.</p>
@@ -28,6 +33,8 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput}
37
+ * @returns {@link DescribeDatasetCommandOutput}
31
38
  * @see {@link DescribeDatasetCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeDatasetCommandOutput} for command's `response` shape.
33
40
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
57
64
  export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, CognitoSyncClientResolvedConfig> {
58
65
  readonly input: DescribeDatasetCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DescribeDatasetCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatasetCommandInput, DescribeDatasetCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { DescribeIdentityPoolUsageRequest, DescribeIdentityPoolUsageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeIdentityPoolUsageCommand}.
8
10
  */
9
11
  export interface DescribeIdentityPoolUsageCommandInput extends DescribeIdentityPoolUsageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeIdentityPoolUsageCommand}.
13
17
  */
14
18
  export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentityPoolUsageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets usage details (for example, data storage) about a particular identity pool.</p>
18
23
  * <p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
19
24
  *
@@ -30,14 +35,14 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity
30
35
  * X-AMZ-DATE: 20141111T205737Z
31
36
  * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
32
37
  *
33
- * {
38
+ * \{
34
39
  * "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsage",
35
40
  * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
36
41
  * "Input":
37
- * {
42
+ * \{
38
43
  * "IdentityPoolId": "IDENTITY_POOL_ID"
39
- * }
40
- * }
44
+ * \}
45
+ * \}
41
46
  * </request>
42
47
  * <response>
43
48
  * 1.1 200 OK
@@ -46,20 +51,20 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity
46
51
  * content-length: 271
47
52
  * date: Tue, 11 Nov 2014 20:57:37 GMT
48
53
  *
49
- * {
54
+ * \{
50
55
  * "Output":
51
- * {
56
+ * \{
52
57
  * "__type": "com.amazonaws.cognito.sync.model#DescribeIdentityPoolUsageResponse",
53
58
  * "IdentityPoolUsage":
54
- * {
59
+ * \{
55
60
  * "DataStorage": 0,
56
61
  * "IdentityPoolId": "IDENTITY_POOL_ID",
57
62
  * "LastModifiedDate": 1.413231134115E9,
58
63
  * "SyncSessionsCount": null
59
- * }
60
- * },
64
+ * \}
65
+ * \},
61
66
  * "Version": "1.0"
62
- * }
67
+ * \}
63
68
  * </response>
64
69
  * </example>
65
70
  * </examples>
@@ -73,6 +78,8 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity
73
78
  * const response = await client.send(command);
74
79
  * ```
75
80
  *
81
+ * @param DescribeIdentityPoolUsageCommandInput - {@link DescribeIdentityPoolUsageCommandInput}
82
+ * @returns {@link DescribeIdentityPoolUsageCommandOutput}
76
83
  * @see {@link DescribeIdentityPoolUsageCommandInput} for command's `input` shape.
77
84
  * @see {@link DescribeIdentityPoolUsageCommandOutput} for command's `response` shape.
78
85
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -102,11 +109,20 @@ export interface DescribeIdentityPoolUsageCommandOutput extends DescribeIdentity
102
109
  export declare class DescribeIdentityPoolUsageCommand extends $Command<DescribeIdentityPoolUsageCommandInput, DescribeIdentityPoolUsageCommandOutput, CognitoSyncClientResolvedConfig> {
103
110
  readonly input: DescribeIdentityPoolUsageCommandInput;
104
111
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
112
+ /**
113
+ * @public
114
+ */
105
115
  constructor(input: DescribeIdentityPoolUsageCommandInput);
106
116
  /**
107
117
  * @internal
108
118
  */
109
119
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeIdentityPoolUsageCommandInput, DescribeIdentityPoolUsageCommandOutput>;
120
+ /**
121
+ * @internal
122
+ */
110
123
  private serialize;
124
+ /**
125
+ * @internal
126
+ */
111
127
  private deserialize;
112
128
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { DescribeIdentityUsageRequest, DescribeIdentityUsageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeIdentityUsageCommand}.
8
10
  */
9
11
  export interface DescribeIdentityUsageCommandInput extends DescribeIdentityUsageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeIdentityUsageCommand}.
13
17
  */
14
18
  export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets usage information for an identity, including number of datasets and data usage.</p>
18
23
  * <p>This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.</p>
19
24
  * <examples>
@@ -29,15 +34,15 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag
29
34
  * X-AMZ-DATE: 20141111T215129Z
30
35
  * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
31
36
  *
32
- * {
37
+ * \{
33
38
  * "Operation": "com.amazonaws.cognito.sync.model#DescribeIdentityUsage",
34
39
  * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
35
40
  * "Input":
36
- * {
41
+ * \{
37
42
  * "IdentityPoolId": "IDENTITY_POOL_ID",
38
43
  * "IdentityId": "IDENTITY_ID"
39
- * }
40
- * }
44
+ * \}
45
+ * \}
41
46
  * </request>
42
47
  * <response>
43
48
  * 1.1 200 OK
@@ -46,21 +51,21 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag
46
51
  * content-length: 318
47
52
  * date: Tue, 11 Nov 2014 21:51:29 GMT
48
53
  *
49
- * {
54
+ * \{
50
55
  * "Output":
51
- * {
56
+ * \{
52
57
  * "__type": "com.amazonaws.cognito.sync.model#DescribeIdentityUsageResponse",
53
58
  * "IdentityUsage":
54
- * {
59
+ * \{
55
60
  * "DataStorage": 16,
56
61
  * "DatasetCount": 1,
57
62
  * "IdentityId": "IDENTITY_ID",
58
63
  * "IdentityPoolId": "IDENTITY_POOL_ID",
59
64
  * "LastModifiedDate": 1.412974081336E9
60
- * }
61
- * },
65
+ * \}
66
+ * \},
62
67
  * "Version": "1.0"
63
- * }
68
+ * \}
64
69
  * </response>
65
70
  * </example>
66
71
  * </examples>
@@ -74,6 +79,8 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag
74
79
  * const response = await client.send(command);
75
80
  * ```
76
81
  *
82
+ * @param DescribeIdentityUsageCommandInput - {@link DescribeIdentityUsageCommandInput}
83
+ * @returns {@link DescribeIdentityUsageCommandOutput}
77
84
  * @see {@link DescribeIdentityUsageCommandInput} for command's `input` shape.
78
85
  * @see {@link DescribeIdentityUsageCommandOutput} for command's `response` shape.
79
86
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -103,11 +110,20 @@ export interface DescribeIdentityUsageCommandOutput extends DescribeIdentityUsag
103
110
  export declare class DescribeIdentityUsageCommand extends $Command<DescribeIdentityUsageCommandInput, DescribeIdentityUsageCommandOutput, CognitoSyncClientResolvedConfig> {
104
111
  readonly input: DescribeIdentityUsageCommandInput;
105
112
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
113
+ /**
114
+ * @public
115
+ */
106
116
  constructor(input: DescribeIdentityUsageCommandInput);
107
117
  /**
108
118
  * @internal
109
119
  */
110
120
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeIdentityUsageCommandInput, DescribeIdentityUsageCommandOutput>;
121
+ /**
122
+ * @internal
123
+ */
111
124
  private serialize;
125
+ /**
126
+ * @internal
127
+ */
112
128
  private deserialize;
113
129
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { GetBulkPublishDetailsRequest, GetBulkPublishDetailsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetBulkPublishDetailsCommand}.
8
10
  */
9
11
  export interface GetBulkPublishDetailsCommandInput extends GetBulkPublishDetailsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetBulkPublishDetailsCommand}.
13
17
  */
14
18
  export interface GetBulkPublishDetailsCommandOutput extends GetBulkPublishDetailsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get the status of the last BulkPublish operation for an identity pool.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetBulkPublishDetailsCommandOutput extends GetBulkPublishDetail
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetBulkPublishDetailsCommandInput - {@link GetBulkPublishDetailsCommandInput}
34
+ * @returns {@link GetBulkPublishDetailsCommandOutput}
28
35
  * @see {@link GetBulkPublishDetailsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetBulkPublishDetailsCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -50,11 +57,20 @@ export interface GetBulkPublishDetailsCommandOutput extends GetBulkPublishDetail
50
57
  export declare class GetBulkPublishDetailsCommand extends $Command<GetBulkPublishDetailsCommandInput, GetBulkPublishDetailsCommandOutput, CognitoSyncClientResolvedConfig> {
51
58
  readonly input: GetBulkPublishDetailsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: GetBulkPublishDetailsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetBulkPublishDetailsCommandInput, GetBulkPublishDetailsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { GetCognitoEventsRequest, GetCognitoEventsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCognitoEventsCommand}.
8
10
  */
9
11
  export interface GetCognitoEventsCommandInput extends GetCognitoEventsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCognitoEventsCommand}.
13
17
  */
14
18
  export interface GetCognitoEventsCommandOutput extends GetCognitoEventsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the events and the corresponding Lambda functions associated with an identity pool.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetCognitoEventsCommandOutput extends GetCognitoEventsResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetCognitoEventsCommandInput - {@link GetCognitoEventsCommandInput}
34
+ * @returns {@link GetCognitoEventsCommandOutput}
28
35
  * @see {@link GetCognitoEventsCommandInput} for command's `input` shape.
29
36
  * @see {@link GetCognitoEventsCommandOutput} for command's `response` shape.
30
37
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -54,11 +61,20 @@ export interface GetCognitoEventsCommandOutput extends GetCognitoEventsResponse,
54
61
  export declare class GetCognitoEventsCommand extends $Command<GetCognitoEventsCommandInput, GetCognitoEventsCommandOutput, CognitoSyncClientResolvedConfig> {
55
62
  readonly input: GetCognitoEventsCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: GetCognitoEventsCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCognitoEventsCommandInput, GetCognitoEventsCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { GetIdentityPoolConfigurationRequest, GetIdentityPoolConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetIdentityPoolConfigurationCommand}.
8
10
  */
9
11
  export interface GetIdentityPoolConfigurationCommandInput extends GetIdentityPoolConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetIdentityPoolConfigurationCommand}.
13
17
  */
14
18
  export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPoolConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the configuration settings of an identity pool.</p><p>This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.</p>
18
23
  * <examples>
19
24
  * <example>
@@ -28,14 +33,14 @@ export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPo
28
33
  * X-AMZ-DATE: 20141004T195722Z
29
34
  * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>
30
35
  *
31
- * {
36
+ * \{
32
37
  * "Operation": "com.amazonaws.cognito.sync.model#GetIdentityPoolConfiguration",
33
38
  * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
34
39
  * "Input":
35
- * {
40
+ * \{
36
41
  * "IdentityPoolId": "ID_POOL_ID"
37
- * }
38
- * }
42
+ * \}
43
+ * \}
39
44
  *
40
45
  * </request>
41
46
  * <response>
@@ -45,19 +50,19 @@ export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPo
45
50
  * content-type: application/json
46
51
  * content-length: 332
47
52
  *
48
- * {
53
+ * \{
49
54
  * "Output":
50
- * {
55
+ * \{
51
56
  * "__type": "com.amazonaws.cognito.sync.model#GetIdentityPoolConfigurationResponse",
52
57
  * "IdentityPoolId": "ID_POOL_ID",
53
58
  * "PushSync":
54
- * {
59
+ * \{
55
60
  * "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"],
56
61
  * "RoleArn": "ROLEARN"
57
- * }
58
- * },
62
+ * \}
63
+ * \},
59
64
  * "Version": "1.0"
60
- * }
65
+ * \}
61
66
  * </response>
62
67
  * </example>
63
68
  * </examples>
@@ -71,6 +76,8 @@ export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPo
71
76
  * const response = await client.send(command);
72
77
  * ```
73
78
  *
79
+ * @param GetIdentityPoolConfigurationCommandInput - {@link GetIdentityPoolConfigurationCommandInput}
80
+ * @returns {@link GetIdentityPoolConfigurationCommandOutput}
74
81
  * @see {@link GetIdentityPoolConfigurationCommandInput} for command's `input` shape.
75
82
  * @see {@link GetIdentityPoolConfigurationCommandOutput} for command's `response` shape.
76
83
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -100,11 +107,20 @@ export interface GetIdentityPoolConfigurationCommandOutput extends GetIdentityPo
100
107
  export declare class GetIdentityPoolConfigurationCommand extends $Command<GetIdentityPoolConfigurationCommandInput, GetIdentityPoolConfigurationCommandOutput, CognitoSyncClientResolvedConfig> {
101
108
  readonly input: GetIdentityPoolConfigurationCommandInput;
102
109
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
110
+ /**
111
+ * @public
112
+ */
103
113
  constructor(input: GetIdentityPoolConfigurationCommandInput);
104
114
  /**
105
115
  * @internal
106
116
  */
107
117
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIdentityPoolConfigurationCommandInput, GetIdentityPoolConfigurationCommandOutput>;
118
+ /**
119
+ * @internal
120
+ */
108
121
  private serialize;
122
+ /**
123
+ * @internal
124
+ */
109
125
  private deserialize;
110
126
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CognitoSyncClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoSyncClient";
5
5
  import { ListDatasetsRequest, ListDatasetsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDatasetsCommand}.
8
10
  */
9
11
  export interface ListDatasetsCommandInput extends ListDatasetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDatasetsCommand}.
13
17
  */
14
18
  export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to
18
23
  * its own data. Thus, the credentials used to make this API call need to have access to the
19
24
  * identity data.</p>
@@ -33,16 +38,16 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
33
38
  * X-AMZ-DATE: 20141111T215640Z
34
39
  * AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;host;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<signature>
35
40
  *
36
- * {
41
+ * \{
37
42
  * "Operation": "com.amazonaws.cognito.sync.model#ListDatasets",
38
43
  * "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
39
44
  * "Input":
40
- * {
45
+ * \{
41
46
  * "IdentityPoolId": "IDENTITY_POOL_ID",
42
47
  * "IdentityId": "IDENTITY_ID",
43
48
  * "MaxResults": "3"
44
- * }
45
- * }
49
+ * \}
50
+ * \}
46
51
  * </request>
47
52
  * <response>
48
53
  * 1.1 200 OK
@@ -51,13 +56,13 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
51
56
  * content-length: 355
52
57
  * date: Tue, 11 Nov 2014 21:56:40 GMT
53
58
  *
54
- * {
59
+ * \{
55
60
  * "Output":
56
- * {
61
+ * \{
57
62
  * "__type": "com.amazonaws.cognito.sync.model#ListDatasetsResponse",
58
63
  * "Count": 1,
59
64
  * "Datasets": [
60
- * {
65
+ * \{
61
66
  * "CreationDate": 1.412974057151E9,
62
67
  * "DataStorage": 16,
63
68
  * "DatasetName": "my_list",
@@ -65,11 +70,11 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
65
70
  * "LastModifiedBy": "123456789012",
66
71
  * "LastModifiedDate": 1.412974057244E9,
67
72
  * "NumRecords": 1
68
- * }],
73
+ * \}],
69
74
  * "NextToken": null
70
- * },
75
+ * \},
71
76
  * "Version": "1.0"
72
- * }
77
+ * \}
73
78
  * </response>
74
79
  * </example>
75
80
  * </examples>
@@ -83,6 +88,8 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
83
88
  * const response = await client.send(command);
84
89
  * ```
85
90
  *
91
+ * @param ListDatasetsCommandInput - {@link ListDatasetsCommandInput}
92
+ * @returns {@link ListDatasetsCommandOutput}
86
93
  * @see {@link ListDatasetsCommandInput} for command's `input` shape.
87
94
  * @see {@link ListDatasetsCommandOutput} for command's `response` shape.
88
95
  * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape.
@@ -108,11 +115,20 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
108
115
  export declare class ListDatasetsCommand extends $Command<ListDatasetsCommandInput, ListDatasetsCommandOutput, CognitoSyncClientResolvedConfig> {
109
116
  readonly input: ListDatasetsCommandInput;
110
117
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
118
+ /**
119
+ * @public
120
+ */
111
121
  constructor(input: ListDatasetsCommandInput);
112
122
  /**
113
123
  * @internal
114
124
  */
115
125
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CognitoSyncClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetsCommandInput, ListDatasetsCommandOutput>;
126
+ /**
127
+ * @internal
128
+ */
116
129
  private serialize;
130
+ /**
131
+ * @internal
132
+ */
117
133
  private deserialize;
118
134
  }