UpdateTermsRequest ¶

class UpdateTermsRequest(TypedDict, closed=True):
    terms_id: "capo_cognito_identity_provider.types.terms_id_type.TermsIdType"
    """<p>The ID of the terms document that you want to update.</p>"""
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool that contains the terms that you want to update.</p>"""
    terms_name: NotRequired[
        "capo_cognito_identity_provider.types.terms_name_type.TermsNameType"
    ]
    """<p>The new name that you want to apply to the requested terms documents.</p>"""
    terms_source: NotRequired[
        "capo_cognito_identity_provider.types.terms_source_type.TermsSourceType"
    ]
    """<p>This parameter is reserved for future use and currently accepts only one value.</p>"""
    enforcement: NotRequired[
        "capo_cognito_identity_provider.types.terms_enforcement_type.TermsEnforcementType"
    ]
    """<p>This parameter is reserved for future use and currently accepts only one value.</p>"""
    links: NotRequired["capo_cognito_identity_provider.types.links_type.LinksType"]
    """<p>A map of URLs to languages. For each localized language that will view the requested <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code> displays for all languages that don't have a language-specific URL.</p> <p>For example, <code>"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es"</code>.</p>"""