Examples#
Auto-generated documentation for Bedrock type annotations stubs module types-boto3-bedrock.
Client#
Implicit type annotations#
Can be used with types-boto3[bedrock] package installed.
Write your Bedrock code as usual,
type checking and code completion should work out of the box.
Client method usage example#
# BedrockClient usage example
from boto3.session import Session
session = Session()
client = session.client("bedrock") # (1)
result = client.batch_delete_advanced_prompt_optimization_job() # (2)
- client: BedrockClient
- result: BatchDeleteAdvancedPromptOptimizationJobResponseTypeDef
Paginator usage example#
# ListAdvancedPromptOptimizationJobsPaginator usage example
from boto3.session import Session
session = Session()
client = session.client("bedrock") # (1)
paginator = client.get_paginator("list_advanced_prompt_optimization_jobs") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: BedrockClient
- paginator: ListAdvancedPromptOptimizationJobsPaginator
- item: ListAdvancedPromptOptimizationJobsResponseTypeDef
Explicit type annotations#
With types-boto3-lite[bedrock]
or a standalone types_boto3_bedrock package, you have to explicitly specify client: BedrockClient type annotation.
All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.
Client method usage example#
# BedrockClient usage example with type annotations
from boto3.session import Session
from types_boto3_bedrock.client import BedrockClient
from types_boto3_bedrock.type_defs import BatchDeleteAdvancedPromptOptimizationJobResponseTypeDef
from types_boto3_bedrock.type_defs import BatchDeleteAdvancedPromptOptimizationJobRequestTypeDef
session = Session()
client: BedrockClient = session.client("bedrock")
kwargs: BatchDeleteAdvancedPromptOptimizationJobRequestTypeDef = {...}
result: BatchDeleteAdvancedPromptOptimizationJobResponseTypeDef = client.batch_delete_advanced_prompt_optimization_job(**kwargs)
Paginator usage example#
# ListAdvancedPromptOptimizationJobsPaginator usage example with type annotations
from boto3.session import Session
from types_boto3_bedrock.client import BedrockClient
from types_boto3_bedrock.paginator import ListAdvancedPromptOptimizationJobsPaginator
from types_boto3_bedrock.type_defs import ListAdvancedPromptOptimizationJobsResponseTypeDef
session = Session()
client: BedrockClient = session.client("bedrock")
paginator: ListAdvancedPromptOptimizationJobsPaginator = client.get_paginator("list_advanced_prompt_optimization_jobs")
for item in paginator.paginate(...):
item: ListAdvancedPromptOptimizationJobsResponseTypeDef
print(item)