Package software.amazon.awssdk.services.wisdom.model

Class CreateKnowledgeBaseRequest

    • Method Detail

      • clientToken

        public final String clientToken()

        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

        Returns:
        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      • description

        public final String description()

        The description.

        Returns:
        The description.

      • knowledgeBaseType

        public final KnowledgeBaseType knowledgeBaseType()

        The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

        If the service returns an enum value that is not available in the current SDK version, knowledgeBaseType will return KnowledgeBaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseTypeAsString().

        Returns:
        The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
        See Also:
        KnowledgeBaseType

      • knowledgeBaseTypeAsString

        public final String knowledgeBaseTypeAsString()

        The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

        If the service returns an enum value that is not available in the current SDK version, knowledgeBaseType will return KnowledgeBaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseTypeAsString().

        Returns:
        The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
        See Also:
        KnowledgeBaseType

      • name

        public final String name()

        The name of the knowledge base.

        Returns:
        The name of the knowledge base.

      • renderingConfiguration

        public final RenderingConfiguration renderingConfiguration()

        Information about how to render the content.

        Returns:
        Information about how to render the content.

      • serverSideEncryptionConfiguration

        public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.

        For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.

        Returns:
        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.

        For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.

      • sourceConfiguration

        public final SourceConfiguration sourceConfiguration()

        The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

        Returns:
        The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        The tags used to organize, track, or control access for this resource.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags used to organize, track, or control access for this resource.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object