aws_sdk_cognitosync/client/get_bulk_publish_details.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetBulkPublishDetails`](crate::operation::get_bulk_publish_details::builders::GetBulkPublishDetailsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`identity_pool_id(impl Into<String>)`](crate::operation::get_bulk_publish_details::builders::GetBulkPublishDetailsFluentBuilder::identity_pool_id) / [`set_identity_pool_id(Option<String>)`](crate::operation::get_bulk_publish_details::builders::GetBulkPublishDetailsFluentBuilder::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>
7 /// - On success, responds with [`GetBulkPublishDetailsOutput`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsOutput) with field(s):
8 /// - [`identity_pool_id(Option<String>)`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsOutput::identity_pool_id): 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.
9 /// - [`bulk_publish_start_time(Option<DateTime>)`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsOutput::bulk_publish_start_time): The date/time at which the last bulk publish was initiated.
10 /// - [`bulk_publish_complete_time(Option<DateTime>)`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsOutput::bulk_publish_complete_time): If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
11 /// - [`bulk_publish_status(Option<BulkPublishStatus>)`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsOutput::bulk_publish_status): Status of the last bulk publish operation, valid values are: <p>NOT_STARTED - No bulk publish has been requested for this identity pool</p> <p>IN_PROGRESS - Data is being published to the configured stream</p> <p>SUCCEEDED - All data for the identity pool has been published to the configured stream</p> <p>FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.</p>
12 /// - [`failure_message(Option<String>)`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsOutput::failure_message): If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
13 /// - On failure, responds with [`SdkError<GetBulkPublishDetailsError>`](crate::operation::get_bulk_publish_details::GetBulkPublishDetailsError)
14 pub fn get_bulk_publish_details(&self) -> crate::operation::get_bulk_publish_details::builders::GetBulkPublishDetailsFluentBuilder {
15 crate::operation::get_bulk_publish_details::builders::GetBulkPublishDetailsFluentBuilder::new(self.handle.clone())
16 }
17}