View a markdown version of this page

CustomPromptInput - 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).

CustomPromptInput

The custom prompt input for an agent. This is a union type that can be either an existing prompt profile or new prompt parameters.

Contents

Note

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

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

ExistingPrompt

An existing custom prompt profile to use for the agent.

Type: CustomPromptProfile object

Required: No

NewPrompt

New custom prompt parameters to configure for the agent.

Type: CustomPromptInputParameters object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: