You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkDocs::Types::GetDocumentRequest

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

Overview

Note:

When making an API call, you may pass GetDocumentRequest data as a hash:

{
  authentication_token: "AuthenticationHeaderType",
  document_id: "ResourceIdType", # required
  include_custom_metadata: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

  • (String)


1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1731

class GetDocumentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :include_custom_metadata)
  include Aws::Structure
end

#document_idString

The ID of the document.

Returns:

  • (String)


1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1731

class GetDocumentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :include_custom_metadata)
  include Aws::Structure
end

#include_custom_metadataBoolean

Set this to TRUE to include custom metadata in the response.

Returns:

  • (Boolean)


1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1731

class GetDocumentRequest < Struct.new(
  :authentication_token,
  :document_id,
  :include_custom_metadata)
  include Aws::Structure
end