{"id":3694,"library":"mypy-boto3-s3vectors","title":"mypy-boto3-s3vectors","description":"mypy-boto3-s3vectors provides type annotations for the boto3 S3Vectors 1.42.3 service, enhancing development with static type checking and IDE auto-completion. It is automatically generated by mypy-boto3-builder 8.12.0. The project maintains an active release cadence, aligning with boto3 updates.","status":"active","version":"1.42.3","language":"en","source_language":"en","source_url":"https://github.com/youtype/mypy_boto3_builder","tags":["mypy","boto3","aws","type-hints","stubs","s3vectors"],"install":[{"cmd":"pip install mypy-boto3-s3vectors","lang":"bash","label":"Standalone installation"},{"cmd":"pip install 'boto3-stubs[s3vectors]'","lang":"bash","label":"Recommended: Install with boto3-stubs"}],"dependencies":[{"reason":"Runtime dependency for which type annotations are provided.","package":"boto3"},{"reason":"Static type checker that utilizes these stubs.","package":"mypy","optional":true}],"imports":[{"symbol":"S3VectorsClient","correct":"from mypy_boto3_s3vectors import S3VectorsClient"},{"note":"Import specific paginator types from the .paginator submodule.","symbol":"ListIndexesPaginator","correct":"from mypy_boto3_s3vectors.paginator import ListIndexesPaginator"},{"note":"Import literal types from the .literals submodule for stricter type checking of allowed string values.","symbol":"DataTypeType","correct":"from mypy_boto3_s3vectors.literals import DataTypeType"},{"note":"Import TypedDict definitions from the .type_defs submodule for request/response structures.","symbol":"EncryptionConfigurationTypeDef","correct":"from mypy_boto3_s3vectors.type_defs import EncryptionConfigurationTypeDef"}],"quickstart":{"code":"import boto3\nfrom boto3.session import Session\nfrom mypy_boto3_s3vectors import S3VectorsClient\nfrom mypy_boto3_s3vectors.paginator import ListIndexesPaginator\nfrom mypy_boto3_s3vectors.type_defs import CreateIndexRequestRequestTypeDef\n\ndef main():\n    session = Session(region_name=\"us-east-1\") # Use a specific region\n    s3vectors_client: S3VectorsClient = session.client(\"s3vectors\")\n\n    # Example client operation (dummy call for demonstration)\n    # Note: S3Vectors service methods should be referenced from AWS S3Vectors documentation\n    # This is a placeholder demonstrating type annotation usage.\n    try:\n        # Assuming 'list_indexes' is an available operation to demonstrate a paginator\n        list_indexes_paginator: ListIndexesPaginator = s3vectors_client.get_paginator(\"list_indexes\")\n        print(f\"Paginator for list_indexes created: {list_indexes_paginator}\")\n\n        # Example of using a TypedDict for a request (assuming CreateIndex operation)\n        create_index_params: CreateIndexRequestRequestTypeDef = {\n            \"Name\": \"my-test-index\",\n            \"VectorBucketName\": \"my-vector-bucket\",\n            \"VectorIndexConfig\": {\"VectorDimension\": 1536},\n            # ... other required parameters for CreateIndex\n        }\n        # result = s3vectors_client.create_index(**create_index_params)\n        print(f\"Example TypedDict for CreateIndex: {create_index_params}\")\n\n    except Exception as e:\n        print(f\"An error occurred (this is an example, actual S3Vectors operations may vary): {e}\")\n\nif __name__ == \"__main__\":\n    main()","lang":"python","description":"This quickstart demonstrates how to initialize the S3Vectors client with type annotations, access a paginator, and use a TypedDict for a hypothetical API request. Replace placeholder values and operations with actual S3Vectors methods as per AWS documentation."},"warnings":[{"fix":"Upgrade your Python environment to 3.9 or higher.","message":"Support for Python 3.8 has been removed in mypy-boto3-builder version 8.12.0. Users on Python 3.8 will need to upgrade to Python 3.9 or newer to use versions generated by this builder or the corresponding stubs.","severity":"breaking","affected_versions":">=8.12.0 of mypy-boto3-builder (and thus mypy-boto3-s3vectors versions generated by it)"},{"fix":"Ensure your type checker (e.g., mypy) is up-to-date and your build system correctly recognizes PEP 561 stubs. No specific code changes should be needed in most user cases.","message":"The library has migrated to PEP 561 compliant packages as of mypy-boto3-builder 8.12.0. This change affects package structure and how type checkers locate stubs, potentially requiring updates to build configurations or older `mypy` versions.","severity":"breaking","affected_versions":">=8.12.0 of mypy-boto3-builder"},{"fix":"Update imports and references to affected TypedDicts. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`.","message":"Type Definition (TypeDef) names for packed method arguments have been shortened, and conflicting `Extra` postfixes have been moved as of mypy-boto3-builder 8.9.0. This is a breaking change for code explicitly importing or referencing these TypedDict names.","severity":"breaking","affected_versions":">=8.9.0 of mypy-boto3-builder"},{"fix":"Migrate your project to use `boto3-stubs` and its per-service sub-packages (like `mypy-boto3-s3vectors`) for the latest type annotations.","message":"If you were previously using older `mypy-boto3` packages (pre-`boto3-stubs` era), the legacy `mypy-boto3` system has been moved to a separate product in mypy-boto3-builder 8.9.0 and is no longer generated alongside `boto3-stubs`.","severity":"deprecated","affected_versions":"<8.9.0 of mypy-boto3-builder (for users migrating from legacy `mypy-boto3`)"}],"env_vars":null,"last_verified":"2026-04-11T00:00:00.000Z","next_check":"2026-07-10T00:00:00.000Z"}