AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateTerms operation. Modifies existing terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client.

You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language.

Each request accepts one type of terms document and a map of language-to-link for that document type. You must provide both types of terms documents in at least one language before Amazon Cognito displays your terms documents. Supply each type in separate requests.

For more information, see Terms documents.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.UpdateTermsRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class UpdateTermsRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The UpdateTermsRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateTermsRequest()

Properties

NameTypeDescription
Public Property Enforcement Amazon.CognitoIdentityProvider.TermsEnforcementType

Gets and sets the property Enforcement.

This parameter is reserved for future use and currently accepts only one value.

Public Property Links System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Links.

A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.

For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property TermsId System.String

Gets and sets the property TermsId.

The ID of the terms document that you want to update.

Public Property TermsName System.String

Gets and sets the property TermsName.

The new name that you want to apply to the requested terms documents.

Public Property TermsSource Amazon.CognitoIdentityProvider.TermsSourceType

Gets and sets the property TermsSource.

This parameter is reserved for future use and currently accepts only one value.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The ID of the user pool that contains the terms that you want to update.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer