Package software.amazon.awssdk.services.comprehend.model

Interface ImportModelRequest.Builder

    • Method Detail

      • sourceModelArn

        ImportModelRequest.Builder sourceModelArn​(String sourceModelArn)

        The Amazon Resource Name (ARN) of the custom model to import.

        Parameters:
        sourceModelArn - The Amazon Resource Name (ARN) of the custom model to import.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelName

        ImportModelRequest.Builder modelName​(String modelName)

        The name to assign to the custom model that is created in Amazon Comprehend by this import.

        Parameters:
        modelName - The name to assign to the custom model that is created in Amazon Comprehend by this import.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionName

        ImportModelRequest.Builder versionName​(String versionName)

        The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.

        Parameters:
        versionName - The version name given to the custom model that is created by this import. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the account/Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelKmsKeyId

        ImportModelRequest.Builder modelKmsKeyId​(String modelKmsKeyId)

        ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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"

        Parameters:
        modelKmsKeyId - ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

        ImportModelRequest.Builder dataAccessRoleArn​(String dataAccessRoleArn)

        The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

        Parameters:
        dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ImportModelRequest.Builder tags​(Collection<Tag> tags)

        Tags to associate with the custom model that is created by this import. 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.

        Parameters:
        tags - Tags to associate with the custom model that is created by this import. 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:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ImportModelRequest.Builder tags​(Tag... tags)

        Tags to associate with the custom model that is created by this import. 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.

        Parameters:
        tags - Tags to associate with the custom model that is created by this import. 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:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        ImportModelRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Tags to associate with the custom model that is created by this import. 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.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)