Class: Aws::Textract::Types::CreateProjectRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you use the same token for a request that matches a previous request, the service ignores the request, but does not return an error.

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

Returns:

  • (String)


1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_configuration ⇒ Types::CustomConfiguration

The configuration that associates blueprints with the project for custom output extraction.



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

The AWS KMS encryption configuration used to encrypt the project at rest. If you don't specify a value, Amazon Textract encrypts the project using an AWS owned key.



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#extraction_configuration ⇒ Types::ExtractionConfiguration

The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#generative_configuration ⇒ Types::GenerativeConfiguration

The configuration that controls generative capabilities such as summarization and figure captioning.



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#project_description ⇒ String

A description of the project.

Returns:

  • (String)


1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#project_name ⇒ String

A unique name for the project.

Returns:

  • (String)


1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#sensitive_data_configuration ⇒ Types::SensitiveDataConfiguration

The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#splitter_configuration ⇒ Types::SplitterConfiguration

The configuration that controls whether multi-document packets are split into individual documents.



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of tags (key-value pairs) to assign to the project.

Returns:

  • (Hash<String,String>)


1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1109

class CreateProjectRequest < Struct.new(
  :client_request_token,
  :project_name,
  :project_description,
  :extraction_configuration,
  :generative_configuration,
  :custom_configuration,
  :splitter_configuration,
  :sensitive_data_configuration,
  :encryption_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end