aws_sdk_cognitosync/client/

describe_dataset.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeDataset`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`identity_pool_id(impl Into<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::identity_pool_id) / [`set_identity_pool_id(Option<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::set_identity_pool_id):<br>required: **true**<br>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.<br>
    ///   - [`identity_id(impl Into<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::identity_id) / [`set_identity_id(Option<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::set_identity_id):<br>required: **true**<br>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.<br>
    ///   - [`dataset_name(impl Into<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::dataset_name) / [`set_dataset_name(Option<String>)`](crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::set_dataset_name):<br>required: **true**<br>A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).<br>
    /// - On success, responds with [`DescribeDatasetOutput`](crate::operation::describe_dataset::DescribeDatasetOutput) with field(s):
    ///   - [`dataset(Option<Dataset>)`](crate::operation::describe_dataset::DescribeDatasetOutput::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.
    /// - On failure, responds with [`SdkError<DescribeDatasetError>`](crate::operation::describe_dataset::DescribeDatasetError)
    pub fn describe_dataset(&self) -> crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder {
        crate::operation::describe_dataset::builders::DescribeDatasetFluentBuilder::new(self.handle.clone())
    }
}