ReadAPIKeyConnectionMetadata - Amazon Quick Sight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ReadAPIKeyConnectionMetadata

Read-only authentication metadata for API key-based connections, containing non-sensitive configuration details.

Contents

Note

In the following list, the required parameters are described first.

BaseEndpoint

The base endpoint URL for API key authentication.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: https://.*

Required: Yes

Email

The email address associated with the API key authentication.

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: