Class: Aws::QBusiness::Types::CheckDocumentAccessRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::CheckDocumentAccessRequest

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The unique identifier of the application.

• #data_source_id ⇒ String

  The unique identifier of the data source.

• #document_id ⇒ String

  The unique identifier of the document.

• #index_id ⇒ String

  The unique identifier of the index.

• #user_id ⇒ String

  The unique identifier of the user.

Instance Attribute Details

#application_id ⇒ String

The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1655

class CheckDocumentAccessRequest < Struct.new(
  :application_id,
  :index_id,
  :user_id,
  :document_id,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#data_source_id ⇒ String

The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1655

class CheckDocumentAccessRequest < Struct.new(
  :application_id,
  :index_id,
  :user_id,
  :document_id,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#document_id ⇒ String

The unique identifier of the document. Specifies which document's access permissions are being checked.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1655

class CheckDocumentAccessRequest < Struct.new(
  :application_id,
  :index_id,
  :user_id,
  :document_id,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The unique identifier of the index. Used to locate the correct index within the application where the document is stored.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1655

class CheckDocumentAccessRequest < Struct.new(
  :application_id,
  :index_id,
  :user_id,
  :document_id,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1655

class CheckDocumentAccessRequest < Struct.new(
  :application_id,
  :index_id,
  :user_id,
  :document_id,
  :data_source_id)
  SENSITIVE = []
  include Aws::Structure
end