SourceConfiguration
Configuration that defines how to make requests to endpoints, including request methods, paths, parameters, and response handling.
Contents
- PaginationConfiguration
-
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
Type: PaginationConfiguration object
Required: No
- RequestMethod
-
The HTTP method to use for requests to this endpoint, such as GET, POST.
Type: String
Valid Values:
GET | POSTRequired: No
- RequestParameters
-
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
Type: Array of ConnectorProperty objects
Required: No
- RequestPath
-
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
/[a-zA-Z0-9._~:/?#\[\]@!$&'()*+,;={}-]*Required: No
- ResponseConfiguration
-
Configuration that defines how to parse and extract data from API responses, including success and error handling.
Type: ResponseConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
