Type annotations for boto3#
Auto-generated documentation for boto3 type annotations package boto3-stubs.
Generated by mypy-boto3-builder.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Auto-discover services
and select services you use in the current project.
From PyPI with pip#
Install boto3-stubs
to add type annotations for boto3
package.
# install type annotations only for boto3
python -m pip install boto3-stubs
# install boto3 type annotations
# for ec2, s3, rds, lambda, sqs, dynamo and cloudformation
python -m pip install 'boto3-stubs[essential]'
# or install annotations for services you use
python -m pip install 'boto3-stubs[acm,apigateway]'
# or install annotations in sync with boto3 version
python -m pip install 'boto3-stubs[boto3]'
# 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[essential]'
From conda-forge#
Add conda-forge
to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge
channel has been enabled, boto3-stubs
and boto3-stubs-essential
can be installed with:
conda install boto3-stubs boto3-stubs-essential
It is possible to list all of the versions of boto3-stubs
available on your platform with:
conda search boto3-stubs --channel conda-forge
How to uninstall#
# uninstall boto3-stubs
python -m pip uninstall -y boto3-stubs
Packages#
boto3-stubs
- boto3 type annotations withsession.client/resource
overloadsboto3-stubs-lite
- boto3 type annotations withoutsession.client/resource
overloads-
botocore-stubs
- botocore type annotations -
mypy-boto3-accessanalyzer for AccessAnalyzer service
-
mypy-boto3-account for Account service
-
mypy-boto3-acm for ACM service
-
mypy-boto3-acm-pca for ACMPCA service
-
mypy-boto3-alexaforbusiness for AlexaForBusiness service
-
mypy-boto3-amp for PrometheusService service
-
mypy-boto3-amplify for Amplify service
-
mypy-boto3-amplifybackend for AmplifyBackend service
-
mypy-boto3-amplifyuibuilder for AmplifyUIBuilder service
-
mypy-boto3-apigateway for APIGateway service
-
mypy-boto3-apigatewaymanagementapi for ApiGatewayManagementApi service
-
mypy-boto3-apigatewayv2 for ApiGatewayV2 service
-
mypy-boto3-appconfig for AppConfig service
-
mypy-boto3-appconfigdata for AppConfigData service
-
mypy-boto3-appfabric for AppFabric service
-
mypy-boto3-appflow for Appflow service
-
mypy-boto3-appintegrations for AppIntegrationsService service
-
mypy-boto3-application-autoscaling for ApplicationAutoScaling service
-
mypy-boto3-application-insights for ApplicationInsights service
-
mypy-boto3-applicationcostprofiler for ApplicationCostProfiler service
-
mypy-boto3-appmesh for AppMesh service
-
mypy-boto3-apprunner for AppRunner service
-
mypy-boto3-appstream for AppStream service
-
mypy-boto3-appsync for AppSync service
-
mypy-boto3-arc-zonal-shift for ARCZonalShift service
-
mypy-boto3-athena for Athena service
-
mypy-boto3-auditmanager for AuditManager service
-
mypy-boto3-autoscaling for AutoScaling service
-
mypy-boto3-autoscaling-plans for AutoScalingPlans service
-
mypy-boto3-b2bi for B2BI service
-
mypy-boto3-backup for Backup service
-
mypy-boto3-backup-gateway for BackupGateway service
-
mypy-boto3-backupstorage for BackupStorage service
-
mypy-boto3-batch for Batch service
-
mypy-boto3-bcm-data-exports for BillingandCostManagementDataExports service
-
mypy-boto3-bedrock for Bedrock service
-
mypy-boto3-bedrock-agent for AgentsforBedrock service
-
mypy-boto3-bedrock-agent-runtime for AgentsforBedrockRuntime service
-
mypy-boto3-bedrock-runtime for BedrockRuntime service
-
mypy-boto3-billingconductor for BillingConductor service
-
mypy-boto3-braket for Braket service
-
mypy-boto3-budgets for Budgets service
-
mypy-boto3-ce for CostExplorer service
-
mypy-boto3-chime for Chime service
-
mypy-boto3-chime-sdk-identity for ChimeSDKIdentity service
-
mypy-boto3-chime-sdk-media-pipelines for ChimeSDKMediaPipelines service
-
mypy-boto3-chime-sdk-meetings for ChimeSDKMeetings service
-
mypy-boto3-chime-sdk-messaging for ChimeSDKMessaging service
-
mypy-boto3-chime-sdk-voice for ChimeSDKVoice service
-
mypy-boto3-cleanrooms for CleanRoomsService service
-
mypy-boto3-cleanroomsml for cleanroomsml service
-
mypy-boto3-cloud9 for Cloud9 service
-
mypy-boto3-cloudcontrol for CloudControlApi service
-
mypy-boto3-clouddirectory for CloudDirectory service
-
mypy-boto3-cloudformation for CloudFormation service
-
mypy-boto3-cloudfront for CloudFront service
-
mypy-boto3-cloudfront-keyvaluestore for CloudFrontKeyValueStore service
-
mypy-boto3-cloudhsm for CloudHSM service
-
mypy-boto3-cloudhsmv2 for CloudHSMV2 service
-
mypy-boto3-cloudsearch for CloudSearch service
-
mypy-boto3-cloudsearchdomain for CloudSearchDomain service
-
mypy-boto3-cloudtrail for CloudTrail service
-
mypy-boto3-cloudtrail-data for CloudTrailDataService service
-
mypy-boto3-cloudwatch for CloudWatch service
-
mypy-boto3-codeartifact for CodeArtifact service
-
mypy-boto3-codebuild for CodeBuild service
-
mypy-boto3-codecatalyst for CodeCatalyst service
-
mypy-boto3-codecommit for CodeCommit service
-
mypy-boto3-codedeploy for CodeDeploy service
-
mypy-boto3-codeguru-reviewer for CodeGuruReviewer service
-
mypy-boto3-codeguru-security for CodeGuruSecurity service
-
mypy-boto3-codeguruprofiler for CodeGuruProfiler service
-
mypy-boto3-codepipeline for CodePipeline service
-
mypy-boto3-codestar for CodeStar service
-
mypy-boto3-codestar-connections for CodeStarconnections service
-
mypy-boto3-codestar-notifications for CodeStarNotifications service
-
mypy-boto3-cognito-identity for CognitoIdentity service
-
mypy-boto3-cognito-idp for CognitoIdentityProvider service
-
mypy-boto3-cognito-sync for CognitoSync service
-
mypy-boto3-comprehend for Comprehend service
-
mypy-boto3-comprehendmedical for ComprehendMedical service
-
mypy-boto3-compute-optimizer for ComputeOptimizer service
-
mypy-boto3-config for ConfigService service
-
mypy-boto3-connect for Connect service
-
mypy-boto3-connect-contact-lens for ConnectContactLens service
-
mypy-boto3-connectcampaigns for ConnectCampaignService service
-
mypy-boto3-connectcases for ConnectCases service
-
mypy-boto3-connectparticipant for ConnectParticipant service
-
mypy-boto3-controltower for ControlTower service
-
mypy-boto3-cost-optimization-hub for CostOptimizationHub service
-
mypy-boto3-cur for CostandUsageReportService service
-
mypy-boto3-customer-profiles for CustomerProfiles service
-
mypy-boto3-databrew for GlueDataBrew service
-
mypy-boto3-dataexchange for DataExchange service
-
mypy-boto3-datapipeline for DataPipeline service
-
mypy-boto3-datasync for DataSync service
-
mypy-boto3-datazone for DataZone service
-
mypy-boto3-dax for DAX service
-
mypy-boto3-detective for Detective service
-
mypy-boto3-devicefarm for DeviceFarm service
-
mypy-boto3-devops-guru for DevOpsGuru service
-
mypy-boto3-directconnect for DirectConnect service
-
mypy-boto3-discovery for ApplicationDiscoveryService service
-
mypy-boto3-dlm for DLM service
-
mypy-boto3-dms for DatabaseMigrationService service
-
mypy-boto3-docdb for DocDB service
-
mypy-boto3-docdb-elastic for DocDBElastic service
-
mypy-boto3-drs for drs service
-
mypy-boto3-ds for DirectoryService service
-
mypy-boto3-dynamodb for DynamoDB service
-
mypy-boto3-dynamodbstreams for DynamoDBStreams service
-
mypy-boto3-ebs for EBS service
-
mypy-boto3-ec2 for EC2 service
-
mypy-boto3-ec2-instance-connect for EC2InstanceConnect service
-
mypy-boto3-ecr for ECR service
-
mypy-boto3-ecr-public for ECRPublic service
-
mypy-boto3-ecs for ECS service
-
mypy-boto3-efs for EFS service
-
mypy-boto3-eks for EKS service
-
mypy-boto3-eks-auth for EKSAuth service
-
mypy-boto3-elastic-inference for ElasticInference service
-
mypy-boto3-elasticache for ElastiCache service
-
mypy-boto3-elasticbeanstalk for ElasticBeanstalk service
-
mypy-boto3-elastictranscoder for ElasticTranscoder service
-
mypy-boto3-elb for ElasticLoadBalancing service
-
mypy-boto3-elbv2 for ElasticLoadBalancingv2 service
-
mypy-boto3-emr for EMR service
-
mypy-boto3-emr-containers for EMRContainers service
-
mypy-boto3-emr-serverless for EMRServerless service
-
mypy-boto3-entityresolution for EntityResolution service
-
mypy-boto3-es for ElasticsearchService service
-
mypy-boto3-events for EventBridge service
-
mypy-boto3-evidently for CloudWatchEvidently service
-
mypy-boto3-finspace for finspace service
-
mypy-boto3-finspace-data for FinSpaceData service
-
mypy-boto3-firehose for Firehose service
-
mypy-boto3-fis for FIS service
-
mypy-boto3-fms for FMS service
-
mypy-boto3-forecast for ForecastService service
-
mypy-boto3-forecastquery for ForecastQueryService service
-
mypy-boto3-frauddetector for FraudDetector service
-
mypy-boto3-freetier for FreeTier service
-
mypy-boto3-fsx for FSx service
-
mypy-boto3-gamelift for GameLift service
-
mypy-boto3-glacier for Glacier service
-
mypy-boto3-globalaccelerator for GlobalAccelerator service
-
mypy-boto3-glue for Glue service
-
mypy-boto3-grafana for ManagedGrafana service
-
mypy-boto3-greengrass for Greengrass service
-
mypy-boto3-greengrassv2 for GreengrassV2 service
-
mypy-boto3-groundstation for GroundStation service
-
mypy-boto3-guardduty for GuardDuty service
-
mypy-boto3-health for Health service
-
mypy-boto3-healthlake for HealthLake service
-
mypy-boto3-honeycode for Honeycode service
-
mypy-boto3-iam for IAM service
-
mypy-boto3-identitystore for IdentityStore service
-
mypy-boto3-imagebuilder for imagebuilder service
-
mypy-boto3-importexport for ImportExport service
-
mypy-boto3-inspector for Inspector service
-
mypy-boto3-inspector-scan for inspectorscan service
-
mypy-boto3-inspector2 for Inspector2 service
-
mypy-boto3-internetmonitor for CloudWatchInternetMonitor service
-
mypy-boto3-iot for IoT service
-
mypy-boto3-iot-data for IoTDataPlane service
-
mypy-boto3-iot-jobs-data for IoTJobsDataPlane service
-
mypy-boto3-iot-roborunner for IoTRoboRunner service
-
mypy-boto3-iot1click-devices for IoT1ClickDevicesService service
-
mypy-boto3-iot1click-projects for IoT1ClickProjects service
-
mypy-boto3-iotanalytics for IoTAnalytics service
-
mypy-boto3-iotdeviceadvisor for IoTDeviceAdvisor service
-
mypy-boto3-iotevents for IoTEvents service
-
mypy-boto3-iotevents-data for IoTEventsData service
-
mypy-boto3-iotfleethub for IoTFleetHub service
-
mypy-boto3-iotfleetwise for IoTFleetWise service
-
mypy-boto3-iotsecuretunneling for IoTSecureTunneling service
-
mypy-boto3-iotsitewise for IoTSiteWise service
-
mypy-boto3-iotthingsgraph for IoTThingsGraph service
-
mypy-boto3-iottwinmaker for IoTTwinMaker service
-
mypy-boto3-iotwireless for IoTWireless service
-
mypy-boto3-ivs for IVS service
-
mypy-boto3-ivs-realtime for ivsrealtime service
-
mypy-boto3-ivschat for ivschat service
-
mypy-boto3-kafka for Kafka service
-
mypy-boto3-kafkaconnect for KafkaConnect service
-
mypy-boto3-kendra for kendra service
-
mypy-boto3-kendra-ranking for KendraRanking service
-
mypy-boto3-keyspaces for Keyspaces service
-
mypy-boto3-kinesis for Kinesis service
-
mypy-boto3-kinesis-video-archived-media for KinesisVideoArchivedMedia service
-
mypy-boto3-kinesis-video-media for KinesisVideoMedia service
-
mypy-boto3-kinesis-video-signaling for KinesisVideoSignalingChannels service
-
mypy-boto3-kinesis-video-webrtc-storage for KinesisVideoWebRTCStorage service
-
mypy-boto3-kinesisanalytics for KinesisAnalytics service
-
mypy-boto3-kinesisanalyticsv2 for KinesisAnalyticsV2 service
-
mypy-boto3-kinesisvideo for KinesisVideo service
-
mypy-boto3-kms for KMS service
-
mypy-boto3-lakeformation for LakeFormation service
-
mypy-boto3-lambda for Lambda service
-
mypy-boto3-launch-wizard for LaunchWizard service
-
mypy-boto3-lex-models for LexModelBuildingService service
-
mypy-boto3-lex-runtime for LexRuntimeService service
-
mypy-boto3-lexv2-models for LexModelsV2 service
-
mypy-boto3-lexv2-runtime for LexRuntimeV2 service
-
mypy-boto3-license-manager for LicenseManager service
-
mypy-boto3-license-manager-linux-subscriptions for LicenseManagerLinuxSubscriptions service
-
mypy-boto3-license-manager-user-subscriptions for LicenseManagerUserSubscriptions service
-
mypy-boto3-lightsail for Lightsail service
-
mypy-boto3-location for LocationService service
-
mypy-boto3-logs for CloudWatchLogs service
-
mypy-boto3-lookoutequipment for LookoutEquipment service
-
mypy-boto3-lookoutmetrics for LookoutMetrics service
-
mypy-boto3-lookoutvision for LookoutforVision service
-
mypy-boto3-m2 for MainframeModernization service
-
mypy-boto3-machinelearning for MachineLearning service
-
mypy-boto3-macie2 for Macie2 service
-
mypy-boto3-managedblockchain for ManagedBlockchain service
-
mypy-boto3-managedblockchain-query for ManagedBlockchainQuery service
-
mypy-boto3-marketplace-agreement for AgreementService service
-
mypy-boto3-marketplace-catalog for MarketplaceCatalog service
-
mypy-boto3-marketplace-deployment for MarketplaceDeploymentService service
-
mypy-boto3-marketplace-entitlement for MarketplaceEntitlementService service
-
mypy-boto3-marketplacecommerceanalytics for MarketplaceCommerceAnalytics service
-
mypy-boto3-mediaconnect for MediaConnect service
-
mypy-boto3-mediaconvert for MediaConvert service
-
mypy-boto3-medialive for MediaLive service
-
mypy-boto3-mediapackage for MediaPackage service
-
mypy-boto3-mediapackage-vod for MediaPackageVod service
-
mypy-boto3-mediapackagev2 for mediapackagev2 service
-
mypy-boto3-mediastore for MediaStore service
-
mypy-boto3-mediastore-data for MediaStoreData service
-
mypy-boto3-mediatailor for MediaTailor service
-
mypy-boto3-medical-imaging for HealthImaging service
-
mypy-boto3-memorydb for MemoryDB service
-
mypy-boto3-meteringmarketplace for MarketplaceMetering service
-
mypy-boto3-mgh for MigrationHub service
-
mypy-boto3-mgn for mgn service
-
mypy-boto3-migration-hub-refactor-spaces for MigrationHubRefactorSpaces service
-
mypy-boto3-migrationhub-config for MigrationHubConfig service
-
mypy-boto3-migrationhuborchestrator for MigrationHubOrchestrator service
-
mypy-boto3-migrationhubstrategy for MigrationHubStrategyRecommendations service
-
mypy-boto3-mobile for Mobile service
-
mypy-boto3-mq for MQ service
-
mypy-boto3-mturk for MTurk service
-
mypy-boto3-mwaa for MWAA service
-
mypy-boto3-neptune for Neptune service
-
mypy-boto3-neptunedata for NeptuneData service
-
mypy-boto3-network-firewall for NetworkFirewall service
-
mypy-boto3-networkmanager for NetworkManager service
-
mypy-boto3-nimble for NimbleStudio service
-
mypy-boto3-oam for CloudWatchObservabilityAccessManager service
-
mypy-boto3-omics for Omics service
-
mypy-boto3-opensearch for OpenSearchService service
-
mypy-boto3-opensearchserverless for OpenSearchServiceServerless service
-
mypy-boto3-opsworks for OpsWorks service
-
mypy-boto3-opsworkscm for OpsWorksCM service
-
mypy-boto3-organizations for Organizations service
-
mypy-boto3-osis for OpenSearchIngestion service
-
mypy-boto3-outposts for Outposts service
-
mypy-boto3-panorama for Panorama service
-
mypy-boto3-payment-cryptography for PaymentCryptographyControlPlane service
-
mypy-boto3-payment-cryptography-data for PaymentCryptographyDataPlane service
-
mypy-boto3-pca-connector-ad for PcaConnectorAd service
-
mypy-boto3-personalize for Personalize service
-
mypy-boto3-personalize-events for PersonalizeEvents service
-
mypy-boto3-personalize-runtime for PersonalizeRuntime service
-
mypy-boto3-pi for PI service
-
mypy-boto3-pinpoint for Pinpoint service
-
mypy-boto3-pinpoint-email for PinpointEmail service
-
mypy-boto3-pinpoint-sms-voice for PinpointSMSVoice service
-
mypy-boto3-pinpoint-sms-voice-v2 for PinpointSMSVoiceV2 service
-
mypy-boto3-pipes for EventBridgePipes service
-
mypy-boto3-polly for Polly service
-
mypy-boto3-pricing for Pricing service
-
mypy-boto3-privatenetworks for Private5G service
-
mypy-boto3-proton for Proton service
-
mypy-boto3-qbusiness for QBusiness service
-
mypy-boto3-qconnect for QConnect service
-
mypy-boto3-qldb for QLDB service
-
mypy-boto3-qldb-session for QLDBSession service
-
mypy-boto3-quicksight for QuickSight service
-
mypy-boto3-ram for RAM service
-
mypy-boto3-rbin for RecycleBin service
-
mypy-boto3-rds for RDS service
-
mypy-boto3-rds-data for RDSDataService service
-
mypy-boto3-redshift for Redshift service
-
mypy-boto3-redshift-data for RedshiftDataAPIService service
-
mypy-boto3-redshift-serverless for RedshiftServerless service
-
mypy-boto3-rekognition for Rekognition service
-
mypy-boto3-repostspace for rePostPrivate service
-
mypy-boto3-resiliencehub for ResilienceHub service
-
mypy-boto3-resource-explorer-2 for ResourceExplorer service
-
mypy-boto3-resource-groups for ResourceGroups service
-
mypy-boto3-resourcegroupstaggingapi for ResourceGroupsTaggingAPI service
-
mypy-boto3-robomaker for RoboMaker service
-
mypy-boto3-rolesanywhere for IAMRolesAnywhere service
-
mypy-boto3-route53 for Route53 service
-
mypy-boto3-route53-recovery-cluster for Route53RecoveryCluster service
-
mypy-boto3-route53-recovery-control-config for Route53RecoveryControlConfig service
-
mypy-boto3-route53-recovery-readiness for Route53RecoveryReadiness service
-
mypy-boto3-route53domains for Route53Domains service
-
mypy-boto3-route53resolver for Route53Resolver service
-
mypy-boto3-rum for CloudWatchRUM service
-
mypy-boto3-s3 for S3 service
-
mypy-boto3-s3control for S3Control service
-
mypy-boto3-s3outposts for S3Outposts service
-
mypy-boto3-sagemaker for SageMaker service
-
mypy-boto3-sagemaker-a2i-runtime for AugmentedAIRuntime service
-
mypy-boto3-sagemaker-edge for SagemakerEdgeManager service
-
mypy-boto3-sagemaker-featurestore-runtime for SageMakerFeatureStoreRuntime service
-
mypy-boto3-sagemaker-geospatial for SageMakergeospatialcapabilities service
-
mypy-boto3-sagemaker-metrics for SageMakerMetrics service
-
mypy-boto3-sagemaker-runtime for SageMakerRuntime service
-
mypy-boto3-savingsplans for SavingsPlans service
-
mypy-boto3-scheduler for EventBridgeScheduler service
-
mypy-boto3-schemas for Schemas service
-
mypy-boto3-sdb for SimpleDB service
-
mypy-boto3-secretsmanager for SecretsManager service
-
mypy-boto3-securityhub for SecurityHub service
-
mypy-boto3-securitylake for SecurityLake service
-
mypy-boto3-serverlessrepo for ServerlessApplicationRepository service
-
mypy-boto3-service-quotas for ServiceQuotas service
-
mypy-boto3-servicecatalog for ServiceCatalog service
-
mypy-boto3-servicecatalog-appregistry for AppRegistry service
-
mypy-boto3-servicediscovery for ServiceDiscovery service
-
mypy-boto3-ses for SES service
-
mypy-boto3-sesv2 for SESV2 service
-
mypy-boto3-shield for Shield service
-
mypy-boto3-signer for signer service
-
mypy-boto3-simspaceweaver for SimSpaceWeaver service
-
mypy-boto3-sms for SMS service
-
mypy-boto3-sms-voice for PinpointSMSVoice service
-
mypy-boto3-snow-device-management for SnowDeviceManagement service
-
mypy-boto3-snowball for Snowball service
-
mypy-boto3-sns for SNS service
-
mypy-boto3-sqs for SQS service
-
mypy-boto3-ssm for SSM service
-
mypy-boto3-ssm-contacts for SSMContacts service
-
mypy-boto3-ssm-incidents for SSMIncidents service
-
mypy-boto3-ssm-sap for SsmSap service
-
mypy-boto3-sso for SSO service
-
mypy-boto3-sso-admin for SSOAdmin service
-
mypy-boto3-sso-oidc for SSOOIDC service
-
mypy-boto3-stepfunctions for SFN service
-
mypy-boto3-storagegateway for StorageGateway service
-
mypy-boto3-sts for STS service
-
mypy-boto3-support for Support service
-
mypy-boto3-support-app for SupportApp service
-
mypy-boto3-swf for SWF service
-
mypy-boto3-synthetics for Synthetics service
-
mypy-boto3-textract for Textract service
-
mypy-boto3-timestream-query for TimestreamQuery service
-
mypy-boto3-timestream-write for TimestreamWrite service
-
mypy-boto3-tnb for TelcoNetworkBuilder service
-
mypy-boto3-transcribe for TranscribeService service
-
mypy-boto3-transfer for Transfer service
-
mypy-boto3-translate for Translate service
-
mypy-boto3-trustedadvisor for TrustedAdvisorPublicAPI service
-
mypy-boto3-verifiedpermissions for VerifiedPermissions service
-
mypy-boto3-voice-id for VoiceID service
-
mypy-boto3-vpc-lattice for VPCLattice service
-
mypy-boto3-waf for WAF service
-
mypy-boto3-waf-regional for WAFRegional service
-
mypy-boto3-wafv2 for WAFV2 service
-
mypy-boto3-wellarchitected for WellArchitected service
-
mypy-boto3-wisdom for ConnectWisdomService service
-
mypy-boto3-workdocs for WorkDocs service
-
mypy-boto3-worklink for WorkLink service
-
mypy-boto3-workmail for WorkMail service
-
mypy-boto3-workmailmessageflow for WorkMailMessageFlow service
-
mypy-boto3-workspaces for WorkSpaces service
-
mypy-boto3-workspaces-thin-client for WorkSpacesThinClient service
-
mypy-boto3-workspaces-web for WorkSpacesWeb service
-
mypy-boto3-xray for XRay service