Class: Aws::QBusiness::Types::DocumentContent

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

Overview

Note:

DocumentContent is a union - when making an API calls you must set exactly one of the members.

The contents of a document.

Documents have size limitations. The maximum file size for a document is 50 MB. The maximum amount of text that can be extracted from a single document is 5 MB. For more information, see Supported document formats in Amazon Q Business.

See Also:

Direct Known Subclasses

Blob, S3, Unknown

Defined Under Namespace

Classes: Blob, S3, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#blob ⇒ String

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 Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

Returns:

  • (String) 


4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4069

class DocumentContent < Struct.new(
  :blob,
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Blob < DocumentContent; end
  class S3 < DocumentContent; end
  class Unknown < DocumentContent; end
end

#s3 ⇒ Types::S3

The path to the document in an Amazon S3 bucket.

Returns:



4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4069

class DocumentContent < Struct.new(
  :blob,
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Blob < DocumentContent; end
  class S3 < DocumentContent; end
  class Unknown < DocumentContent; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



4069
4070
4071
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4069

def unknown
  @unknown
end