Document

public struct Document : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Information to use for user context filtering.

    Declaration

    Swift

    public let accessControlList: [Principal]?

  • Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

    Declaration

    Swift

    public let attributes: [DocumentAttribute]?

  • The contents of the document. Documents passed to the Blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you’re using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

    Declaration

    Swift

    public let blob: Data?

  • The file type of the document in the Blob field.

    Declaration

    Swift

    public let contentType: ContentType?
  • id

    A unique identifier of the document in the index.

    Declaration

    Swift

    public let id: String

  • Undocumented

    Declaration

    Swift

    public let s3Path: S3Path?

  • The title of the document.

    Declaration

    Swift

    public let title: String?

  • Undocumented

    Declaration

    Swift

    public init(accessControlList: [Principal]? = nil, attributes: [DocumentAttribute]? = nil, blob: Data? = nil, contentType: ContentType? = nil, id: String, s3Path: S3Path? = nil, title: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws