Class: Aws::Comprehend::Types::CreateEntityRecognizerRequest

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

Overview

Note:

When making an API call, you may pass CreateEntityRecognizerRequest data as a hash:

{
  recognizer_name: "ComprehendArnName", # required
  data_access_role_arn: "IamRoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  input_data_config: { # required
    entity_types: [ # required
      {
        type: "EntityTypeName", # required
      },
    ],
    documents: { # required
      s3_uri: "S3Uri", # required
    },
    annotations: {
      s3_uri: "S3Uri", # required
    },
    entity_list: {
      s3_uri: "S3Uri", # required
    },
  },
  client_request_token: "ClientRequestTokenString",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

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

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arnString

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::EntityRecognizerInputDataConfig

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.



901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#recognizer_nameString

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:



901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#volume_kms_key_idString

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Returns:

  • (String)


901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

Returns:



901
902
903
904
905
906
907
908
909
910
911
912
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 901

class CreateEntityRecognizerRequest < Struct.new(
  :recognizer_name,
  :data_access_role_arn,
  :tags,
  :input_data_config,
  :client_request_token,
  :language_code,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = []
  include Aws::Structure
end