Package software.amazon.awssdk.services.kendra.model

Class DescribeIndexResponse

    • Method Detail

      • name

        public final String name()

        The name of the index.

        Returns:
        The name of the index.

      • id

        public final String id()

        The identifier of the index.

        Returns:
        The identifier of the index.

      • edition

        public final IndexEdition edition()

        The Amazon Kendra edition used for the index. You decide the edition when you create the index.

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

        Returns:
        The Amazon Kendra edition used for the index. You decide the edition when you create the index.
        See Also:
        IndexEdition

      • editionAsString

        public final String editionAsString()

        The Amazon Kendra edition used for the index. You decide the edition when you create the index.

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

        Returns:
        The Amazon Kendra edition used for the index. You decide the edition when you create the index.
        See Also:
        IndexEdition

      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.

        Returns:
        The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.

      • serverSideEncryptionConfiguration

        public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()

        The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

        Returns:
        The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.

      • status

        public final IndexStatus status()

        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

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

        Returns:
        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
        See Also:
        IndexStatus

      • statusAsString

        public final String statusAsString()

        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

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

        Returns:
        The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
        See Also:
        IndexStatus

      • description

        public final String description()

        The description for the index.

        Returns:
        The description for the index.

      • createdAt

        public final Instant createdAt()

        The Unix timestamp when the index was created.

        Returns:
        The Unix timestamp when the index was created.

      • updatedAt

        public final Instant updatedAt()

        The Unix timestamp when the index was last updated.

        Returns:
        The Unix timestamp when the index was last updated.

      • hasDocumentMetadataConfigurations

        public final boolean hasDocumentMetadataConfigurations()
        For responses, this returns true if the service returned a value for the DocumentMetadataConfigurations 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.

      • documentMetadataConfigurations

        public final List<DocumentMetadataConfiguration> documentMetadataConfigurations()

        Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

        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 hasDocumentMetadataConfigurations() method.

        Returns:
        Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

      • indexStatistics

        public final IndexStatistics indexStatistics()

        Provides information about the number of FAQ questions and answers and the number of text documents indexed.

        Returns:
        Provides information about the number of FAQ questions and answers and the number of text documents indexed.

      • errorMessage

        public final String errorMessage()

        When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

        Returns:
        When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

      • capacityUnits

        public final CapacityUnitsConfiguration capacityUnits()

        For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

        Returns:
        For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.

      • hasUserTokenConfigurations

        public final boolean hasUserTokenConfigurations()
        For responses, this returns true if the service returned a value for the UserTokenConfigurations 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.

      • userTokenConfigurations

        public final List<UserTokenConfiguration> userTokenConfigurations()

        The user token configuration for the Amazon Kendra index.

        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 hasUserTokenConfigurations() method.

        Returns:
        The user token configuration for the Amazon Kendra index.

      • userContextPolicyAsString

        public final String userContextPolicyAsString()

        The user context policy for the Amazon Kendra index.

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

        Returns:
        The user context policy for the Amazon Kendra index.
        See Also:
        UserContextPolicy

      • userGroupResolutionConfiguration

        public final UserGroupResolutionConfiguration userGroupResolutionConfiguration()

        Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Returns:
        Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

      • 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