Skip to content

StringParameterDeclaration

Source code in docs_src/capo_quicksight/types/string_parameter_declaration.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class StringParameterDeclaration(TypedDict, closed=True):
    parameter_value_type: (
        "capo_quicksight.types.parameter_value_type.ParameterValueType"
    )
    """<p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>"""
    name: "capo_quicksight.types.parameter_name.ParameterName"
    """<p>The name of the parameter that is being declared.</p>"""
    default_values: NotRequired[
        "capo_quicksight.types.string_default_values.StringDefaultValues"
    ]
    """<p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>"""
    value_when_unset: NotRequired[
        "capo_quicksight.types.string_value_when_unset_configuration.StringValueWhenUnsetConfiguration"
    ]
    """<p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>"""
    mapped_data_set_parameters: NotRequired[
        "capo_quicksight.types.mapped_data_set_parameters.MappedDataSetParameters"
    ]

default_values instance-attribute 

default_values: NotRequired[StringDefaultValues]

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

mapped_data_set_parameters instance-attribute 

mapped_data_set_parameters: NotRequired[MappedDataSetParameters]

name instance-attribute 

name: ParameterName

The name of the parameter that is being declared.

parameter_value_type instance-attribute 

parameter_value_type: ParameterValueType

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

value_when_unset instance-attribute 

value_when_unset: NotRequired[StringValueWhenUnsetConfiguration]

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