Skip to content

Commit dc4665a

Browse files
authored
feat!: change bedrock bearer token env variable to match AWS docs & boto3 convention (#4152)
Rename `AWS_BEDROCK_API_KEY` to `AWS_BEARER_TOKEN_BEDROCK` to align with the naming convention used in AWS Bedrock documentation and the AWS web console UI. This reduces confusion when developers compare LLS docs with AWS docs. Closes #4147
1 parent acf74cb commit dc4665a

File tree

11 files changed

+16
-16
lines changed

11 files changed

+16
-16
lines changed

docs/docs/providers/inference/remote_bedrock.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ AWS Bedrock inference provider using OpenAI compatible endpoint.
2222
## Sample Configuration
2323

2424
```yaml
25-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
25+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
2626
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
2727
```

src/llama_stack/distributions/ci-tests/run-with-postgres-store.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ providers:
4747
- provider_id: bedrock
4848
provider_type: remote::bedrock
4949
config:
50-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
50+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
5151
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
5252
- provider_id: ${env.NVIDIA_API_KEY:+nvidia}
5353
provider_type: remote::nvidia

src/llama_stack/distributions/ci-tests/run.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ providers:
4747
- provider_id: bedrock
4848
provider_type: remote::bedrock
4949
config:
50-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
50+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
5151
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
5252
- provider_id: ${env.NVIDIA_API_KEY:+nvidia}
5353
provider_type: remote::nvidia

src/llama_stack/distributions/starter-gpu/run-with-postgres-store.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ providers:
4747
- provider_id: bedrock
4848
provider_type: remote::bedrock
4949
config:
50-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
50+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
5151
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
5252
- provider_id: ${env.NVIDIA_API_KEY:+nvidia}
5353
provider_type: remote::nvidia

src/llama_stack/distributions/starter-gpu/run.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ providers:
4747
- provider_id: bedrock
4848
provider_type: remote::bedrock
4949
config:
50-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
50+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
5151
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
5252
- provider_id: ${env.NVIDIA_API_KEY:+nvidia}
5353
provider_type: remote::nvidia

src/llama_stack/distributions/starter/run-with-postgres-store.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ providers:
4747
- provider_id: bedrock
4848
provider_type: remote::bedrock
4949
config:
50-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
50+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
5151
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
5252
- provider_id: ${env.NVIDIA_API_KEY:+nvidia}
5353
provider_type: remote::nvidia

src/llama_stack/distributions/starter/run.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ providers:
4747
- provider_id: bedrock
4848
provider_type: remote::bedrock
4949
config:
50-
api_key: ${env.AWS_BEDROCK_API_KEY:=}
50+
api_key: ${env.AWS_BEARER_TOKEN_BEDROCK:=}
5151
region_name: ${env.AWS_DEFAULT_REGION:=us-east-2}
5252
- provider_id: ${env.NVIDIA_API_KEY:+nvidia}
5353
provider_type: remote::nvidia

src/llama_stack/providers/remote/inference/bedrock/bedrock.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class BedrockInferenceAdapter(OpenAIMixin):
3737
"""
3838

3939
config: BedrockConfig
40-
provider_data_api_key_field: str = "aws_bedrock_api_key"
40+
provider_data_api_key_field: str = "aws_bearer_token_bedrock"
4141

4242
def get_base_url(self) -> str:
4343
"""Get base URL for OpenAI client."""
@@ -111,7 +111,7 @@ async def openai_chat_completion(
111111
logger.error(f"AWS Bedrock authentication token expired: {error_msg}")
112112
raise ValueError(
113113
"AWS Bedrock authentication failed: Bearer token has expired. "
114-
"The AWS_BEDROCK_API_KEY environment variable contains an expired pre-signed URL. "
114+
"The AWS_BEARER_TOKEN_BEDROCK environment variable contains an expired pre-signed URL. "
115115
"Please refresh your token by generating a new pre-signed URL with AWS credentials. "
116116
"Refer to AWS Bedrock documentation for details on OpenAI-compatible endpoints."
117117
) from e

src/llama_stack/providers/remote/inference/bedrock/config.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212

1313

1414
class BedrockProviderDataValidator(BaseModel):
15-
aws_bedrock_api_key: str | None = Field(
15+
aws_bearer_token_bedrock: str | None = Field(
1616
default=None,
17-
description="API key for Amazon Bedrock",
17+
description="API Key (Bearer token) for Amazon Bedrock",
1818
)
1919

2020

@@ -27,6 +27,6 @@ class BedrockConfig(RemoteInferenceProviderConfig):
2727
@classmethod
2828
def sample_run_config(cls, **kwargs):
2929
return {
30-
"api_key": "${env.AWS_BEDROCK_API_KEY:=}",
30+
"api_key": "${env.AWS_BEARER_TOKEN_BEDROCK:=}",
3131
"region_name": "${env.AWS_DEFAULT_REGION:=us-east-2}",
3232
}

tests/unit/providers/inference/test_bedrock_adapter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ def test_api_key_from_header_overrides_config():
4040
"""Test API key from request header overrides config via client property"""
4141
config = BedrockConfig(api_key="config-key", region_name="us-east-1")
4242
adapter = BedrockInferenceAdapter(config=config)
43-
adapter.provider_data_api_key_field = "aws_bedrock_api_key"
44-
adapter.get_request_provider_data = MagicMock(return_value=SimpleNamespace(aws_bedrock_api_key="header-key"))
43+
adapter.provider_data_api_key_field = "aws_bearer_token_bedrock"
44+
adapter.get_request_provider_data = MagicMock(return_value=SimpleNamespace(aws_bearer_token_bedrock="header-key"))
4545

4646
# The client property is where header override happens (in OpenAIMixin)
4747
assert adapter.client.api_key == "header-key"

0 commit comments

Comments
 (0)