{"library":"mypy-boto3-cloudsearchdomain","title":"mypy-boto3-cloudsearchdomain Type Stubs for AWS CloudSearchDomain","description":"This library provides type annotations for the `boto3` CloudSearchDomain service (version 1.42.3), generated by `mypy-boto3-builder` 8.12.0. It allows static type checking with tools like MyPy, enhancing code quality and developer experience when working with AWS CloudSearchDomain using `boto3`. The package closely follows `boto3` releases, offering frequent updates to maintain compatibility.","language":"python","status":"active","last_verified":"Thu May 14","install":{"commands":["pip install mypy-boto3-cloudsearchdomain boto3"],"cli":null},"imports":["from mypy_boto3_cloudsearchdomain import CloudSearchDomainClient","from mypy_boto3_cloudsearchdomain.client import CloudSearchDomainClient"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import os\nimport boto3\nfrom mypy_boto3_cloudsearchdomain import CloudSearchDomainClient\n\n# The CloudSearchDomain client often requires an explicit endpoint_url.\n# In a real application, you would retrieve this dynamically from\n# boto3.client(\"cloudsearch\").describe_domains().\n# Replace with your actual CloudSearch domain search endpoint URL or set as env var.\nCLOUDSEARCH_DOMAIN_ENDPOINT = os.environ.get(\n    \"CLOUDSEARCH_DOMAIN_ENDPOINT\", \n    \"https://search-your-domain-xyz.us-east-1.cloudsearch.amazonaws.com\" # Placeholder\n)\n\ntry:\n    # Create a type-hinted CloudSearchDomain client\n    client: CloudSearchDomainClient = boto3.client(\n        \"cloudsearchdomain\",\n        endpoint_url=CLOUDSEARCH_DOMAIN_ENDPOINT,\n        # region_name=os.environ.get(\"AWS_REGION\", \"us-east-1\") # Optional\n    )\n\n    # Perform a dummy search operation (requires a valid domain and query)\n    # This call will likely fail if CLOUDSEARCH_DOMAIN_ENDPOINT is not valid or domain is empty.\n    response = client.search(\n        query=\"example\",\n        queryParser=\"simple\"\n    )\n\n    print(f\"Search found {response.get('hits', {}).get('found', 0)} items.\")\n    # Further operations with type-checked client...\n\nexcept Exception as e:\n    print(f\"An error occurred: {e}\")\n    print(\"Ensure 'CLOUDSEARCH_DOMAIN_ENDPOINT' is set to a valid CloudSearch domain search endpoint.\")\n    print(\"You might need to use `boto3.client('cloudsearch').describe_domains()` to obtain it.\")\n    print(\"Also, verify AWS credentials are configured (e.g., via environment variables or ~/.aws/credentials).\")\n","lang":"python","description":"This quickstart demonstrates how to initialize a type-hinted `CloudSearchDomainClient` and perform a basic search operation. Note that the CloudSearchDomain client typically requires a specific `endpoint_url` for operations like `search` and `upload_documents`. In a production environment, this endpoint is usually discovered via the `cloudsearch` configuration service. The example includes placeholders for the endpoint and highlights common setup requirements.","tag":null,"tag_description":null,"last_tested":"2026-04-25","results":[{"runtime":"python:3.10-alpine","exit_code":0},{"runtime":"python:3.10-slim","exit_code":0},{"runtime":"python:3.11-alpine","exit_code":0},{"runtime":"python:3.11-slim","exit_code":0},{"runtime":"python:3.12-alpine","exit_code":0},{"runtime":"python:3.12-slim","exit_code":0},{"runtime":"python:3.13-alpine","exit_code":0},{"runtime":"python:3.13-slim","exit_code":0},{"runtime":"python:3.9-alpine","exit_code":0},{"runtime":"python:3.9-slim","exit_code":0}]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-14","installed_version":"1.43.0","pypi_latest":"1.43.0","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":3.8,"avg_import_s":0.59,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.53,"mem_mb":12.6,"disk_size":"51.0M"},{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.53,"mem_mb":12.5,"disk_size":"50.9M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":4.1,"import_time_s":0.42,"mem_mb":12.6,"disk_size":"52M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.47,"mem_mb":12.5,"disk_size":"51M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.74,"mem_mb":14.4,"disk_size":"54.0M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.8,"mem_mb":14.3,"disk_size":"53.9M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":4,"import_time_s":0.62,"mem_mb":14.4,"disk_size":"55M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.67,"mem_mb":14.3,"disk_size":"54M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.63,"mem_mb":13.7,"disk_size":"45.3M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.68,"mem_mb":13.5,"disk_size":"45.2M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3.2,"import_time_s":0.62,"mem_mb":13.7,"disk_size":"46M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.7,"mem_mb":13.5,"disk_size":"46M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.62,"mem_mb":14.6,"disk_size":"45.0M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.69,"mem_mb":14.4,"disk_size":"44.8M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3,"import_time_s":0.6,"mem_mb":14.6,"disk_size":"46M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.7,"mem_mb":14.4,"disk_size":"45M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.42,"mem_mb":11.8,"disk_size":"50.4M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.46,"mem_mb":11.8,"disk_size":"50.4M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":4.8,"import_time_s":0.42,"mem_mb":11.8,"disk_size":"51M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"mypy-boto3-cloudsearchdomain","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.41,"mem_mb":11.8,"disk_size":"51M"}]}}