APIKeyConnectionMetadata
Configuration for API key-based authentication to external services.
Contents
Note
In the following list, the required parameters are described first.
- ApiKey
-
The API key used for authentication.
Type: String
Required: Yes
- BaseEndpoint
-
The base URL endpoint for the external service.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Pattern:
https://.*Required: Yes
-
The email address associated with the API key, if required.
Type: String
Pattern:
[\w.%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: