boto3.docs.collection

Module Contents

class CollectionDocumenter

Bases:boto3.docs.base.BaseDocumenter

document_collections(self, section)
_document_collection(self, section, collection)
document_collection_object(section, collection_model, include_signature=True)

Documents a collection resource object

Parameters:
  • section – The section to write to
  • collection_model – The model of the collection
  • include_signature – Whether or not to include the signature. It is useful for generating docstrings.
document_batch_action(section, resource_name, event_emitter, batch_action_model, service_model, collection_model, include_signature=True)

Documents a collection’s batch action

Parameters:
  • section – The section to write to
  • resource_name – The name of the resource
  • action_name – The name of collection action. Currently only can be all, filter, limit, or page_size
  • event_emitter – The event emitter to use to emit events
  • batch_action_model – The model of the batch action
  • collection_model – The model of the collection
  • service_model – The model of the service
  • include_signature – Whether or not to include the signature. It is useful for generating docstrings.
document_collection_method(section, resource_name, action_name, event_emitter, collection_model, service_model, include_signature=True)

Documents a collection method

Parameters:
  • section – The section to write to
  • resource_name – The name of the resource
  • action_name – The name of collection action. Currently only can be all, filter, limit, or page_size
  • event_emitter – The event emitter to use to emit events
  • collection_model – The model of the collection
  • service_model – The model of the service
  • include_signature – Whether or not to include the signature. It is useful for generating docstrings.