DocumentParameter ¶

class DocumentParameter(TypedDict, closed=True):
    name: NotRequired["capo_ssm.types.document_parameter_name.DocumentParameterName"]
    """<p>The name of the parameter.</p>"""
    type: NotRequired["capo_ssm.types.document_parameter_type.DocumentParameterType"]
    """<p>The type of parameter. The type can be either String or StringList.</p>"""
    description: NotRequired[
        "capo_ssm.types.document_parameter_descrption.DocumentParameterDescrption"
    ]
    """<p>A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.</p>"""
    default_value: NotRequired[
        "capo_ssm.types.document_parameter_default_value.DocumentParameterDefaultValue"
    ]
    """<p>If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.</p>"""