Amazon Q Business - Common Parameters

Amazon Q Business consists of a list of parameters used for signing Signature Version 4 requests are commonly referred to as "credentials" or "authentication parameters". Any action-specific parameters are listed in the chapter for that action.

Common Parameters

The following is the list of Parameters used in Amazon Q Business

• Action:
• The action to be performed.
• Type: string
• Required: Yes
• Version:
• The API version that the request is written for, expressed in the format YYYY-MM-DD.
• Type: string
• Required: Yes
• X-Amz-Algorithm:
• The hash algorithm that you used to create the request signature.
• Condition: Use this parameter when passing authentication info in the query string, not in the HTTP header.
• Type: string
• Valid Values: AWS4-HMAC-SHA256
• Required: Conditional
• X-Amz-Credential:
• Credential scope: a string with your access key, date, region, service, and 'aws4_request'.
• Condition: Use this parameter when passing authentication info in the query string, not in the HTTP header.
• Type: string
• Required: Conditional
• X-Amz-Date:
• Signature date: in ISO 8601 format (YYYYMMDDTHHMMSSZ), e.g. 20120325T120000Z.
• Condition: X-Amz-Date is optional, but overrides the Date header if used. It's not needed if the Date header is in ISO 8601 format.
• Type: string
• Required: Conditional
• X-Amz-Security-Token:
• The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS)
• Condition: If you're using temporary security credentials from AWS STS, you must include the security token.
• Type: string
• Required: Conditional
• X-Amz-Signature:
• Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.
• Condition: Use this when you put authentication info in the URL query string, not in the HTTP header.
• Type: string
• Required: Conditional
• X-Amz-SignedHeaders:
• Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers
• Condition: Use this when you put authentication info in the URL query string, not in the HTTP header.
• Type: string
• Required: Conditional