Skip to main content

Type annotations for boto3.LookoutMetrics 1.23.4 service generated with mypy-boto3-builder 7.6.0

Project description

mypy-boto3-lookoutmetrics

PyPI - mypy-boto3-lookoutmetrics PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3.LookoutMetrics 1.23.4 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 7.6.0.

More information can be found on boto3-stubs page and in mypy-boto3-lookoutmetrics docs

See how it helps to find and fix potential bugs:

boto3-stubs demo

How to install

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and LookoutMetrics.

From PyPI with pip

Install boto3-stubs for LookoutMetrics service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[lookoutmetrics]'


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


# standalone installation
python -m pip install mypy-boto3-lookoutmetrics

How to uninstall

python -m pip uninstall -y mypy-boto3-lookoutmetrics

Usage

VSCode

python -m pip install 'boto3-stubs[lookoutmetrics]'

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

PyCharm

Install boto3-stubs-lite[lookoutmetrics] in your environment:

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

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

Use boto3-stubs package instead for implicit type discovery.

Emacs

  • Install boto3-stubs with services you use in your environment:
python -m pip install 'boto3-stubs[lookoutmetrics]'
(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.

Sublime Text

  • Install boto3-stubs[lookoutmetrics] with services you use in your environment:
python -m pip install 'boto3-stubs[lookoutmetrics]'

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

Other IDEs

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

mypy

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

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

pyright

  • Install pyright: npm i -g pyright
  • Install boto3-stubs[lookoutmetrics] in your environment:
python -m pip install 'boto3-stubs[lookoutmetrics]'

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.

Explicit type annotations

Client annotations

LookoutMetricsClient provides annotations for boto3.client("lookoutmetrics").

from boto3.session import Session

from mypy_boto3_lookoutmetrics import LookoutMetricsClient

client: LookoutMetricsClient = Session().client("lookoutmetrics")

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

Literals

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

from mypy_boto3_lookoutmetrics.literals import (
    AggregationFunctionType,
    AlertStatusType,
    AlertTypeType,
    AnomalyDetectionTaskStatusType,
    AnomalyDetectorFailureTypeType,
    AnomalyDetectorStatusType,
    CSVFileCompressionType,
    ConfidenceType,
    FrequencyType,
    JsonFileCompressionType,
    RelationshipTypeType,
    SnsFormatType,
    LookoutMetricsServiceName,
    ServiceName,
    ResourceServiceName,
    RegionName,
)

def check_value(value: AggregationFunctionType) -> bool:
    ...

Typed dictionaries

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

from mypy_boto3_lookoutmetrics.type_defs import (
    LambdaConfigurationTypeDef,
    SNSConfigurationTypeDef,
    ActivateAnomalyDetectorRequestRequestTypeDef,
    AlertSummaryTypeDef,
    AnomalyDetectorConfigSummaryTypeDef,
    AnomalyDetectorConfigTypeDef,
    AnomalyDetectorSummaryTypeDef,
    ItemizedMetricStatsTypeDef,
    AnomalyGroupSummaryTypeDef,
    AnomalyGroupTimeSeriesFeedbackTypeDef,
    AnomalyGroupTimeSeriesTypeDef,
    AppFlowConfigTypeDef,
    AttributeValueTypeDef,
    AutoDetectionS3SourceConfigTypeDef,
    BackTestAnomalyDetectorRequestRequestTypeDef,
    CloudWatchConfigTypeDef,
    ResponseMetadataTypeDef,
    MetricTypeDef,
    TimestampColumnTypeDef,
    CsvFormatDescriptorTypeDef,
    DeactivateAnomalyDetectorRequestRequestTypeDef,
    DeleteAlertRequestRequestTypeDef,
    DeleteAnomalyDetectorRequestRequestTypeDef,
    DescribeAlertRequestRequestTypeDef,
    DescribeAnomalyDetectionExecutionsRequestRequestTypeDef,
    ExecutionStatusTypeDef,
    DescribeAnomalyDetectorRequestRequestTypeDef,
    DescribeMetricSetRequestRequestTypeDef,
    DimensionValueContributionTypeDef,
    DimensionNameValueTypeDef,
    JsonFormatDescriptorTypeDef,
    GetAnomalyGroupRequestRequestTypeDef,
    TimeSeriesFeedbackTypeDef,
    InterMetricImpactDetailsTypeDef,
    ListAlertsRequestRequestTypeDef,
    ListAnomalyDetectorsRequestRequestTypeDef,
    ListAnomalyGroupRelatedMetricsRequestRequestTypeDef,
    ListAnomalyGroupSummariesRequestRequestTypeDef,
    ListAnomalyGroupTimeSeriesRequestRequestTypeDef,
    ListMetricSetsRequestRequestTypeDef,
    MetricSetSummaryTypeDef,
    ListTagsForResourceRequestRequestTypeDef,
    VpcConfigurationTypeDef,
    TagResourceRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    ActionTypeDef,
    CreateAnomalyDetectorRequestRequestTypeDef,
    UpdateAnomalyDetectorRequestRequestTypeDef,
    AnomalyGroupStatisticsTypeDef,
    PutFeedbackRequestRequestTypeDef,
    GetFeedbackRequestRequestTypeDef,
    DetectedFieldTypeDef,
    AutoDetectionMetricSourceTypeDef,
    CreateAlertResponseTypeDef,
    CreateAnomalyDetectorResponseTypeDef,
    CreateMetricSetResponseTypeDef,
    DescribeAnomalyDetectorResponseTypeDef,
    GetSampleDataResponseTypeDef,
    ListAlertsResponseTypeDef,
    ListAnomalyDetectorsResponseTypeDef,
    ListTagsForResourceResponseTypeDef,
    UpdateAnomalyDetectorResponseTypeDef,
    UpdateMetricSetResponseTypeDef,
    DescribeAnomalyDetectionExecutionsResponseTypeDef,
    DimensionContributionTypeDef,
    TimeSeriesTypeDef,
    FileFormatDescriptorTypeDef,
    GetFeedbackResponseTypeDef,
    ListAnomalyGroupRelatedMetricsResponseTypeDef,
    ListMetricSetsResponseTypeDef,
    RDSSourceConfigTypeDef,
    RedshiftSourceConfigTypeDef,
    AlertTypeDef,
    CreateAlertRequestRequestTypeDef,
    ListAnomalyGroupSummariesResponseTypeDef,
    DetectedCsvFormatDescriptorTypeDef,
    DetectedJsonFormatDescriptorTypeDef,
    DetectMetricSetConfigRequestRequestTypeDef,
    ContributionMatrixTypeDef,
    ListAnomalyGroupTimeSeriesResponseTypeDef,
    S3SourceConfigTypeDef,
    SampleDataS3SourceConfigTypeDef,
    DescribeAlertResponseTypeDef,
    DetectedFileFormatDescriptorTypeDef,
    MetricLevelImpactTypeDef,
    MetricSourceTypeDef,
    GetSampleDataRequestRequestTypeDef,
    DetectedS3SourceConfigTypeDef,
    AnomalyGroupTypeDef,
    CreateMetricSetRequestRequestTypeDef,
    DescribeMetricSetResponseTypeDef,
    UpdateMetricSetRequestRequestTypeDef,
    DetectedMetricSourceTypeDef,
    GetAnomalyGroupResponseTypeDef,
    DetectedMetricSetConfigTypeDef,
    DetectMetricSetConfigResponseTypeDef,
)

def get_structure() -> LambdaConfigurationTypeDef:
    return {
      ...
    }

How it works

Fully automated 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 and isort for readability.

What's new

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

Latest changes

Builder changelog can be found in Releases.

Versioning

mypy-boto3-lookoutmetrics version is the same as related boto3 version and follows PEP 440 format.

Thank you

Documentation

All services type annotations can be found in boto3 docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mypy-boto3-lookoutmetrics-1.23.4.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_lookoutmetrics-1.23.4-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-lookoutmetrics-1.23.4.tar.gz.

File metadata

File hashes

Hashes for mypy-boto3-lookoutmetrics-1.23.4.tar.gz
Algorithm Hash digest
SHA256 66a891e4a65d4d4c0a7e25ba7d7391aa5f05b3c04909b5f6fc90cb53c443297a
MD5 c159fb5b4954144a125f75c7175cbd28
BLAKE2b-256 0f911d0c1c11896ac795ca9baca90d3831e90b0edc0a7c75407d183218a81741

See more details on using hashes here.

File details

Details for the file mypy_boto3_lookoutmetrics-1.23.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mypy_boto3_lookoutmetrics-1.23.4-py3-none-any.whl
Algorithm Hash digest
SHA256 26aaab80f49c06d70b635843a25b9c477f6254cf0b5e590e5888bb1087c472c6
MD5 bf26df71838b578b86fb5f046863a3aa
BLAKE2b-256 2d509f68f6d9cfe84c224294479b3385a87f0b410bacd7aed3dbdbe94e072a8c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page