StringParameterDeclaration - Amazon QuickSight
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).

StringParameterDeclaration

A parameter declaration for the String data type.

Contents

Note

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

Name

The name of the parameter that is being declared.

Type: String

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

Pattern: ^[a-zA-Z0-9]+$

Required: Yes

ParameterValueType

The value type determines whether the parameter is a single-value or multi-value parameter.

Type: String

Valid Values: MULTI_VALUED | SINGLE_VALUED

Required: Yes

DefaultValues

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

Type: StringDefaultValues object

Required: No

MappedDataSetParameters

A list of dataset parameters that are mapped to an analysis parameter.

Type: Array of MappedDataSetParameter objects

Array Members: Minimum number of 0 items. Maximum number of 150 items.

Required: No

ValueWhenUnset

The configuration that defines the default value of a String parameter when a value has not been set.

Type: StringValueWhenUnsetConfiguration object

Required: No

See Also

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