mypy-boto3-ram


Namemypy-boto3-ram JSON
Version 1.27.0 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for boto3.RAM 1.27.0 service generated with mypy-boto3-builder 7.14.5
upload_time2023-07-03 20:02:00
maintainer
docs_urlNone
authorVlad Emelianov
requires_python>=3.7
licenseMIT License
keywords boto3 ram type-annotations boto3-stubs mypy typeshed autocomplete
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <a id="mypy-boto3-ram"></a>

# mypy-boto3-ram

[![PyPI - mypy-boto3-ram](https://img.shields.io/pypi/v/mypy-boto3-ram.svg?color=blue)](https://pypi.org/project/mypy-boto3-ram)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ram.svg?color=blue)](https://pypi.org/project/mypy-boto3-ram)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-ram?color=blue)](https://pypistats.org/packages/mypy-boto3-ram)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[boto3.RAM 1.27.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ram.html#RAM)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.

Generated by
[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-ram docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/).

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [mypy-boto3-ram](#mypy-boto3-ram)
  - [How to install](#how-to-install)
    - [VSCode extension](#vscode-extension)
    - [From PyPI with pip](#from-pypi-with-pip)
  - [How to uninstall](#how-to-uninstall)
  - [Usage](#usage)
    - [VSCode](#vscode)
    - [PyCharm](#pycharm)
    - [Emacs](#emacs)
    - [Sublime Text](#sublime-text)
    - [Other IDEs](#other-ides)
    - [mypy](#mypy)
    - [pyright](#pyright)
  - [Explicit type annotations](#explicit-type-annotations)
    - [Client annotations](#client-annotations)
    - [Paginators annotations](#paginators-annotations)
    - [Literals](#literals)
    - [Typed dictionaries](#typed-dictionaries)
  - [How it works](#how-it-works)
  - [What's new](#what's-new)
    - [Implemented features](#implemented-features)
    - [Latest changes](#latest-changes)
  - [Versioning](#versioning)
  - [Thank you](#thank-you)
  - [Documentation](#documentation)
  - [Support and contributing](#support-and-contributing)

<a id="how-to-install"></a>

## How to install

<a id="vscode-extension"></a>

### VSCode extension

Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.

Click `Modify` and select `boto3 common` and `RAM`.

<a id="from-pypi-with-pip"></a>

### From PyPI with pip

Install `boto3-stubs` for `RAM` service.

```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ram]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ram]'


# standalone installation
python -m pip install mypy-boto3-ram
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y mypy-boto3-ram
```

<a id="usage"></a>

## Usage

<a id="vscode"></a>

### VSCode

- Install
  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs[ram]` in your environment:

```bash
python -m pip install 'boto3-stubs[ram]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.

<a id="pycharm"></a>

### PyCharm

Install `boto3-stubs-lite[ram]` in your environment:

```bash
python -m pip install 'boto3-stubs-lite[ram]'`
```

Both type checking and code completion should now work. Explicit type
annotations **are required**.

Use `boto3-stubs` package instead for implicit type discovery.

<a id="emacs"></a>

### Emacs

- Install `boto3-stubs` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[ram]'
```

- Install [use-package](https://github.com/jwiegley/use-package),
  [lsp](https://github.com/emacs-lsp/lsp-mode/),
  [company](https://github.com/company-mode/company-mode) and
  [flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

```elisp
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
```

- Make sure emacs uses the environment where you have installed `boto3-stubs`

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `boto3-stubs[ram]` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[ram]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="other-ides"></a>

### Other IDEs

Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.

<a id="mypy"></a>

### mypy

- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[ram]` in your environment:

```bash
python -m pip install 'boto3-stubs[ram]'`
```

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[ram]` in your environment:

```bash
python -m pip install 'boto3-stubs[ram]'
```

Optionally, you can install `boto3-stubs` to `typings` folder.

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`RAMClient` provides annotations for `boto3.client("ram")`.

```python
from boto3.session import Session

from mypy_boto3_ram import RAMClient

client: RAMClient = Session().client("ram")

# now client usage is checked by mypy and IDE should provide code completion
```

<a id="paginators-annotations"></a>

### Paginators annotations

`mypy_boto3_ram.paginator` module contains type annotations for all paginators.

```python
from boto3.session import Session

from mypy_boto3_ram import RAMClient
from mypy_boto3_ram.paginator import (
    GetResourcePoliciesPaginator,
    GetResourceShareAssociationsPaginator,
    GetResourceShareInvitationsPaginator,
    GetResourceSharesPaginator,
    ListPrincipalsPaginator,
    ListResourcesPaginator,
)

client: RAMClient = Session().client("ram")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
get_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(
    "get_resource_policies"
)
get_resource_share_associations_paginator: GetResourceShareAssociationsPaginator = (
    client.get_paginator("get_resource_share_associations")
)
get_resource_share_invitations_paginator: GetResourceShareInvitationsPaginator = (
    client.get_paginator("get_resource_share_invitations")
)
get_resource_shares_paginator: GetResourceSharesPaginator = client.get_paginator(
    "get_resource_shares"
)
list_principals_paginator: ListPrincipalsPaginator = client.get_paginator("list_principals")
list_resources_paginator: ListResourcesPaginator = client.get_paginator("list_resources")
```

<a id="literals"></a>

### Literals

`mypy_boto3_ram.literals` module contains literals extracted from shapes that
can be used in user code for type checking.

```python
from mypy_boto3_ram.literals import (
    GetResourcePoliciesPaginatorName,
    GetResourceShareAssociationsPaginatorName,
    GetResourceShareInvitationsPaginatorName,
    GetResourceSharesPaginatorName,
    ListPrincipalsPaginatorName,
    ListResourcesPaginatorName,
    PermissionFeatureSetType,
    PermissionStatusType,
    PermissionTypeFilterType,
    PermissionTypeType,
    ReplacePermissionAssociationsWorkStatusType,
    ResourceOwnerType,
    ResourceRegionScopeFilterType,
    ResourceRegionScopeType,
    ResourceShareAssociationStatusType,
    ResourceShareAssociationTypeType,
    ResourceShareFeatureSetType,
    ResourceShareInvitationStatusType,
    ResourceShareStatusType,
    ResourceStatusType,
    RAMServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    RegionName,
)


def check_value(value: GetResourcePoliciesPaginatorName) -> bool:
    ...
```

<a id="typed-dictionaries"></a>

### Typed dictionaries

`mypy_boto3_ram.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.

```python
from mypy_boto3_ram.type_defs import (
    AcceptResourceShareInvitationRequestRequestTypeDef,
    AssociateResourceSharePermissionRequestRequestTypeDef,
    AssociateResourceSharePermissionResponseTypeDef,
    AssociateResourceShareRequestRequestTypeDef,
    ResourceShareAssociationTypeDef,
    AssociatedPermissionTypeDef,
    TagTypeDef,
    CreatePermissionVersionRequestRequestTypeDef,
    DeletePermissionRequestRequestTypeDef,
    DeletePermissionResponseTypeDef,
    DeletePermissionVersionRequestRequestTypeDef,
    DeletePermissionVersionResponseTypeDef,
    DeleteResourceShareRequestRequestTypeDef,
    DeleteResourceShareResponseTypeDef,
    DisassociateResourceSharePermissionRequestRequestTypeDef,
    DisassociateResourceSharePermissionResponseTypeDef,
    DisassociateResourceShareRequestRequestTypeDef,
    EnableSharingWithAwsOrganizationResponseTypeDef,
    GetPermissionRequestRequestTypeDef,
    GetResourcePoliciesRequestGetResourcePoliciesPaginateTypeDef,
    GetResourcePoliciesRequestRequestTypeDef,
    GetResourcePoliciesResponseTypeDef,
    GetResourceShareAssociationsRequestGetResourceShareAssociationsPaginateTypeDef,
    GetResourceShareAssociationsRequestRequestTypeDef,
    GetResourceShareInvitationsRequestGetResourceShareInvitationsPaginateTypeDef,
    GetResourceShareInvitationsRequestRequestTypeDef,
    TagFilterTypeDef,
    ListPendingInvitationResourcesRequestRequestTypeDef,
    ResourceTypeDef,
    ListPermissionAssociationsRequestRequestTypeDef,
    ListPermissionVersionsRequestRequestTypeDef,
    ListPermissionsRequestRequestTypeDef,
    ListPrincipalsRequestListPrincipalsPaginateTypeDef,
    ListPrincipalsRequestRequestTypeDef,
    PrincipalTypeDef,
    ListReplacePermissionAssociationsWorkRequestRequestTypeDef,
    ReplacePermissionAssociationsWorkTypeDef,
    ListResourceSharePermissionsRequestRequestTypeDef,
    ListResourceTypesRequestRequestTypeDef,
    ServiceNameAndResourceTypeTypeDef,
    ListResourcesRequestListResourcesPaginateTypeDef,
    ListResourcesRequestRequestTypeDef,
    PaginatorConfigTypeDef,
    PromotePermissionCreatedFromPolicyRequestRequestTypeDef,
    PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef,
    PromoteResourceShareCreatedFromPolicyResponseTypeDef,
    RejectResourceShareInvitationRequestRequestTypeDef,
    ReplacePermissionAssociationsRequestRequestTypeDef,
    ResponseMetadataTypeDef,
    SetDefaultPermissionVersionRequestRequestTypeDef,
    SetDefaultPermissionVersionResponseTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateResourceShareRequestRequestTypeDef,
    AssociateResourceShareResponseTypeDef,
    DisassociateResourceShareResponseTypeDef,
    GetResourceShareAssociationsResponseTypeDef,
    ResourceShareInvitationTypeDef,
    ListPermissionAssociationsResponseTypeDef,
    CreatePermissionRequestRequestTypeDef,
    CreateResourceShareRequestRequestTypeDef,
    ResourceSharePermissionDetailTypeDef,
    ResourceSharePermissionSummaryTypeDef,
    ResourceShareTypeDef,
    TagResourceRequestRequestTypeDef,
    GetResourceSharesRequestGetResourceSharesPaginateTypeDef,
    GetResourceSharesRequestRequestTypeDef,
    ListPendingInvitationResourcesResponseTypeDef,
    ListResourcesResponseTypeDef,
    ListPrincipalsResponseTypeDef,
    ListReplacePermissionAssociationsWorkResponseTypeDef,
    ReplacePermissionAssociationsResponseTypeDef,
    ListResourceTypesResponseTypeDef,
    AcceptResourceShareInvitationResponseTypeDef,
    GetResourceShareInvitationsResponseTypeDef,
    RejectResourceShareInvitationResponseTypeDef,
    CreatePermissionVersionResponseTypeDef,
    GetPermissionResponseTypeDef,
    CreatePermissionResponseTypeDef,
    ListPermissionVersionsResponseTypeDef,
    ListPermissionsResponseTypeDef,
    ListResourceSharePermissionsResponseTypeDef,
    PromotePermissionCreatedFromPolicyResponseTypeDef,
    CreateResourceShareResponseTypeDef,
    GetResourceSharesResponseTypeDef,
    UpdateResourceShareResponseTypeDef,
)


def get_structure() -> AcceptResourceShareInvitationRequestRequestTypeDef:
    return {...}
```

<a id="how-it-works"></a>

## How it works

Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:

- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
  annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
  [isort](https://github.com/PyCQA/isort) for readability.

<a id="what's-new"></a>

## What's new

<a id="implemented-features"></a>

### Implemented features

- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
  libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
  compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
  annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
  calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls

<a id="latest-changes"></a>

### Latest changes

Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).

<a id="versioning"></a>

## Versioning

`mypy-boto3-ram` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.

<a id="thank-you"></a>

## Thank you

- [Allie Fitter](https://github.com/alliefitter) for
  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
  this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
  tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
  [isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
  for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
  Python

<a id="documentation"></a>

## Documentation

All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/)

<a id="support-and-contributing"></a>

## Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/youtype/mypy_boto3_builder",
    "name": "mypy-boto3-ram",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "boto3 ram type-annotations boto3-stubs mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f2/e1/a1be1d99f6cf3e76b8138792d56b491a1fb07c944babf21d6419f46b89bb/mypy-boto3-ram-1.27.0.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3-ram\"></a>\n\n# mypy-boto3-ram\n\n[![PyPI - mypy-boto3-ram](https://img.shields.io/pypi/v/mypy-boto3-ram.svg?color=blue)](https://pypi.org/project/mypy-boto3-ram)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ram.svg?color=blue)](https://pypi.org/project/mypy-boto3-ram)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-ram?color=blue)](https://pypistats.org/packages/mypy-boto3-ram)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3.RAM 1.27.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ram.html#RAM)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in\n[mypy-boto3-ram docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-ram](#mypy-boto3-ram)\n  - [How to install](#how-to-install)\n    - [VSCode extension](#vscode-extension)\n    - [From PyPI with pip](#from-pypi-with-pip)\n  - [How to uninstall](#how-to-uninstall)\n  - [Usage](#usage)\n    - [VSCode](#vscode)\n    - [PyCharm](#pycharm)\n    - [Emacs](#emacs)\n    - [Sublime Text](#sublime-text)\n    - [Other IDEs](#other-ides)\n    - [mypy](#mypy)\n    - [pyright](#pyright)\n  - [Explicit type annotations](#explicit-type-annotations)\n    - [Client annotations](#client-annotations)\n    - [Paginators annotations](#paginators-annotations)\n    - [Literals](#literals)\n    - [Typed dictionaries](#typed-dictionaries)\n  - [How it works](#how-it-works)\n  - [What's new](#what's-new)\n    - [Implemented features](#implemented-features)\n    - [Latest changes](#latest-changes)\n  - [Versioning](#versioning)\n  - [Thank you](#thank-you)\n  - [Documentation](#documentation)\n  - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `RAM`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `RAM` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[ram]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[ram]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-ram\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-ram\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs[ram]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ram]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `boto3-stubs-lite[ram]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[ram]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `boto3-stubs` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ram]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n  [lsp](https://github.com/emacs-lsp/lsp-mode/),\n  [company](https://github.com/company-mode/company-mode) and\n  [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n  :ensure t\n  :hook (python-mode . (lambda ()\n                          (require 'lsp-pyright)\n                          (lsp)))  ; or lsp-deferred\n  :init (when (executable-find \"python3\")\n          (setq lsp-pyright-python-executable-cmd \"python3\"))\n  )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `boto3-stubs[ram]` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ram]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[ram]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ram]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[ram]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ram]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`RAMClient` provides annotations for `boto3.client(\"ram\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ram import RAMClient\n\nclient: RAMClient = Session().client(\"ram\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`mypy_boto3_ram.paginator` module contains type annotations for all paginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ram import RAMClient\nfrom mypy_boto3_ram.paginator import (\n    GetResourcePoliciesPaginator,\n    GetResourceShareAssociationsPaginator,\n    GetResourceShareInvitationsPaginator,\n    GetResourceSharesPaginator,\n    ListPrincipalsPaginator,\n    ListResourcesPaginator,\n)\n\nclient: RAMClient = Session().client(\"ram\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nget_resource_policies_paginator: GetResourcePoliciesPaginator = client.get_paginator(\n    \"get_resource_policies\"\n)\nget_resource_share_associations_paginator: GetResourceShareAssociationsPaginator = (\n    client.get_paginator(\"get_resource_share_associations\")\n)\nget_resource_share_invitations_paginator: GetResourceShareInvitationsPaginator = (\n    client.get_paginator(\"get_resource_share_invitations\")\n)\nget_resource_shares_paginator: GetResourceSharesPaginator = client.get_paginator(\n    \"get_resource_shares\"\n)\nlist_principals_paginator: ListPrincipalsPaginator = client.get_paginator(\"list_principals\")\nlist_resources_paginator: ListResourcesPaginator = client.get_paginator(\"list_resources\")\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_ram.literals` module contains literals extracted from shapes that\ncan be used in user code for type checking.\n\n```python\nfrom mypy_boto3_ram.literals import (\n    GetResourcePoliciesPaginatorName,\n    GetResourceShareAssociationsPaginatorName,\n    GetResourceShareInvitationsPaginatorName,\n    GetResourceSharesPaginatorName,\n    ListPrincipalsPaginatorName,\n    ListResourcesPaginatorName,\n    PermissionFeatureSetType,\n    PermissionStatusType,\n    PermissionTypeFilterType,\n    PermissionTypeType,\n    ReplacePermissionAssociationsWorkStatusType,\n    ResourceOwnerType,\n    ResourceRegionScopeFilterType,\n    ResourceRegionScopeType,\n    ResourceShareAssociationStatusType,\n    ResourceShareAssociationTypeType,\n    ResourceShareFeatureSetType,\n    ResourceShareInvitationStatusType,\n    ResourceShareStatusType,\n    ResourceStatusType,\n    RAMServiceName,\n    ServiceName,\n    ResourceServiceName,\n    PaginatorName,\n    RegionName,\n)\n\n\ndef check_value(value: GetResourcePoliciesPaginatorName) -> bool:\n    ...\n```\n\n<a id=\"typed-dictionaries\"></a>\n\n### Typed dictionaries\n\n`mypy_boto3_ram.type_defs` module contains structures and shapes assembled to\ntyped dictionaries for additional type checking.\n\n```python\nfrom mypy_boto3_ram.type_defs import (\n    AcceptResourceShareInvitationRequestRequestTypeDef,\n    AssociateResourceSharePermissionRequestRequestTypeDef,\n    AssociateResourceSharePermissionResponseTypeDef,\n    AssociateResourceShareRequestRequestTypeDef,\n    ResourceShareAssociationTypeDef,\n    AssociatedPermissionTypeDef,\n    TagTypeDef,\n    CreatePermissionVersionRequestRequestTypeDef,\n    DeletePermissionRequestRequestTypeDef,\n    DeletePermissionResponseTypeDef,\n    DeletePermissionVersionRequestRequestTypeDef,\n    DeletePermissionVersionResponseTypeDef,\n    DeleteResourceShareRequestRequestTypeDef,\n    DeleteResourceShareResponseTypeDef,\n    DisassociateResourceSharePermissionRequestRequestTypeDef,\n    DisassociateResourceSharePermissionResponseTypeDef,\n    DisassociateResourceShareRequestRequestTypeDef,\n    EnableSharingWithAwsOrganizationResponseTypeDef,\n    GetPermissionRequestRequestTypeDef,\n    GetResourcePoliciesRequestGetResourcePoliciesPaginateTypeDef,\n    GetResourcePoliciesRequestRequestTypeDef,\n    GetResourcePoliciesResponseTypeDef,\n    GetResourceShareAssociationsRequestGetResourceShareAssociationsPaginateTypeDef,\n    GetResourceShareAssociationsRequestRequestTypeDef,\n    GetResourceShareInvitationsRequestGetResourceShareInvitationsPaginateTypeDef,\n    GetResourceShareInvitationsRequestRequestTypeDef,\n    TagFilterTypeDef,\n    ListPendingInvitationResourcesRequestRequestTypeDef,\n    ResourceTypeDef,\n    ListPermissionAssociationsRequestRequestTypeDef,\n    ListPermissionVersionsRequestRequestTypeDef,\n    ListPermissionsRequestRequestTypeDef,\n    ListPrincipalsRequestListPrincipalsPaginateTypeDef,\n    ListPrincipalsRequestRequestTypeDef,\n    PrincipalTypeDef,\n    ListReplacePermissionAssociationsWorkRequestRequestTypeDef,\n    ReplacePermissionAssociationsWorkTypeDef,\n    ListResourceSharePermissionsRequestRequestTypeDef,\n    ListResourceTypesRequestRequestTypeDef,\n    ServiceNameAndResourceTypeTypeDef,\n    ListResourcesRequestListResourcesPaginateTypeDef,\n    ListResourcesRequestRequestTypeDef,\n    PaginatorConfigTypeDef,\n    PromotePermissionCreatedFromPolicyRequestRequestTypeDef,\n    PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef,\n    PromoteResourceShareCreatedFromPolicyResponseTypeDef,\n    RejectResourceShareInvitationRequestRequestTypeDef,\n    ReplacePermissionAssociationsRequestRequestTypeDef,\n    ResponseMetadataTypeDef,\n    SetDefaultPermissionVersionRequestRequestTypeDef,\n    SetDefaultPermissionVersionResponseTypeDef,\n    UntagResourceRequestRequestTypeDef,\n    UpdateResourceShareRequestRequestTypeDef,\n    AssociateResourceShareResponseTypeDef,\n    DisassociateResourceShareResponseTypeDef,\n    GetResourceShareAssociationsResponseTypeDef,\n    ResourceShareInvitationTypeDef,\n    ListPermissionAssociationsResponseTypeDef,\n    CreatePermissionRequestRequestTypeDef,\n    CreateResourceShareRequestRequestTypeDef,\n    ResourceSharePermissionDetailTypeDef,\n    ResourceSharePermissionSummaryTypeDef,\n    ResourceShareTypeDef,\n    TagResourceRequestRequestTypeDef,\n    GetResourceSharesRequestGetResourceSharesPaginateTypeDef,\n    GetResourceSharesRequestRequestTypeDef,\n    ListPendingInvitationResourcesResponseTypeDef,\n    ListResourcesResponseTypeDef,\n    ListPrincipalsResponseTypeDef,\n    ListReplacePermissionAssociationsWorkResponseTypeDef,\n    ReplacePermissionAssociationsResponseTypeDef,\n    ListResourceTypesResponseTypeDef,\n    AcceptResourceShareInvitationResponseTypeDef,\n    GetResourceShareInvitationsResponseTypeDef,\n    RejectResourceShareInvitationResponseTypeDef,\n    CreatePermissionVersionResponseTypeDef,\n    GetPermissionResponseTypeDef,\n    CreatePermissionResponseTypeDef,\n    ListPermissionVersionsResponseTypeDef,\n    ListPermissionsResponseTypeDef,\n    ListResourceSharePermissionsResponseTypeDef,\n    PromotePermissionCreatedFromPolicyResponseTypeDef,\n    CreateResourceShareResponseTypeDef,\n    GetResourceSharesResponseTypeDef,\n    UpdateResourceShareResponseTypeDef,\n)\n\n\ndef get_structure() -> AcceptResourceShareInvitationRequestRequestTypeDef:\n    return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n  annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black) and\n  [isort](https://github.com/PyCQA/isort) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n  libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n  compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n  annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n  calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`mypy-boto3-ram` version is the same as related `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n  this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n  tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n  [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n  for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n  Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Type annotations for boto3.RAM 1.27.0 service generated with mypy-boto3-builder 7.14.5",
    "version": "1.27.0",
    "project_urls": {
        "Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ram/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Source": "https://github.com/youtype/mypy_boto3_builder",
        "Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
    },
    "split_keywords": [
        "boto3",
        "ram",
        "type-annotations",
        "boto3-stubs",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "954e82e07fa1415f3d85c9f9e89b1222e298ffb1954b8cfe55da3af759d041b8",
                "md5": "6880962bc39de227f2e2718c725d8920",
                "sha256": "4ad9ab38c45e8fa34484e69fd8680ea597537f6c739952649128612d4b95aae9"
            },
            "downloads": -1,
            "filename": "mypy_boto3_ram-1.27.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6880962bc39de227f2e2718c725d8920",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 32557,
            "upload_time": "2023-07-03T20:01:54",
            "upload_time_iso_8601": "2023-07-03T20:01:54.313445Z",
            "url": "https://files.pythonhosted.org/packages/95/4e/82e07fa1415f3d85c9f9e89b1222e298ffb1954b8cfe55da3af759d041b8/mypy_boto3_ram-1.27.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f2e1a1be1d99f6cf3e76b8138792d56b491a1fb07c944babf21d6419f46b89bb",
                "md5": "f32bfd71a006136216ad5c0275da7751",
                "sha256": "e5f0fb91c8a1fd93a24070803a5ffc19812ca0184dc57a6a832bfa82c0e38e76"
            },
            "downloads": -1,
            "filename": "mypy-boto3-ram-1.27.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f32bfd71a006136216ad5c0275da7751",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 28726,
            "upload_time": "2023-07-03T20:02:00",
            "upload_time_iso_8601": "2023-07-03T20:02:00.973403Z",
            "url": "https://files.pythonhosted.org/packages/f2/e1/a1be1d99f6cf3e76b8138792d56b491a1fb07c944babf21d6419f46b89bb/mypy-boto3-ram-1.27.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-03 20:02:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mypy-boto3-ram"
}
Vlad Emelianov
Elapsed time: 0.10311s