You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoSync::Types::GetBulkPublishDetailsResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb

Overview

The output for the GetBulkPublishDetails operation.

Instance Attribute Summary collapse

Instance Attribute Details

#bulk_publish_complete_timeTime

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

Returns:

  • (Time)


385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 385

class GetBulkPublishDetailsResponse < Struct.new(
  :identity_pool_id,
  :bulk_publish_start_time,
  :bulk_publish_complete_time,
  :bulk_publish_status,
  :failure_message)
  include Aws::Structure
end

#bulk_publish_start_timeTime

The date/time at which the last bulk publish was initiated.

Returns:

  • (Time)


385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 385

class GetBulkPublishDetailsResponse < Struct.new(
  :identity_pool_id,
  :bulk_publish_start_time,
  :bulk_publish_complete_time,
  :bulk_publish_status,
  :failure_message)
  include Aws::Structure
end

#bulk_publish_statusString

Status of the last bulk publish operation, valid values are: NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Returns:

  • (String)


385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 385

class GetBulkPublishDetailsResponse < Struct.new(
  :identity_pool_id,
  :bulk_publish_start_time,
  :bulk_publish_complete_time,
  :bulk_publish_status,
  :failure_message)
  include Aws::Structure
end

#failure_messageString

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

Returns:

  • (String)


385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 385

class GetBulkPublishDetailsResponse < Struct.new(
  :identity_pool_id,
  :bulk_publish_start_time,
  :bulk_publish_complete_time,
  :bulk_publish_status,
  :failure_message)
  include Aws::Structure
end

#identity_pool_idString

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.

Returns:

  • (String)


385
386
387
388
389
390
391
392
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 385

class GetBulkPublishDetailsResponse < Struct.new(
  :identity_pool_id,
  :bulk_publish_start_time,
  :bulk_publish_complete_time,
  :bulk_publish_status,
  :failure_message)
  include Aws::Structure
end