Class: Aws::CognitoIdentityProvider::Types::UpdateTermsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UpdateTermsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enforcement ⇒ String

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

• #links ⇒ Hash<String,String>

  A map of URLs to languages.

• #terms_id ⇒ String

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

• #terms_name ⇒ String

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

• #terms_source ⇒ String

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

• #user_pool_id ⇒ String

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

Instance Attribute Details

#enforcement ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11718

class UpdateTermsRequest < Struct.new(
  :terms_id,
  :user_pool_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = []
  include Aws::Structure
end

#links ⇒ Hash<String,String>

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”: “terms.example.com”, “cognito:spanish”: “terms.example.com/es”`.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11718

class UpdateTermsRequest < Struct.new(
  :terms_id,
  :user_pool_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = []
  include Aws::Structure
end

#terms_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11718

class UpdateTermsRequest < Struct.new(
  :terms_id,
  :user_pool_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = []
  include Aws::Structure
end

#terms_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11718

class UpdateTermsRequest < Struct.new(
  :terms_id,
  :user_pool_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = []
  include Aws::Structure
end

#terms_source ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11718

class UpdateTermsRequest < Struct.new(
  :terms_id,
  :user_pool_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11718

class UpdateTermsRequest < Struct.new(
  :terms_id,
  :user_pool_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = []
  include Aws::Structure
end