Amazon Q Business - 常用参数

Amazon Q Business 包含用于签署签名版本 4 请求的参数列表,通常称为"凭证"或"身份验证参数"。任何特定于操作的参数都列在该操作的章节中。

通用参数

以下是 Amazon Q Business 中使用的参数列表

  • Action:
    • 要执行的操作。
    • 类型:字符串
    • 必填:是
  • Version:
    • 请求所针对的 API 版本,以 YYYY-MM-DD 格式表示。
    • 类型:字符串
    • 必填:是
  • X-Amz-Algorithm:
    • 您用于创建请求签名的哈希算法。
    • 条件:通过身份验证时使用此参数查询字符串中的信息,而不是 HTTP 标头中的信息。
    • 类型:字符串
    • 有效值:AWS4-HMAC-SHA256
    • 必需:有条件
  • X-Amz-Credential:
    • 凭证范围:包含您的访问密钥、日期、区域、服务和"aws4_request"的字符串。
    • 条件:在查询字符串中传递身份验证信息时使用此参数,而不是在 HTTP 标头中传递。
    • 类型:字符串
    • 必需:有条件
  • X-Amz-Date:
    • 签名日期:采用 ISO 8601 格式 (YYYYMMDDTHHMMSSZ),例如20120325T120000Z。
    • 条件:X-Amz-Date 是可选的,但如果使用,则会覆盖 Date 标头。如果日期标头采用 ISO 8601 格式,则不需要。
    • 类型:字符串
    • 必需:条件
  • X-Amz-Security-Token:
    • 通过调用 AWS 安全令牌服务 (AWS STS) 获取的临时安全令牌
    • 条件:如果您使用来自 AWS STS 的临时安全凭证,则必须包含安全令牌。
    • 类型:字符串
    • 必需:条件
  • X-Amz-Signature:
    • 指定根据要签名的字符串和派生的签名密钥计算出的十六进制编码签名。
    • 条件:当您将身份验证信息放在 URL 查询字符串中而不是 HTTP 中时,请使用此选项标头。
    • 类型:字符串
    • 必需:条件
  • X-Amz-SignedHeaders:
    • 指定作为规范请求的一部分包含的所有 HTTP 标头。有关指定签名标头的更多信息
    • 条件:当您将身份验证信息放在 URL 查询字符串中而不是 HTTP 标头中时,请使用此选项。
    • 类型:字符串
    • 必需:条件