boto3.docs.action

Module Contents

class ActionDocumenter

Bases:boto3.docs.base.BaseDocumenter

document_actions(self, section)
document_action(section, resource_name, event_emitter, action_model, service_model, include_signature=True)

Documents a resource action

Parameters:
  • section – The section to write to
  • resource_name – The name of the resource
  • event_emitter – The event emitter to use to emit events
  • action_model – The model of the action
  • service_model – The model of the service
  • include_signature – Whether or not to include the signature. It is useful for generating docstrings.
document_load_reload_action(section, action_name, resource_name, event_emitter, load_model, service_model, include_signature=True)

Documents the resource load action

Parameters:
  • section – The section to write to
  • action_name – The name of the loading action should be load or reload
  • resource_name – The name of the resource
  • event_emitter – The event emitter to use to emit events
  • load_model – The model of the load action
  • service_model – The model of the service
  • include_signature – Whether or not to include the signature. It is useful for generating docstrings.