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,
}

Constant Summary collapse

SENSITIVE =
[:authentication_token]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_tokenString

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

Returns:

  • (String)


1989
1990
1991
1992
1993
1994
1995
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1989

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

#document_idString

The ID of the document.

Returns:

  • (String)


1989
1990
1991
1992
1993
1994
1995
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1989

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

#include_custom_metadataBoolean

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

Returns:

  • (Boolean)


1989
1990
1991
1992
1993
1994
1995
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/types.rb', line 1989

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