Class: Aws::OpenSearchServerless::Types::CreateIngestionJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::CreateIngestionJobRequest

Defined in:

gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier to ensure idempotency of the request.

• #collection_id ⇒ String

  The unique identifier of the collection to ingest data into.

• #failure_index_name ⇒ String

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

• #index_name ⇒ String

  The name of the index to ingest documents into.

• #ingestion_job_name ⇒ String

  The name of the ingestion job.

• #source ⇒ Types::IngestionJobSource

  The Amazon S3 source to ingest data from.

• #tags ⇒ Array<Types::Tag>

  An arbitrary set of tags (key–value pairs) to associate with the ingestion job.

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier to ensure idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#collection_id ⇒ String

The unique identifier of the collection to ingest data into.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  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)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the index to ingest documents into.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_job_name ⇒ String

The name of the ingestion job. The name must be unique within the collection.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::IngestionJobSource

The Amazon S3 source to ingest data from.

Returns:

• (Types::IngestionJobSource)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An arbitrary set of tags (key–value pairs) to associate with the ingestion job.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 1215

class CreateIngestionJobRequest < Struct.new(
  :collection_id,
  :ingestion_job_name,
  :index_name,
  :failure_index_name,
  :source,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end