Get the load action for this resource, if it is defined. :type: :py:class:`Action` or ``None``

Get the Python type name for a given model type. >>> py_type_name('list') 'list' >>> py_type_name('structure') '

Handle request parameters that can be filled in from identifiers, resource data members or constants. By passing ``params``, you can inv

Download an S3 object to a file. This method will issue a ``head_object`` request to determine the size of the S3 object. This is us

Create a resource service client by name. :type service_name: string :param service_name: The name of a service, e.g. 's3' o

Create a low-level service client by name. :type service_name: string :param service_name: The name of a service, e.g. 's3'

Load a name translation map given a shape. This will set up renamed values for any collisions, e.g. if the shape, an action,

Convenience factory function to create from a filename. :type start_byte: int :param start_byte: The first byte from which to start r

Builds a mapping of identifier names to values based on the identifier source location, type, and target. Identifier values may be scalar

This method provides a basic reverse JMESPath implementation that lets you go from a JMESPath-like string to a possibly deeply nested obj

Get a possibly renamed value given a category and name. This uses the rename map set up in ``load_rename_map``, so that metho

Get a resource collection iterator from this manager. :rtype: :py:class:`ResourceCollection` :return: An iterable representi

Create a clone of this collection. This is used by the methods below to provide a chainable interface that returns copies rat

Document an operation. The description can be overridden and certain params hidden to support documenting resource actions.

Document a nested structure (list or dict) parameter or return value as a snippet of Python code with dummy placeholders. For example:

Get a dictionary of attribute names to original name and shape models that represent the attributes of this resource. Looks l

Loads a resource from a model, creating a new :py:class:`~boto3.resources.base.ServiceResource` subclass with the correct pro

Get a list of available services that can be loaded as resource clients via :py:meth:`Session.resource`. :rtype: list

Get the default session, creating one if needed. :rtype: :py:class:`~boto3.session.Sesssion` :return: The default session

Get a ``has`` relationship definition from a model, where the service resource model is treated special in that it contains a

Get a list of sub-resources or references. :type subresources: bool :param subresources: ``True`` to get sub-resources, ``Fa

This generator yields paths to resource files in the loader's search paths. Specifically, it looks for files that end with ``

Creates an appropriate empty response for the type that is expected, based on the service model's shape type. For example, a value that i

Create a copy of this metadata object.

Generate reference documentation (low and high level) for a service by name. This generates docs for the latest available version. :type

Document a resource action, including the low-level client operation and parameters.

Get a list of available services that can be loaded as low-level clients via :py:meth:`Session.client`. :rtype: list

Get a data member from a parent using a JMESPath search query, loading the parent if required. If the parent cannot be loaded and no data

Use bcdoc to convert html to rst. :type html: string :param html: Input HTML to be converted :type indent: int :param indent: Nu

Generate a unique ID that includes the given name, a timestamp and a random number. This helps when running integration tests in parallel

Creates a new method which makes a request to the underlying AWS service.

Creates a new property on the resource to lazy-load its value via the resource's ``load`` method (if it exists).

Creates a new method which makes a batch operation request to the underlying service API.

Creates a new method which acts as a functools.partial, passing along the instance's low-level `client` to the new resource c

Creates a new property on the resource to lazy-load a collection.

Creates a new property on the resource to lazy-load a reference.

Creates a new wait method for each resource where both a waiter and resource model is defined.

Find the latest resource version of a given service if it exists, otherwise raises an exception. TODO: Merge this logic upst

Actions on the resource become methods, with the ``load`` method being a special case which sets internal data for attributes, and

Load resource attributes based on the resource shape. The shape name is referenced in the resource JSON, but the shape itself

Batch actions on the collection become methods on both the collection manager and iterators.

Load resource collections from the model. Each collection becomes a :py:class:`~boto3.resources.collection.CollectionManager` instanc

Load related resources, which are defined via a ``has`` relationship but conceptually come in two forms: 1. A reference, whi

Populate required identifiers. These are arguments without which the resource cannot be used. Identifiers become arguments for

Load a name with a given category, possibly renaming it if that name is already in use. The name will be stored in ``names``

Load resource waiters from the model. Each waiter allows you to wait until a resource reaches a specific state by polling the state

Setup loader paths so that we can load resources.

Return True if all elements of the iterable are not None (or if the iterable is empty). This is like the built-in ``all``, except checks

Creates a file in a tmpdir ``filename`` should be a relative path, e.g. "foo/bar/baz.txt" It will be translated into a full path in a

Generate low-level client documentation for a service. This generates documentation for all available operations.

Generate reference documentation about a collection and any batch actions it might have.

Generate reference documentation from a resource model.

Document a resource waiter, including the low-level client waiter and parameters.