Method: Aws::WorkDocs::Client#get_document

Defined in:

lib/aws-sdk-workdocs/client.rb

#get_document(params = {}) ⇒ Types::GetDocumentResponse

Retrieves details of a document.

Examples:

Request syntax with placeholder values

resp = client.get_document({
  authentication_token: "AuthenticationHeaderType",
  document_id: "ResourceIdType", # required
  include_custom_metadata: false,
})

Response structure

resp.metadata.id #=> String
resp.metadata.creator_id #=> String
resp.metadata.parent_folder_id #=> String
resp.metadata.created_timestamp #=> Time
resp.metadata.modified_timestamp #=> Time
resp.metadata.latest_version_metadata.id #=> String
resp.metadata.latest_version_metadata.name #=> String
resp.metadata.latest_version_metadata.content_type #=> String
resp.metadata.latest_version_metadata.size #=> Integer
resp.metadata.latest_version_metadata.signature #=> String
resp.metadata.latest_version_metadata.status #=> String, one of "INITIALIZED", "ACTIVE"
resp.metadata.latest_version_metadata.created_timestamp #=> Time
resp.metadata.latest_version_metadata.modified_timestamp #=> Time
resp.metadata.latest_version_metadata.content_created_timestamp #=> Time
resp.metadata.latest_version_metadata.content_modified_timestamp #=> Time
resp.metadata.latest_version_metadata.creator_id #=> String
resp.metadata.latest_version_metadata.thumbnail #=> Hash
resp.metadata.latest_version_metadata.thumbnail["DocumentThumbnailType"] #=> String
resp.metadata.latest_version_metadata.source #=> Hash
resp.metadata.latest_version_metadata.source["DocumentSourceType"] #=> String
resp.metadata.resource_state #=> String, one of "ACTIVE", "RESTORING", "RECYCLING", "RECYCLED"
resp.metadata.labels #=> Array
resp.metadata.labels[0] #=> String
resp.custom_metadata #=> Hash
resp.custom_metadata["CustomMetadataKeyType"] #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :authentication_token (String) —

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

• :document_id (required, String) —

  The ID of the document.

• :include_custom_metadata (Boolean) —

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

Returns:

• (Types::GetDocumentResponse) —

  Returns a response object which responds to the following methods:

  • #metadata => Types::DocumentMetadata

  • #custom_metadata => Hash<String,String>

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-workdocs/client.rb', line 2115

def get_document(params = {}, options = {})
  req = build_request(:get_document, params)
  req.send_request(options)
end