Class: Aws::OpenSearchServerless::Types::IngestionStreamDetail

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

Overview

Details about an ingestion stream.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_alerts ⇒ Array<Types::IngestionAlert>

Active alerts about operational issues that currently affect the ingestion stream. Alerts are cleared when the issue is resolved.

Returns:



2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) of the ingestion stream.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#collection_id ⇒ String

The unique identifier of the collection that the ingestion stream belongs to.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when the ingestion stream was created.

Returns:

  • (Time) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#failure_index_name ⇒ String

The name of the index where documents that fail to be ingested are recorded.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasons ⇒ Array<Types::IngestionFailureReason>

The reasons that the ingestion stream reached a terminal failure state, if applicable.

Returns:



2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the index that documents are ingested into.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_stream_id ⇒ String

The unique identifier of the ingestion stream.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_stream_name ⇒ String

The name of the ingestion stream.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#revision ⇒ Integer

The revision number of the ingestion stream.

Returns:

  • (Integer) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that OpenSearch Serverless assumes to read data from the source.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::IngestionStreamSource

The Amazon S3 source that the ingestion stream ingests data from.

Returns:



2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current processing state of the ingestion stream. For example, STARTING or INGESTION_IN_PROGRESS.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Types::IngestionStatistics

Processing statistics for the ingestion stream, such as the number of Amazon S3 objects discovered, ingested, and failed.

Returns:



2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current lifecycle status of the ingestion stream. For example, CREATING, ACTIVE, or DELETING.

Returns:

  • (String) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time when the ingestion stream was last updated.

Returns:

  • (Time) 


2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2643

class IngestionStreamDetail < Struct.new(
  :ingestion_stream_id,
  :arn,
  :collection_id,
  :ingestion_stream_name,
  :index_name,
  :failure_index_name,
  :source,
  :role_arn,
  :status,
  :state,
  :statistics,
  :revision,
  :created_at,
  :updated_at,
  :failure_reasons,
  :active_alerts)
  SENSITIVE = []
  include Aws::Structure
end