%global _empty_manifest_terminate_build 0
Name:		python-mypy-boto3-opsworks
Version:	1.26.0.post1
Release:	1
Summary:	Type annotations for boto3.OpsWorks 1.26.0 service generated with mypy-boto3-builder 7.11.10
License:	MIT License
URL:		https://github.com/youtype/mypy_boto3_builder
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/f3/51/168b4ec442d077b5b908bb9e0a130e43f09aa1053d3c231b34c8d1ef4edf/mypy-boto3-opsworks-1.26.0.post1.tar.gz
BuildArch:	noarch

Requires:	python3-typing-extensions

%description
<a id="mypy-boto3-opsworks"></a>

# mypy-boto3-opsworks

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

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

Type annotations for
[boto3.OpsWorks 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/opsworks.html#OpsWorks)
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.11.10](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-opsworks docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_opsworks/).

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-opsworks](#mypy-boto3-opsworks)
  - [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)
    - [Waiters annotations](#waiters-annotations)
    - [Service Resource annotations](#service-resource-annotations)
    - [Other resources annotations](#other-resources-annotations)
    - [Collections annotations](#collections-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 `OpsWorks`.

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

### From PyPI with pip

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

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


# 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[opsworks]'


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

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

## How to uninstall

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

<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[opsworks]` in your environment:

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

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[opsworks]` in your environment:

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

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[opsworks]'
```

- 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[opsworks]` with services you use in your environment:

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

- 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[opsworks]` in your environment:

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

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[opsworks]` in your environment:

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

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

`OpsWorksClient` provides annotations for `boto3.client("opsworks")`.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient

client: OpsWorksClient = Session().client("opsworks")

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

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

### Paginators annotations

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

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient
from mypy_boto3_opsworks.paginator import DescribeEcsClustersPaginator

client: OpsWorksClient = Session().client("opsworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_ecs_clusters_paginator: DescribeEcsClustersPaginator = client.get_paginator(
    "describe_ecs_clusters"
)
```

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

### Waiters annotations

`mypy_boto3_opsworks.waiter` module contains type annotations for all waiters.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient
from mypy_boto3_opsworks.waiter import (
    AppExistsWaiter,
    DeploymentSuccessfulWaiter,
    InstanceOnlineWaiter,
    InstanceRegisteredWaiter,
    InstanceStoppedWaiter,
    InstanceTerminatedWaiter,
)

client: OpsWorksClient = Session().client("opsworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
app_exists_waiter: AppExistsWaiter = client.get_waiter("app_exists")
deployment_successful_waiter: DeploymentSuccessfulWaiter = client.get_waiter(
    "deployment_successful"
)
instance_online_waiter: InstanceOnlineWaiter = client.get_waiter("instance_online")
instance_registered_waiter: InstanceRegisteredWaiter = client.get_waiter("instance_registered")
instance_stopped_waiter: InstanceStoppedWaiter = client.get_waiter("instance_stopped")
instance_terminated_waiter: InstanceTerminatedWaiter = client.get_waiter("instance_terminated")
```

<a id="service-resource-annotations"></a>

### Service Resource annotations

`OpsWorksServiceResource` provides annotations for
`boto3.resource("opsworks")`.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource

resource: OpsWorksServiceResource = Session().resource("opsworks")

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

<a id="other-resources-annotations"></a>

### Other resources annotations

`mypy_boto3_opsworks.service_resource` module contains type annotations for all
resources.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import Layer, Stack, StackSummary

resource: OpsWorksServiceResource = Session().resource("opsworks")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_layer: Layer = resource.Layer(...)
my_stack: Stack = resource.Stack(...)
my_stack_summary: StackSummary = resource.StackSummary(...)
```

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

### Collections annotations

`mypy_boto3_opsworks.service_resource` module contains type annotations for all
`OpsWorksServiceResource` collections.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import ServiceResourceStacksCollection

resource: OpsWorksServiceResource = Session().resource("opsworks")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
stacks: opsworks_resources.ServiceResourceStacksCollection = resource.stacks
```

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

### Literals

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

```python
from mypy_boto3_opsworks.literals import (
    AppAttributesKeysType,
    AppExistsWaiterName,
    AppTypeType,
    ArchitectureType,
    AutoScalingTypeType,
    CloudWatchLogsEncodingType,
    CloudWatchLogsInitialPositionType,
    CloudWatchLogsTimeZoneType,
    DeploymentCommandNameType,
    DeploymentSuccessfulWaiterName,
    DescribeEcsClustersPaginatorName,
    InstanceOnlineWaiterName,
    InstanceRegisteredWaiterName,
    InstanceStoppedWaiterName,
    InstanceTerminatedWaiterName,
    LayerAttributesKeysType,
    LayerTypeType,
    RootDeviceTypeType,
    SourceTypeType,
    StackAttributesKeysType,
    VirtualizationTypeType,
    VolumeTypeType,
    OpsWorksServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    WaiterName,
    RegionName,
)


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

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

### Typed dictionaries

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

```python
from mypy_boto3_opsworks.type_defs import (
    StackConfigurationManagerTypeDef,
    DataSourceTypeDef,
    EnvironmentVariableTypeDef,
    SourceTypeDef,
    SslConfigurationTypeDef,
    AssignInstanceRequestRequestTypeDef,
    AssignVolumeRequestRequestTypeDef,
    AssociateElasticIpRequestRequestTypeDef,
    AttachElasticLoadBalancerRequestRequestTypeDef,
    AutoScalingThresholdsTypeDef,
    EbsBlockDeviceTypeDef,
    ResponseMetadataTypeDef,
    ChefConfigurationTypeDef,
    CloudWatchLogsLogStreamTypeDef,
    CommandTypeDef,
    DeploymentCommandTypeDef,
    RecipesTypeDef,
    VolumeConfigurationTypeDef,
    CreateUserProfileRequestRequestTypeDef,
    DeleteAppRequestRequestTypeDef,
    DeleteInstanceRequestRequestTypeDef,
    DeleteLayerRequestRequestTypeDef,
    DeleteStackRequestRequestTypeDef,
    DeleteUserProfileRequestRequestTypeDef,
    DeregisterEcsClusterRequestRequestTypeDef,
    DeregisterElasticIpRequestRequestTypeDef,
    DeregisterInstanceRequestRequestTypeDef,
    DeregisterRdsDbInstanceRequestRequestTypeDef,
    DeregisterVolumeRequestRequestTypeDef,
    WaiterConfigTypeDef,
    DescribeAppsRequestRequestTypeDef,
    DescribeCommandsRequestRequestTypeDef,
    DescribeDeploymentsRequestRequestTypeDef,
    PaginatorConfigTypeDef,
    DescribeEcsClustersRequestRequestTypeDef,
    EcsClusterTypeDef,
    DescribeElasticIpsRequestRequestTypeDef,
    ElasticIpTypeDef,
    DescribeElasticLoadBalancersRequestRequestTypeDef,
    ElasticLoadBalancerTypeDef,
    DescribeInstancesRequestRequestTypeDef,
    DescribeLayersRequestRequestTypeDef,
    DescribeLoadBasedAutoScalingRequestRequestTypeDef,
    SelfUserProfileTypeDef,
    DescribePermissionsRequestRequestTypeDef,
    PermissionTypeDef,
    DescribeRaidArraysRequestRequestTypeDef,
    RaidArrayTypeDef,
    DescribeRdsDbInstancesRequestRequestTypeDef,
    RdsDbInstanceTypeDef,
    DescribeServiceErrorsRequestRequestTypeDef,
    ServiceErrorTypeDef,
    DescribeStackProvisioningParametersRequestRequestTypeDef,
    DescribeStackSummaryRequestRequestTypeDef,
    DescribeStacksRequestRequestTypeDef,
    DescribeTimeBasedAutoScalingRequestRequestTypeDef,
    DescribeUserProfilesRequestRequestTypeDef,
    UserProfileTypeDef,
    DescribeVolumesRequestRequestTypeDef,
    VolumeTypeDef,
    DetachElasticLoadBalancerRequestRequestTypeDef,
    DisassociateElasticIpRequestRequestTypeDef,
    GetHostnameSuggestionRequestRequestTypeDef,
    GrantAccessRequestRequestTypeDef,
    TemporaryCredentialTypeDef,
    InstanceIdentityTypeDef,
    ReportedOsTypeDef,
    InstancesCountTypeDef,
    ShutdownEventConfigurationTypeDef,
    ListTagsRequestRequestTypeDef,
    OperatingSystemConfigurationManagerTypeDef,
    RebootInstanceRequestRequestTypeDef,
    RegisterEcsClusterRequestRequestTypeDef,
    RegisterElasticIpRequestRequestTypeDef,
    RegisterRdsDbInstanceRequestRequestTypeDef,
    RegisterVolumeRequestRequestTypeDef,
    ServiceResourceLayerRequestTypeDef,
    ServiceResourceStackRequestTypeDef,
    ServiceResourceStackSummaryRequestTypeDef,
    SetPermissionRequestRequestTypeDef,
    WeeklyAutoScalingScheduleTypeDef,
    StartInstanceRequestRequestTypeDef,
    StartStackRequestRequestTypeDef,
    StopInstanceRequestRequestTypeDef,
    StopStackRequestRequestTypeDef,
    TagResourceRequestRequestTypeDef,
    UnassignInstanceRequestRequestTypeDef,
    UnassignVolumeRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateElasticIpRequestRequestTypeDef,
    UpdateInstanceRequestRequestTypeDef,
    UpdateMyUserProfileRequestRequestTypeDef,
    UpdateRdsDbInstanceRequestRequestTypeDef,
    UpdateUserProfileRequestRequestTypeDef,
    UpdateVolumeRequestRequestTypeDef,
    AgentVersionTypeDef,
    DescribeAgentVersionsRequestRequestTypeDef,
    AppTypeDef,
    CreateAppRequestRequestTypeDef,
    UpdateAppRequestRequestTypeDef,
    LoadBasedAutoScalingConfigurationTypeDef,
    SetLoadBasedAutoScalingRequestRequestTypeDef,
    BlockDeviceMappingTypeDef,
    ChefConfigurationResponseMetadataTypeDef,
    CloneStackResultTypeDef,
    CreateAppResultTypeDef,
    CreateDeploymentResultTypeDef,
    CreateInstanceResultTypeDef,
    CreateLayerResultTypeDef,
    CreateStackResultTypeDef,
    CreateUserProfileResultTypeDef,
    DescribeStackProvisioningParametersResultTypeDef,
    EmptyResponseMetadataTypeDef,
    GetHostnameSuggestionResultTypeDef,
    InstancesCountResponseMetadataTypeDef,
    ListTagsResultTypeDef,
    RecipesResponseMetadataTypeDef,
    RegisterEcsClusterResultTypeDef,
    RegisterElasticIpResultTypeDef,
    RegisterInstanceResultTypeDef,
    RegisterVolumeResultTypeDef,
    SourceResponseMetadataTypeDef,
    StackConfigurationManagerResponseMetadataTypeDef,
    CloneStackRequestRequestTypeDef,
    CreateStackRequestRequestTypeDef,
    CreateStackRequestServiceResourceCreateStackTypeDef,
    StackTypeDef,
    UpdateStackRequestRequestTypeDef,
    CloudWatchLogsConfigurationResponseMetadataTypeDef,
    CloudWatchLogsConfigurationTypeDef,
    DescribeCommandsResultTypeDef,
    CreateDeploymentRequestRequestTypeDef,
    DeploymentTypeDef,
    DescribeAppsRequestAppExistsWaitTypeDef,
    DescribeDeploymentsRequestDeploymentSuccessfulWaitTypeDef,
    DescribeInstancesRequestInstanceOnlineWaitTypeDef,
    DescribeInstancesRequestInstanceRegisteredWaitTypeDef,
    DescribeInstancesRequestInstanceStoppedWaitTypeDef,
    DescribeInstancesRequestInstanceTerminatedWaitTypeDef,
    DescribeEcsClustersRequestDescribeEcsClustersPaginateTypeDef,
    DescribeEcsClustersResultTypeDef,
    DescribeElasticIpsResultTypeDef,
    DescribeElasticLoadBalancersResultTypeDef,
    DescribeMyUserProfileResultTypeDef,
    DescribePermissionsResultTypeDef,
    DescribeRaidArraysResultTypeDef,
    DescribeRdsDbInstancesResultTypeDef,
    DescribeServiceErrorsResultTypeDef,
    DescribeUserProfilesResultTypeDef,
    DescribeVolumesResultTypeDef,
    GrantAccessResultTypeDef,
    RegisterInstanceRequestRequestTypeDef,
    StackSummaryTypeDef,
    LifecycleEventConfigurationResponseMetadataTypeDef,
    LifecycleEventConfigurationTypeDef,
    OperatingSystemTypeDef,
    SetTimeBasedAutoScalingRequestRequestTypeDef,
    TimeBasedAutoScalingConfigurationTypeDef,
    DescribeAgentVersionsResultTypeDef,
    DescribeAppsResultTypeDef,
    DescribeLoadBasedAutoScalingResultTypeDef,
    CreateInstanceRequestRequestTypeDef,
    InstanceTypeDef,
    DescribeStacksResultTypeDef,
    DescribeDeploymentsResultTypeDef,
    DescribeStackSummaryResultTypeDef,
    CreateLayerRequestRequestTypeDef,
    CreateLayerRequestStackCreateLayerTypeDef,
    LayerTypeDef,
    UpdateLayerRequestRequestTypeDef,
    DescribeOperatingSystemsResponseTypeDef,
    DescribeTimeBasedAutoScalingResultTypeDef,
    DescribeInstancesResultTypeDef,
    DescribeLayersResultTypeDef,
)


def get_structure() -> StackConfigurationManagerTypeDef:
    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 a 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 the documentation (blame `botocore` docs if types
  are incorrect).
- 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` and `aiobotocore` 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.session` calls
- Auto discovery of types for `session.client` and `session.session` 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-opsworks` 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_opsworks/)

<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.


%package -n python3-mypy-boto3-opsworks
Summary:	Type annotations for boto3.OpsWorks 1.26.0 service generated with mypy-boto3-builder 7.11.10
Provides:	python-mypy-boto3-opsworks
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-mypy-boto3-opsworks
<a id="mypy-boto3-opsworks"></a>

# mypy-boto3-opsworks

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

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

Type annotations for
[boto3.OpsWorks 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/opsworks.html#OpsWorks)
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.11.10](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-opsworks docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_opsworks/).

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-opsworks](#mypy-boto3-opsworks)
  - [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)
    - [Waiters annotations](#waiters-annotations)
    - [Service Resource annotations](#service-resource-annotations)
    - [Other resources annotations](#other-resources-annotations)
    - [Collections annotations](#collections-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 `OpsWorks`.

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

### From PyPI with pip

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

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


# 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[opsworks]'


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

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

## How to uninstall

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

<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[opsworks]` in your environment:

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

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[opsworks]` in your environment:

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

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[opsworks]'
```

- 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[opsworks]` with services you use in your environment:

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

- 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[opsworks]` in your environment:

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

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[opsworks]` in your environment:

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

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

`OpsWorksClient` provides annotations for `boto3.client("opsworks")`.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient

client: OpsWorksClient = Session().client("opsworks")

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

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

### Paginators annotations

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

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient
from mypy_boto3_opsworks.paginator import DescribeEcsClustersPaginator

client: OpsWorksClient = Session().client("opsworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_ecs_clusters_paginator: DescribeEcsClustersPaginator = client.get_paginator(
    "describe_ecs_clusters"
)
```

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

### Waiters annotations

`mypy_boto3_opsworks.waiter` module contains type annotations for all waiters.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient
from mypy_boto3_opsworks.waiter import (
    AppExistsWaiter,
    DeploymentSuccessfulWaiter,
    InstanceOnlineWaiter,
    InstanceRegisteredWaiter,
    InstanceStoppedWaiter,
    InstanceTerminatedWaiter,
)

client: OpsWorksClient = Session().client("opsworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
app_exists_waiter: AppExistsWaiter = client.get_waiter("app_exists")
deployment_successful_waiter: DeploymentSuccessfulWaiter = client.get_waiter(
    "deployment_successful"
)
instance_online_waiter: InstanceOnlineWaiter = client.get_waiter("instance_online")
instance_registered_waiter: InstanceRegisteredWaiter = client.get_waiter("instance_registered")
instance_stopped_waiter: InstanceStoppedWaiter = client.get_waiter("instance_stopped")
instance_terminated_waiter: InstanceTerminatedWaiter = client.get_waiter("instance_terminated")
```

<a id="service-resource-annotations"></a>

### Service Resource annotations

`OpsWorksServiceResource` provides annotations for
`boto3.resource("opsworks")`.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource

resource: OpsWorksServiceResource = Session().resource("opsworks")

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

<a id="other-resources-annotations"></a>

### Other resources annotations

`mypy_boto3_opsworks.service_resource` module contains type annotations for all
resources.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import Layer, Stack, StackSummary

resource: OpsWorksServiceResource = Session().resource("opsworks")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_layer: Layer = resource.Layer(...)
my_stack: Stack = resource.Stack(...)
my_stack_summary: StackSummary = resource.StackSummary(...)
```

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

### Collections annotations

`mypy_boto3_opsworks.service_resource` module contains type annotations for all
`OpsWorksServiceResource` collections.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import ServiceResourceStacksCollection

resource: OpsWorksServiceResource = Session().resource("opsworks")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
stacks: opsworks_resources.ServiceResourceStacksCollection = resource.stacks
```

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

### Literals

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

```python
from mypy_boto3_opsworks.literals import (
    AppAttributesKeysType,
    AppExistsWaiterName,
    AppTypeType,
    ArchitectureType,
    AutoScalingTypeType,
    CloudWatchLogsEncodingType,
    CloudWatchLogsInitialPositionType,
    CloudWatchLogsTimeZoneType,
    DeploymentCommandNameType,
    DeploymentSuccessfulWaiterName,
    DescribeEcsClustersPaginatorName,
    InstanceOnlineWaiterName,
    InstanceRegisteredWaiterName,
    InstanceStoppedWaiterName,
    InstanceTerminatedWaiterName,
    LayerAttributesKeysType,
    LayerTypeType,
    RootDeviceTypeType,
    SourceTypeType,
    StackAttributesKeysType,
    VirtualizationTypeType,
    VolumeTypeType,
    OpsWorksServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    WaiterName,
    RegionName,
)


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

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

### Typed dictionaries

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

```python
from mypy_boto3_opsworks.type_defs import (
    StackConfigurationManagerTypeDef,
    DataSourceTypeDef,
    EnvironmentVariableTypeDef,
    SourceTypeDef,
    SslConfigurationTypeDef,
    AssignInstanceRequestRequestTypeDef,
    AssignVolumeRequestRequestTypeDef,
    AssociateElasticIpRequestRequestTypeDef,
    AttachElasticLoadBalancerRequestRequestTypeDef,
    AutoScalingThresholdsTypeDef,
    EbsBlockDeviceTypeDef,
    ResponseMetadataTypeDef,
    ChefConfigurationTypeDef,
    CloudWatchLogsLogStreamTypeDef,
    CommandTypeDef,
    DeploymentCommandTypeDef,
    RecipesTypeDef,
    VolumeConfigurationTypeDef,
    CreateUserProfileRequestRequestTypeDef,
    DeleteAppRequestRequestTypeDef,
    DeleteInstanceRequestRequestTypeDef,
    DeleteLayerRequestRequestTypeDef,
    DeleteStackRequestRequestTypeDef,
    DeleteUserProfileRequestRequestTypeDef,
    DeregisterEcsClusterRequestRequestTypeDef,
    DeregisterElasticIpRequestRequestTypeDef,
    DeregisterInstanceRequestRequestTypeDef,
    DeregisterRdsDbInstanceRequestRequestTypeDef,
    DeregisterVolumeRequestRequestTypeDef,
    WaiterConfigTypeDef,
    DescribeAppsRequestRequestTypeDef,
    DescribeCommandsRequestRequestTypeDef,
    DescribeDeploymentsRequestRequestTypeDef,
    PaginatorConfigTypeDef,
    DescribeEcsClustersRequestRequestTypeDef,
    EcsClusterTypeDef,
    DescribeElasticIpsRequestRequestTypeDef,
    ElasticIpTypeDef,
    DescribeElasticLoadBalancersRequestRequestTypeDef,
    ElasticLoadBalancerTypeDef,
    DescribeInstancesRequestRequestTypeDef,
    DescribeLayersRequestRequestTypeDef,
    DescribeLoadBasedAutoScalingRequestRequestTypeDef,
    SelfUserProfileTypeDef,
    DescribePermissionsRequestRequestTypeDef,
    PermissionTypeDef,
    DescribeRaidArraysRequestRequestTypeDef,
    RaidArrayTypeDef,
    DescribeRdsDbInstancesRequestRequestTypeDef,
    RdsDbInstanceTypeDef,
    DescribeServiceErrorsRequestRequestTypeDef,
    ServiceErrorTypeDef,
    DescribeStackProvisioningParametersRequestRequestTypeDef,
    DescribeStackSummaryRequestRequestTypeDef,
    DescribeStacksRequestRequestTypeDef,
    DescribeTimeBasedAutoScalingRequestRequestTypeDef,
    DescribeUserProfilesRequestRequestTypeDef,
    UserProfileTypeDef,
    DescribeVolumesRequestRequestTypeDef,
    VolumeTypeDef,
    DetachElasticLoadBalancerRequestRequestTypeDef,
    DisassociateElasticIpRequestRequestTypeDef,
    GetHostnameSuggestionRequestRequestTypeDef,
    GrantAccessRequestRequestTypeDef,
    TemporaryCredentialTypeDef,
    InstanceIdentityTypeDef,
    ReportedOsTypeDef,
    InstancesCountTypeDef,
    ShutdownEventConfigurationTypeDef,
    ListTagsRequestRequestTypeDef,
    OperatingSystemConfigurationManagerTypeDef,
    RebootInstanceRequestRequestTypeDef,
    RegisterEcsClusterRequestRequestTypeDef,
    RegisterElasticIpRequestRequestTypeDef,
    RegisterRdsDbInstanceRequestRequestTypeDef,
    RegisterVolumeRequestRequestTypeDef,
    ServiceResourceLayerRequestTypeDef,
    ServiceResourceStackRequestTypeDef,
    ServiceResourceStackSummaryRequestTypeDef,
    SetPermissionRequestRequestTypeDef,
    WeeklyAutoScalingScheduleTypeDef,
    StartInstanceRequestRequestTypeDef,
    StartStackRequestRequestTypeDef,
    StopInstanceRequestRequestTypeDef,
    StopStackRequestRequestTypeDef,
    TagResourceRequestRequestTypeDef,
    UnassignInstanceRequestRequestTypeDef,
    UnassignVolumeRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateElasticIpRequestRequestTypeDef,
    UpdateInstanceRequestRequestTypeDef,
    UpdateMyUserProfileRequestRequestTypeDef,
    UpdateRdsDbInstanceRequestRequestTypeDef,
    UpdateUserProfileRequestRequestTypeDef,
    UpdateVolumeRequestRequestTypeDef,
    AgentVersionTypeDef,
    DescribeAgentVersionsRequestRequestTypeDef,
    AppTypeDef,
    CreateAppRequestRequestTypeDef,
    UpdateAppRequestRequestTypeDef,
    LoadBasedAutoScalingConfigurationTypeDef,
    SetLoadBasedAutoScalingRequestRequestTypeDef,
    BlockDeviceMappingTypeDef,
    ChefConfigurationResponseMetadataTypeDef,
    CloneStackResultTypeDef,
    CreateAppResultTypeDef,
    CreateDeploymentResultTypeDef,
    CreateInstanceResultTypeDef,
    CreateLayerResultTypeDef,
    CreateStackResultTypeDef,
    CreateUserProfileResultTypeDef,
    DescribeStackProvisioningParametersResultTypeDef,
    EmptyResponseMetadataTypeDef,
    GetHostnameSuggestionResultTypeDef,
    InstancesCountResponseMetadataTypeDef,
    ListTagsResultTypeDef,
    RecipesResponseMetadataTypeDef,
    RegisterEcsClusterResultTypeDef,
    RegisterElasticIpResultTypeDef,
    RegisterInstanceResultTypeDef,
    RegisterVolumeResultTypeDef,
    SourceResponseMetadataTypeDef,
    StackConfigurationManagerResponseMetadataTypeDef,
    CloneStackRequestRequestTypeDef,
    CreateStackRequestRequestTypeDef,
    CreateStackRequestServiceResourceCreateStackTypeDef,
    StackTypeDef,
    UpdateStackRequestRequestTypeDef,
    CloudWatchLogsConfigurationResponseMetadataTypeDef,
    CloudWatchLogsConfigurationTypeDef,
    DescribeCommandsResultTypeDef,
    CreateDeploymentRequestRequestTypeDef,
    DeploymentTypeDef,
    DescribeAppsRequestAppExistsWaitTypeDef,
    DescribeDeploymentsRequestDeploymentSuccessfulWaitTypeDef,
    DescribeInstancesRequestInstanceOnlineWaitTypeDef,
    DescribeInstancesRequestInstanceRegisteredWaitTypeDef,
    DescribeInstancesRequestInstanceStoppedWaitTypeDef,
    DescribeInstancesRequestInstanceTerminatedWaitTypeDef,
    DescribeEcsClustersRequestDescribeEcsClustersPaginateTypeDef,
    DescribeEcsClustersResultTypeDef,
    DescribeElasticIpsResultTypeDef,
    DescribeElasticLoadBalancersResultTypeDef,
    DescribeMyUserProfileResultTypeDef,
    DescribePermissionsResultTypeDef,
    DescribeRaidArraysResultTypeDef,
    DescribeRdsDbInstancesResultTypeDef,
    DescribeServiceErrorsResultTypeDef,
    DescribeUserProfilesResultTypeDef,
    DescribeVolumesResultTypeDef,
    GrantAccessResultTypeDef,
    RegisterInstanceRequestRequestTypeDef,
    StackSummaryTypeDef,
    LifecycleEventConfigurationResponseMetadataTypeDef,
    LifecycleEventConfigurationTypeDef,
    OperatingSystemTypeDef,
    SetTimeBasedAutoScalingRequestRequestTypeDef,
    TimeBasedAutoScalingConfigurationTypeDef,
    DescribeAgentVersionsResultTypeDef,
    DescribeAppsResultTypeDef,
    DescribeLoadBasedAutoScalingResultTypeDef,
    CreateInstanceRequestRequestTypeDef,
    InstanceTypeDef,
    DescribeStacksResultTypeDef,
    DescribeDeploymentsResultTypeDef,
    DescribeStackSummaryResultTypeDef,
    CreateLayerRequestRequestTypeDef,
    CreateLayerRequestStackCreateLayerTypeDef,
    LayerTypeDef,
    UpdateLayerRequestRequestTypeDef,
    DescribeOperatingSystemsResponseTypeDef,
    DescribeTimeBasedAutoScalingResultTypeDef,
    DescribeInstancesResultTypeDef,
    DescribeLayersResultTypeDef,
)


def get_structure() -> StackConfigurationManagerTypeDef:
    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 a 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 the documentation (blame `botocore` docs if types
  are incorrect).
- 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` and `aiobotocore` 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.session` calls
- Auto discovery of types for `session.client` and `session.session` 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-opsworks` 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_opsworks/)

<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.


%package help
Summary:	Development documents and examples for mypy-boto3-opsworks
Provides:	python3-mypy-boto3-opsworks-doc
%description help
<a id="mypy-boto3-opsworks"></a>

# mypy-boto3-opsworks

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

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

Type annotations for
[boto3.OpsWorks 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/opsworks.html#OpsWorks)
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.11.10](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-opsworks docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_opsworks/).

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-opsworks](#mypy-boto3-opsworks)
  - [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)
    - [Waiters annotations](#waiters-annotations)
    - [Service Resource annotations](#service-resource-annotations)
    - [Other resources annotations](#other-resources-annotations)
    - [Collections annotations](#collections-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 `OpsWorks`.

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

### From PyPI with pip

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

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


# 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[opsworks]'


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

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

## How to uninstall

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

<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[opsworks]` in your environment:

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

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[opsworks]` in your environment:

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

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[opsworks]'
```

- 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[opsworks]` with services you use in your environment:

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

- 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[opsworks]` in your environment:

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

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[opsworks]` in your environment:

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

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

`OpsWorksClient` provides annotations for `boto3.client("opsworks")`.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient

client: OpsWorksClient = Session().client("opsworks")

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

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

### Paginators annotations

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

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient
from mypy_boto3_opsworks.paginator import DescribeEcsClustersPaginator

client: OpsWorksClient = Session().client("opsworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_ecs_clusters_paginator: DescribeEcsClustersPaginator = client.get_paginator(
    "describe_ecs_clusters"
)
```

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

### Waiters annotations

`mypy_boto3_opsworks.waiter` module contains type annotations for all waiters.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksClient
from mypy_boto3_opsworks.waiter import (
    AppExistsWaiter,
    DeploymentSuccessfulWaiter,
    InstanceOnlineWaiter,
    InstanceRegisteredWaiter,
    InstanceStoppedWaiter,
    InstanceTerminatedWaiter,
)

client: OpsWorksClient = Session().client("opsworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
app_exists_waiter: AppExistsWaiter = client.get_waiter("app_exists")
deployment_successful_waiter: DeploymentSuccessfulWaiter = client.get_waiter(
    "deployment_successful"
)
instance_online_waiter: InstanceOnlineWaiter = client.get_waiter("instance_online")
instance_registered_waiter: InstanceRegisteredWaiter = client.get_waiter("instance_registered")
instance_stopped_waiter: InstanceStoppedWaiter = client.get_waiter("instance_stopped")
instance_terminated_waiter: InstanceTerminatedWaiter = client.get_waiter("instance_terminated")
```

<a id="service-resource-annotations"></a>

### Service Resource annotations

`OpsWorksServiceResource` provides annotations for
`boto3.resource("opsworks")`.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource

resource: OpsWorksServiceResource = Session().resource("opsworks")

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

<a id="other-resources-annotations"></a>

### Other resources annotations

`mypy_boto3_opsworks.service_resource` module contains type annotations for all
resources.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import Layer, Stack, StackSummary

resource: OpsWorksServiceResource = Session().resource("opsworks")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_layer: Layer = resource.Layer(...)
my_stack: Stack = resource.Stack(...)
my_stack_summary: StackSummary = resource.StackSummary(...)
```

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

### Collections annotations

`mypy_boto3_opsworks.service_resource` module contains type annotations for all
`OpsWorksServiceResource` collections.

```python
from boto3.session import Session

from mypy_boto3_opsworks import OpsWorksServiceResource
from mypy_boto3_opsworks.service_resource import ServiceResourceStacksCollection

resource: OpsWorksServiceResource = Session().resource("opsworks")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
stacks: opsworks_resources.ServiceResourceStacksCollection = resource.stacks
```

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

### Literals

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

```python
from mypy_boto3_opsworks.literals import (
    AppAttributesKeysType,
    AppExistsWaiterName,
    AppTypeType,
    ArchitectureType,
    AutoScalingTypeType,
    CloudWatchLogsEncodingType,
    CloudWatchLogsInitialPositionType,
    CloudWatchLogsTimeZoneType,
    DeploymentCommandNameType,
    DeploymentSuccessfulWaiterName,
    DescribeEcsClustersPaginatorName,
    InstanceOnlineWaiterName,
    InstanceRegisteredWaiterName,
    InstanceStoppedWaiterName,
    InstanceTerminatedWaiterName,
    LayerAttributesKeysType,
    LayerTypeType,
    RootDeviceTypeType,
    SourceTypeType,
    StackAttributesKeysType,
    VirtualizationTypeType,
    VolumeTypeType,
    OpsWorksServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    WaiterName,
    RegionName,
)


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

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

### Typed dictionaries

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

```python
from mypy_boto3_opsworks.type_defs import (
    StackConfigurationManagerTypeDef,
    DataSourceTypeDef,
    EnvironmentVariableTypeDef,
    SourceTypeDef,
    SslConfigurationTypeDef,
    AssignInstanceRequestRequestTypeDef,
    AssignVolumeRequestRequestTypeDef,
    AssociateElasticIpRequestRequestTypeDef,
    AttachElasticLoadBalancerRequestRequestTypeDef,
    AutoScalingThresholdsTypeDef,
    EbsBlockDeviceTypeDef,
    ResponseMetadataTypeDef,
    ChefConfigurationTypeDef,
    CloudWatchLogsLogStreamTypeDef,
    CommandTypeDef,
    DeploymentCommandTypeDef,
    RecipesTypeDef,
    VolumeConfigurationTypeDef,
    CreateUserProfileRequestRequestTypeDef,
    DeleteAppRequestRequestTypeDef,
    DeleteInstanceRequestRequestTypeDef,
    DeleteLayerRequestRequestTypeDef,
    DeleteStackRequestRequestTypeDef,
    DeleteUserProfileRequestRequestTypeDef,
    DeregisterEcsClusterRequestRequestTypeDef,
    DeregisterElasticIpRequestRequestTypeDef,
    DeregisterInstanceRequestRequestTypeDef,
    DeregisterRdsDbInstanceRequestRequestTypeDef,
    DeregisterVolumeRequestRequestTypeDef,
    WaiterConfigTypeDef,
    DescribeAppsRequestRequestTypeDef,
    DescribeCommandsRequestRequestTypeDef,
    DescribeDeploymentsRequestRequestTypeDef,
    PaginatorConfigTypeDef,
    DescribeEcsClustersRequestRequestTypeDef,
    EcsClusterTypeDef,
    DescribeElasticIpsRequestRequestTypeDef,
    ElasticIpTypeDef,
    DescribeElasticLoadBalancersRequestRequestTypeDef,
    ElasticLoadBalancerTypeDef,
    DescribeInstancesRequestRequestTypeDef,
    DescribeLayersRequestRequestTypeDef,
    DescribeLoadBasedAutoScalingRequestRequestTypeDef,
    SelfUserProfileTypeDef,
    DescribePermissionsRequestRequestTypeDef,
    PermissionTypeDef,
    DescribeRaidArraysRequestRequestTypeDef,
    RaidArrayTypeDef,
    DescribeRdsDbInstancesRequestRequestTypeDef,
    RdsDbInstanceTypeDef,
    DescribeServiceErrorsRequestRequestTypeDef,
    ServiceErrorTypeDef,
    DescribeStackProvisioningParametersRequestRequestTypeDef,
    DescribeStackSummaryRequestRequestTypeDef,
    DescribeStacksRequestRequestTypeDef,
    DescribeTimeBasedAutoScalingRequestRequestTypeDef,
    DescribeUserProfilesRequestRequestTypeDef,
    UserProfileTypeDef,
    DescribeVolumesRequestRequestTypeDef,
    VolumeTypeDef,
    DetachElasticLoadBalancerRequestRequestTypeDef,
    DisassociateElasticIpRequestRequestTypeDef,
    GetHostnameSuggestionRequestRequestTypeDef,
    GrantAccessRequestRequestTypeDef,
    TemporaryCredentialTypeDef,
    InstanceIdentityTypeDef,
    ReportedOsTypeDef,
    InstancesCountTypeDef,
    ShutdownEventConfigurationTypeDef,
    ListTagsRequestRequestTypeDef,
    OperatingSystemConfigurationManagerTypeDef,
    RebootInstanceRequestRequestTypeDef,
    RegisterEcsClusterRequestRequestTypeDef,
    RegisterElasticIpRequestRequestTypeDef,
    RegisterRdsDbInstanceRequestRequestTypeDef,
    RegisterVolumeRequestRequestTypeDef,
    ServiceResourceLayerRequestTypeDef,
    ServiceResourceStackRequestTypeDef,
    ServiceResourceStackSummaryRequestTypeDef,
    SetPermissionRequestRequestTypeDef,
    WeeklyAutoScalingScheduleTypeDef,
    StartInstanceRequestRequestTypeDef,
    StartStackRequestRequestTypeDef,
    StopInstanceRequestRequestTypeDef,
    StopStackRequestRequestTypeDef,
    TagResourceRequestRequestTypeDef,
    UnassignInstanceRequestRequestTypeDef,
    UnassignVolumeRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateElasticIpRequestRequestTypeDef,
    UpdateInstanceRequestRequestTypeDef,
    UpdateMyUserProfileRequestRequestTypeDef,
    UpdateRdsDbInstanceRequestRequestTypeDef,
    UpdateUserProfileRequestRequestTypeDef,
    UpdateVolumeRequestRequestTypeDef,
    AgentVersionTypeDef,
    DescribeAgentVersionsRequestRequestTypeDef,
    AppTypeDef,
    CreateAppRequestRequestTypeDef,
    UpdateAppRequestRequestTypeDef,
    LoadBasedAutoScalingConfigurationTypeDef,
    SetLoadBasedAutoScalingRequestRequestTypeDef,
    BlockDeviceMappingTypeDef,
    ChefConfigurationResponseMetadataTypeDef,
    CloneStackResultTypeDef,
    CreateAppResultTypeDef,
    CreateDeploymentResultTypeDef,
    CreateInstanceResultTypeDef,
    CreateLayerResultTypeDef,
    CreateStackResultTypeDef,
    CreateUserProfileResultTypeDef,
    DescribeStackProvisioningParametersResultTypeDef,
    EmptyResponseMetadataTypeDef,
    GetHostnameSuggestionResultTypeDef,
    InstancesCountResponseMetadataTypeDef,
    ListTagsResultTypeDef,
    RecipesResponseMetadataTypeDef,
    RegisterEcsClusterResultTypeDef,
    RegisterElasticIpResultTypeDef,
    RegisterInstanceResultTypeDef,
    RegisterVolumeResultTypeDef,
    SourceResponseMetadataTypeDef,
    StackConfigurationManagerResponseMetadataTypeDef,
    CloneStackRequestRequestTypeDef,
    CreateStackRequestRequestTypeDef,
    CreateStackRequestServiceResourceCreateStackTypeDef,
    StackTypeDef,
    UpdateStackRequestRequestTypeDef,
    CloudWatchLogsConfigurationResponseMetadataTypeDef,
    CloudWatchLogsConfigurationTypeDef,
    DescribeCommandsResultTypeDef,
    CreateDeploymentRequestRequestTypeDef,
    DeploymentTypeDef,
    DescribeAppsRequestAppExistsWaitTypeDef,
    DescribeDeploymentsRequestDeploymentSuccessfulWaitTypeDef,
    DescribeInstancesRequestInstanceOnlineWaitTypeDef,
    DescribeInstancesRequestInstanceRegisteredWaitTypeDef,
    DescribeInstancesRequestInstanceStoppedWaitTypeDef,
    DescribeInstancesRequestInstanceTerminatedWaitTypeDef,
    DescribeEcsClustersRequestDescribeEcsClustersPaginateTypeDef,
    DescribeEcsClustersResultTypeDef,
    DescribeElasticIpsResultTypeDef,
    DescribeElasticLoadBalancersResultTypeDef,
    DescribeMyUserProfileResultTypeDef,
    DescribePermissionsResultTypeDef,
    DescribeRaidArraysResultTypeDef,
    DescribeRdsDbInstancesResultTypeDef,
    DescribeServiceErrorsResultTypeDef,
    DescribeUserProfilesResultTypeDef,
    DescribeVolumesResultTypeDef,
    GrantAccessResultTypeDef,
    RegisterInstanceRequestRequestTypeDef,
    StackSummaryTypeDef,
    LifecycleEventConfigurationResponseMetadataTypeDef,
    LifecycleEventConfigurationTypeDef,
    OperatingSystemTypeDef,
    SetTimeBasedAutoScalingRequestRequestTypeDef,
    TimeBasedAutoScalingConfigurationTypeDef,
    DescribeAgentVersionsResultTypeDef,
    DescribeAppsResultTypeDef,
    DescribeLoadBasedAutoScalingResultTypeDef,
    CreateInstanceRequestRequestTypeDef,
    InstanceTypeDef,
    DescribeStacksResultTypeDef,
    DescribeDeploymentsResultTypeDef,
    DescribeStackSummaryResultTypeDef,
    CreateLayerRequestRequestTypeDef,
    CreateLayerRequestStackCreateLayerTypeDef,
    LayerTypeDef,
    UpdateLayerRequestRequestTypeDef,
    DescribeOperatingSystemsResponseTypeDef,
    DescribeTimeBasedAutoScalingResultTypeDef,
    DescribeInstancesResultTypeDef,
    DescribeLayersResultTypeDef,
)


def get_structure() -> StackConfigurationManagerTypeDef:
    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 a 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 the documentation (blame `botocore` docs if types
  are incorrect).
- 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` and `aiobotocore` 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.session` calls
- Auto discovery of types for `session.client` and `session.session` 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-opsworks` 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_opsworks/)

<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.


%prep
%autosetup -n mypy-boto3-opsworks-1.26.0.post1

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-mypy-boto3-opsworks -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.0.post1-1
- Package Spec generated