| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CognitoSync.DescribeDataset
Description
Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.
Synopsis
- data DescribeDataset = DescribeDataset' {
- identityPoolId :: Text
- identityId :: Text
- datasetName :: Text
- newDescribeDataset :: Text -> Text -> Text -> DescribeDataset
- describeDataset_identityPoolId :: Lens' DescribeDataset Text
- describeDataset_identityId :: Lens' DescribeDataset Text
- describeDataset_datasetName :: Lens' DescribeDataset Text
- data DescribeDatasetResponse = DescribeDatasetResponse' {
- dataset :: Maybe Dataset
- httpStatus :: Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- describeDatasetResponse_dataset :: Lens' DescribeDatasetResponse (Maybe Dataset)
- describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int
Creating a Request
data DescribeDataset Source #
A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name.
See: newDescribeDataset smart constructor.
Constructors
| DescribeDataset' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> DescribeDataset |
Create a value of DescribeDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityPoolId:DescribeDataset', describeDataset_identityPoolId - A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
Cognito. GUID generation is unique within a region.
$sel:identityId:DescribeDataset', describeDataset_identityId - A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
Cognito. GUID generation is unique within a region.
$sel:datasetName:DescribeDataset', describeDataset_datasetName - A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9,
'_' (underscore), '-' (dash), and '.' (dot).
Request Lenses
describeDataset_identityPoolId :: Lens' DescribeDataset Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
describeDataset_identityId :: Lens' DescribeDataset Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
describeDataset_datasetName :: Lens' DescribeDataset Text Source #
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
Destructuring the Response
data DescribeDatasetResponse Source #
Response to a successful DescribeDataset request.
See: newDescribeDatasetResponse smart constructor.
Constructors
| DescribeDatasetResponse' | |
Fields
| |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataset:DescribeDatasetResponse', describeDatasetResponse_dataset - Meta data for a collection of data for an identity. An identity can have
multiple datasets. A dataset can be general or associated with a
particular entity in an application (like a saved game). Datasets are
automatically created if they don't exist. Data is synced by dataset,
and a dataset can hold up to 1MB of key-value pairs.
$sel:httpStatus:DescribeDatasetResponse', describeDatasetResponse_httpStatus - The response's http status code.
Response Lenses
describeDatasetResponse_dataset :: Lens' DescribeDatasetResponse (Maybe Dataset) Source #
Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.
describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #
The response's http status code.