types-boto3-kinesis 1.36.0__py3-none-any.whl

types_boto3_kinesis/literals.pyi

@@ -0,0 +1,532 @@
+"""
+Type annotations for kinesis service literal definitions.
+
+[Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/literals/)
+
+Usage::
+
+    ```python
+    from types_boto3_kinesis.literals import ConsumerStatusType
+
+    data: ConsumerStatusType = "ACTIVE"
+    ```
+
+Copyright 2025 Vlad Emelianov
+"""
+
+import sys
+
+if sys.version_info >= (3, 12):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
+__all__ = (
+    "ConsumerStatusType",
+    "DescribeStreamPaginatorName",
+    "EncryptionTypeType",
+    "KinesisServiceName",
+    "ListShardsPaginatorName",
+    "ListStreamConsumersPaginatorName",
+    "ListStreamsPaginatorName",
+    "MetricsNameType",
+    "PaginatorName",
+    "RegionName",
+    "ResourceServiceName",
+    "ScalingTypeType",
+    "ServiceName",
+    "ShardFilterTypeType",
+    "ShardIteratorTypeType",
+    "StreamExistsWaiterName",
+    "StreamModeType",
+    "StreamNotExistsWaiterName",
+    "StreamStatusType",
+    "WaiterName",
+)
+
+ConsumerStatusType = Literal["ACTIVE", "CREATING", "DELETING"]
+DescribeStreamPaginatorName = Literal["describe_stream"]
+EncryptionTypeType = Literal["KMS", "NONE"]
+ListShardsPaginatorName = Literal["list_shards"]
+ListStreamConsumersPaginatorName = Literal["list_stream_consumers"]
+ListStreamsPaginatorName = Literal["list_streams"]
+MetricsNameType = Literal[
+    "ALL",
+    "IncomingBytes",
+    "IncomingRecords",
+    "IteratorAgeMilliseconds",
+    "OutgoingBytes",
+    "OutgoingRecords",
+    "ReadProvisionedThroughputExceeded",
+    "WriteProvisionedThroughputExceeded",
+]
+ScalingTypeType = Literal["UNIFORM_SCALING"]
+ShardFilterTypeType = Literal[
+    "AFTER_SHARD_ID",
+    "AT_LATEST",
+    "AT_TIMESTAMP",
+    "AT_TRIM_HORIZON",
+    "FROM_TIMESTAMP",
+    "FROM_TRIM_HORIZON",
+]
+ShardIteratorTypeType = Literal[
+    "AFTER_SEQUENCE_NUMBER", "AT_SEQUENCE_NUMBER", "AT_TIMESTAMP", "LATEST", "TRIM_HORIZON"
+]
+StreamExistsWaiterName = Literal["stream_exists"]
+StreamModeType = Literal["ON_DEMAND", "PROVISIONED"]
+StreamNotExistsWaiterName = Literal["stream_not_exists"]
+StreamStatusType = Literal["ACTIVE", "CREATING", "DELETING", "UPDATING"]
+KinesisServiceName = Literal["kinesis"]
+ServiceName = Literal[
+    "accessanalyzer",
+    "account",
+    "acm",
+    "acm-pca",
+    "amp",
+    "amplify",
+    "amplifybackend",
+    "amplifyuibuilder",
+    "apigateway",
+    "apigatewaymanagementapi",
+    "apigatewayv2",
+    "appconfig",
+    "appconfigdata",
+    "appfabric",
+    "appflow",
+    "appintegrations",
+    "application-autoscaling",
+    "application-insights",
+    "application-signals",
+    "applicationcostprofiler",
+    "appmesh",
+    "apprunner",
+    "appstream",
+    "appsync",
+    "apptest",
+    "arc-zonal-shift",
+    "artifact",
+    "athena",
+    "auditmanager",
+    "autoscaling",
+    "autoscaling-plans",
+    "b2bi",
+    "backup",
+    "backup-gateway",
+    "backupsearch",
+    "batch",
+    "bcm-data-exports",
+    "bcm-pricing-calculator",
+    "bedrock",
+    "bedrock-agent",
+    "bedrock-agent-runtime",
+    "bedrock-data-automation",
+    "bedrock-data-automation-runtime",
+    "bedrock-runtime",
+    "billing",
+    "billingconductor",
+    "braket",
+    "budgets",
+    "ce",
+    "chatbot",
+    "chime",
+    "chime-sdk-identity",
+    "chime-sdk-media-pipelines",
+    "chime-sdk-meetings",
+    "chime-sdk-messaging",
+    "chime-sdk-voice",
+    "cleanrooms",
+    "cleanroomsml",
+    "cloud9",
+    "cloudcontrol",
+    "clouddirectory",
+    "cloudformation",
+    "cloudfront",
+    "cloudfront-keyvaluestore",
+    "cloudhsm",
+    "cloudhsmv2",
+    "cloudsearch",
+    "cloudsearchdomain",
+    "cloudtrail",
+    "cloudtrail-data",
+    "cloudwatch",
+    "codeartifact",
+    "codebuild",
+    "codecatalyst",
+    "codecommit",
+    "codeconnections",
+    "codedeploy",
+    "codeguru-reviewer",
+    "codeguru-security",
+    "codeguruprofiler",
+    "codepipeline",
+    "codestar-connections",
+    "codestar-notifications",
+    "cognito-identity",
+    "cognito-idp",
+    "cognito-sync",
+    "comprehend",
+    "comprehendmedical",
+    "compute-optimizer",
+    "config",
+    "connect",
+    "connect-contact-lens",
+    "connectcampaigns",
+    "connectcampaignsv2",
+    "connectcases",
+    "connectparticipant",
+    "controlcatalog",
+    "controltower",
+    "cost-optimization-hub",
+    "cur",
+    "customer-profiles",
+    "databrew",
+    "dataexchange",
+    "datapipeline",
+    "datasync",
+    "datazone",
+    "dax",
+    "deadline",
+    "detective",
+    "devicefarm",
+    "devops-guru",
+    "directconnect",
+    "discovery",
+    "dlm",
+    "dms",
+    "docdb",
+    "docdb-elastic",
+    "drs",
+    "ds",
+    "ds-data",
+    "dsql",
+    "dynamodb",
+    "dynamodbstreams",
+    "ebs",
+    "ec2",
+    "ec2-instance-connect",
+    "ecr",
+    "ecr-public",
+    "ecs",
+    "efs",
+    "eks",
+    "eks-auth",
+    "elastic-inference",
+    "elasticache",
+    "elasticbeanstalk",
+    "elastictranscoder",
+    "elb",
+    "elbv2",
+    "emr",
+    "emr-containers",
+    "emr-serverless",
+    "entityresolution",
+    "es",
+    "events",
+    "evidently",
+    "finspace",
+    "finspace-data",
+    "firehose",
+    "fis",
+    "fms",
+    "forecast",
+    "forecastquery",
+    "frauddetector",
+    "freetier",
+    "fsx",
+    "gamelift",
+    "geo-maps",
+    "geo-places",
+    "geo-routes",
+    "glacier",
+    "globalaccelerator",
+    "glue",
+    "grafana",
+    "greengrass",
+    "greengrassv2",
+    "groundstation",
+    "guardduty",
+    "health",
+    "healthlake",
+    "iam",
+    "identitystore",
+    "imagebuilder",
+    "importexport",
+    "inspector",
+    "inspector-scan",
+    "inspector2",
+    "internetmonitor",
+    "invoicing",
+    "iot",
+    "iot-data",
+    "iot-jobs-data",
+    "iotanalytics",
+    "iotdeviceadvisor",
+    "iotevents",
+    "iotevents-data",
+    "iotfleethub",
+    "iotfleetwise",
+    "iotsecuretunneling",
+    "iotsitewise",
+    "iotthingsgraph",
+    "iottwinmaker",
+    "iotwireless",
+    "ivs",
+    "ivs-realtime",
+    "ivschat",
+    "kafka",
+    "kafkaconnect",
+    "kendra",
+    "kendra-ranking",
+    "keyspaces",
+    "kinesis",
+    "kinesis-video-archived-media",
+    "kinesis-video-media",
+    "kinesis-video-signaling",
+    "kinesis-video-webrtc-storage",
+    "kinesisanalytics",
+    "kinesisanalyticsv2",
+    "kinesisvideo",
+    "kms",
+    "lakeformation",
+    "lambda",
+    "launch-wizard",
+    "lex-models",
+    "lex-runtime",
+    "lexv2-models",
+    "lexv2-runtime",
+    "license-manager",
+    "license-manager-linux-subscriptions",
+    "license-manager-user-subscriptions",
+    "lightsail",
+    "location",
+    "logs",
+    "lookoutequipment",
+    "lookoutmetrics",
+    "lookoutvision",
+    "m2",
+    "machinelearning",
+    "macie2",
+    "mailmanager",
+    "managedblockchain",
+    "managedblockchain-query",
+    "marketplace-agreement",
+    "marketplace-catalog",
+    "marketplace-deployment",
+    "marketplace-entitlement",
+    "marketplace-reporting",
+    "marketplacecommerceanalytics",
+    "mediaconnect",
+    "mediaconvert",
+    "medialive",
+    "mediapackage",
+    "mediapackage-vod",
+    "mediapackagev2",
+    "mediastore",
+    "mediastore-data",
+    "mediatailor",
+    "medical-imaging",
+    "memorydb",
+    "meteringmarketplace",
+    "mgh",
+    "mgn",
+    "migration-hub-refactor-spaces",
+    "migrationhub-config",
+    "migrationhuborchestrator",
+    "migrationhubstrategy",
+    "mq",
+    "mturk",
+    "mwaa",
+    "neptune",
+    "neptune-graph",
+    "neptunedata",
+    "network-firewall",
+    "networkflowmonitor",
+    "networkmanager",
+    "networkmonitor",
+    "notifications",
+    "notificationscontacts",
+    "oam",
+    "observabilityadmin",
+    "omics",
+    "opensearch",
+    "opensearchserverless",
+    "opsworks",
+    "opsworkscm",
+    "organizations",
+    "osis",
+    "outposts",
+    "panorama",
+    "partnercentral-selling",
+    "payment-cryptography",
+    "payment-cryptography-data",
+    "pca-connector-ad",
+    "pca-connector-scep",
+    "pcs",
+    "personalize",
+    "personalize-events",
+    "personalize-runtime",
+    "pi",
+    "pinpoint",
+    "pinpoint-email",
+    "pinpoint-sms-voice",
+    "pinpoint-sms-voice-v2",
+    "pipes",
+    "polly",
+    "pricing",
+    "privatenetworks",
+    "proton",
+    "qapps",
+    "qbusiness",
+    "qconnect",
+    "qldb",
+    "qldb-session",
+    "quicksight",
+    "ram",
+    "rbin",
+    "rds",
+    "rds-data",
+    "redshift",
+    "redshift-data",
+    "redshift-serverless",
+    "rekognition",
+    "repostspace",
+    "resiliencehub",
+    "resource-explorer-2",
+    "resource-groups",
+    "resourcegroupstaggingapi",
+    "robomaker",
+    "rolesanywhere",
+    "route53",
+    "route53-recovery-cluster",
+    "route53-recovery-control-config",
+    "route53-recovery-readiness",
+    "route53domains",
+    "route53profiles",
+    "route53resolver",
+    "rum",
+    "s3",
+    "s3control",
+    "s3outposts",
+    "s3tables",
+    "sagemaker",
+    "sagemaker-a2i-runtime",
+    "sagemaker-edge",
+    "sagemaker-featurestore-runtime",
+    "sagemaker-geospatial",
+    "sagemaker-metrics",
+    "sagemaker-runtime",
+    "savingsplans",
+    "scheduler",
+    "schemas",
+    "sdb",
+    "secretsmanager",
+    "security-ir",
+    "securityhub",
+    "securitylake",
+    "serverlessrepo",
+    "service-quotas",
+    "servicecatalog",
+    "servicecatalog-appregistry",
+    "servicediscovery",
+    "ses",
+    "sesv2",
+    "shield",
+    "signer",
+    "simspaceweaver",
+    "sms",
+    "sms-voice",
+    "snow-device-management",
+    "snowball",
+    "sns",
+    "socialmessaging",
+    "sqs",
+    "ssm",
+    "ssm-contacts",
+    "ssm-incidents",
+    "ssm-quicksetup",
+    "ssm-sap",
+    "sso",
+    "sso-admin",
+    "sso-oidc",
+    "stepfunctions",
+    "storagegateway",
+    "sts",
+    "supplychain",
+    "support",
+    "support-app",
+    "swf",
+    "synthetics",
+    "taxsettings",
+    "textract",
+    "timestream-influxdb",
+    "timestream-query",
+    "timestream-write",
+    "tnb",
+    "transcribe",
+    "transfer",
+    "translate",
+    "trustedadvisor",
+    "verifiedpermissions",
+    "voice-id",
+    "vpc-lattice",
+    "waf",
+    "waf-regional",
+    "wafv2",
+    "wellarchitected",
+    "wisdom",
+    "workdocs",
+    "workmail",
+    "workmailmessageflow",
+    "workspaces",
+    "workspaces-thin-client",
+    "workspaces-web",
+    "xray",
+]
+ResourceServiceName = Literal[
+    "cloudformation",
+    "cloudwatch",
+    "dynamodb",
+    "ec2",
+    "glacier",
+    "iam",
+    "opsworks",
+    "s3",
+    "sns",
+    "sqs",
+]
+PaginatorName = Literal["describe_stream", "list_shards", "list_stream_consumers", "list_streams"]
+WaiterName = Literal["stream_exists", "stream_not_exists"]
+RegionName = Literal[
+    "af-south-1",
+    "ap-east-1",
+    "ap-northeast-1",
+    "ap-northeast-2",
+    "ap-northeast-3",
+    "ap-south-1",
+    "ap-south-2",
+    "ap-southeast-1",
+    "ap-southeast-2",
+    "ap-southeast-3",
+    "ap-southeast-4",
+    "ap-southeast-5",
+    "ap-southeast-7",
+    "ca-central-1",
+    "ca-west-1",
+    "eu-central-1",
+    "eu-central-2",
+    "eu-north-1",
+    "eu-south-1",
+    "eu-south-2",
+    "eu-west-1",
+    "eu-west-2",
+    "eu-west-3",
+    "il-central-1",
+    "me-central-1",
+    "me-south-1",
+    "mx-central-1",
+    "sa-east-1",
+    "us-east-1",
+    "us-east-2",
+    "us-west-1",
+    "us-west-2",
+]

types_boto3_kinesis/paginator.py

@@ -0,0 +1,144 @@
+"""
+Type annotations for kinesis service client paginators.
+
+[Documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/)
+
+Usage::
+
+    ```python
+    from boto3.session import Session
+
+    from types_boto3_kinesis.client import KinesisClient
+    from types_boto3_kinesis.paginator import (
+        DescribeStreamPaginator,
+        ListShardsPaginator,
+        ListStreamConsumersPaginator,
+        ListStreamsPaginator,
+    )
+
+    session = Session()
+    client: KinesisClient = session.client("kinesis")
+
+    describe_stream_paginator: DescribeStreamPaginator = client.get_paginator("describe_stream")
+    list_shards_paginator: ListShardsPaginator = client.get_paginator("list_shards")
+    list_stream_consumers_paginator: ListStreamConsumersPaginator = client.get_paginator("list_stream_consumers")
+    list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
+    ```
+
+Copyright 2025 Vlad Emelianov
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+from botocore.paginate import PageIterator, Paginator
+
+from .type_defs import (
+    DescribeStreamInputPaginateTypeDef,
+    DescribeStreamOutputTypeDef,
+    ListShardsInputPaginateTypeDef,
+    ListShardsOutputTypeDef,
+    ListStreamConsumersInputPaginateTypeDef,
+    ListStreamConsumersOutputTypeDef,
+    ListStreamsInputPaginateTypeDef,
+    ListStreamsOutputTypeDef,
+)
+
+if sys.version_info >= (3, 12):
+    from typing import Unpack
+else:
+    from typing_extensions import Unpack
+
+
+__all__ = (
+    "DescribeStreamPaginator",
+    "ListShardsPaginator",
+    "ListStreamConsumersPaginator",
+    "ListStreamsPaginator",
+)
+
+
+if TYPE_CHECKING:
+    _DescribeStreamPaginatorBase = Paginator[DescribeStreamOutputTypeDef]
+else:
+    _DescribeStreamPaginatorBase = Paginator  # type: ignore[assignment]
+
+
+class DescribeStreamPaginator(_DescribeStreamPaginatorBase):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/DescribeStream.html#Kinesis.Paginator.DescribeStream)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#describestreampaginator)
+    """
+
+    def paginate(  # type: ignore[override]
+        self, **kwargs: Unpack[DescribeStreamInputPaginateTypeDef]
+    ) -> PageIterator[DescribeStreamOutputTypeDef]:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/DescribeStream.html#Kinesis.Paginator.DescribeStream.paginate)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#describestreampaginator)
+        """
+
+
+if TYPE_CHECKING:
+    _ListShardsPaginatorBase = Paginator[ListShardsOutputTypeDef]
+else:
+    _ListShardsPaginatorBase = Paginator  # type: ignore[assignment]
+
+
+class ListShardsPaginator(_ListShardsPaginatorBase):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/ListShards.html#Kinesis.Paginator.ListShards)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#listshardspaginator)
+    """
+
+    def paginate(  # type: ignore[override]
+        self, **kwargs: Unpack[ListShardsInputPaginateTypeDef]
+    ) -> PageIterator[ListShardsOutputTypeDef]:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/ListShards.html#Kinesis.Paginator.ListShards.paginate)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#listshardspaginator)
+        """
+
+
+if TYPE_CHECKING:
+    _ListStreamConsumersPaginatorBase = Paginator[ListStreamConsumersOutputTypeDef]
+else:
+    _ListStreamConsumersPaginatorBase = Paginator  # type: ignore[assignment]
+
+
+class ListStreamConsumersPaginator(_ListStreamConsumersPaginatorBase):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/ListStreamConsumers.html#Kinesis.Paginator.ListStreamConsumers)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#liststreamconsumerspaginator)
+    """
+
+    def paginate(  # type: ignore[override]
+        self, **kwargs: Unpack[ListStreamConsumersInputPaginateTypeDef]
+    ) -> PageIterator[ListStreamConsumersOutputTypeDef]:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/ListStreamConsumers.html#Kinesis.Paginator.ListStreamConsumers.paginate)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#liststreamconsumerspaginator)
+        """
+
+
+if TYPE_CHECKING:
+    _ListStreamsPaginatorBase = Paginator[ListStreamsOutputTypeDef]
+else:
+    _ListStreamsPaginatorBase = Paginator  # type: ignore[assignment]
+
+
+class ListStreamsPaginator(_ListStreamsPaginatorBase):
+    """
+    [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/ListStreams.html#Kinesis.Paginator.ListStreams)
+    [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#liststreamspaginator)
+    """
+
+    def paginate(  # type: ignore[override]
+        self, **kwargs: Unpack[ListStreamsInputPaginateTypeDef]
+    ) -> PageIterator[ListStreamsOutputTypeDef]:
+        """
+        [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis/paginator/ListStreams.html#Kinesis.Paginator.ListStreams.paginate)
+        [Show types-boto3 documentation](https://youtype.github.io/types_boto3_docs/types_boto3_kinesis/paginators/#liststreamspaginator)
+        """