ExtractedParameter
Parameter extraction configuration that defines how to extract and map values from API responses to request parameters.
Contents
- DefaultValue
-
The default value to use if the parameter cannot be extracted from the response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*[^<>&'"].*Required: No
- Key
-
The parameter key name that will be used in subsequent requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_-]+Required: No
- PropertyLocation
-
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Type: String
Valid Values:
HEADER | BODY | QUERY_PARAM | PATHRequired: No
- Value
-
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
Type: ResponseExtractionMapping object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: