Amazon Bedrock API Reference Sheet

• Amazon Bedrock API Reference is the master specification for the Amazon Bedrock service. It encompasses protocols, authentication methods, endpoints, common parameters, and error-handling standards used across the entire Bedrock ecosystem (both the Control Plane and the Data Plane).

Amazon Bedrock API Reference Common Parameters

• Action: (String) Specifies the particular API action to be performed.
• Version: (String) Indicates the API version used for the request, formatted as YYYY-MM-DD.

• X-Amz-Algorithm: (String) The hash algorithm used to sign the request (e.g., AWS4-HMAC-SHA256). Required when authenticating via query string.
• X-Amz-Credential: (String) The credential scope string containing the access key, date, region, and service. Required when authenticating via query string.
• X-Amz-Date: (String) The timestamp used to create the signature, in ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). If present, this overrides the standard Date header.
• X-Amz-Security-Token: (String) The temporary session token obtained from AWS STS. Required only when using temporary security credentials.
• X-Amz-Signature: (String) The hex-encoded signature calculated from the request details and signing key. Required when authenticating via query string.
• X-Amz-SignedHeaders: (String) A list of all HTTP headers included in the canonical request signature calculation. Required when authenticating via query string.

Amazon Bedrock API Reference Common Errors

API Endpoint Structure

Amazon Bedrock API endpoints use a regional naming convention, ensuring model and resource operations are routed to the appropriate AWS Region.

• Format:
  • bedrock-runtime.{region}.amazonaws.com
  • Example (US East 1): https://bedrock-runtime.us-east-1.amazonaws.com
• Private Access:
  • You can access these APIs privately from your VPC by using AWS PrivateLink (Interface VPC Endpoints), which avoids traversing the public internet and enhances security and compliance.

Best Practices

• Use SDKs:
  • Always use AWS SDKs (such as Boto3, AWS SDK for JavaScript, or AWS SDK for Java) instead of direct HTTP calls. SDKs handle SigV4 signing, retries, error parsing, and other operational details automatically.
• Handle Throttling:
  • Implement a retry logic with exponential backoff in your application  to handle ThrottlingException and similar errors gracefully, especially during periods of high load.
• Check Quotas:
  • Before launching production workloads, verify your Amazon Bedrock service quotas (Provisioned Throughput or On-Demand) to ensure your application can handle expected traffic and avoid service interruptions.

References:

https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html

https://docs.aws.amazon.com/bedrock/latest/APIReference/CommonParameters.html

https://docs.aws.amazon.com/bedrock/latest/APIReference/CommonErrors.html