Class: Aws::PinpointSMSVoiceV2::Types::DescribeRegistrationFieldDefinitionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::DescribeRegistrationFieldDefinitionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #field_paths ⇒ Array<String>

  An array of paths to the registration form field.

• #max_results ⇒ Integer

  The maximum number of results to return per each request.

• #next_token ⇒ String

  The token to be used for the next set of paginated results.

• #registration_type ⇒ String

  The type of registration form.

• #section_path ⇒ String

  The path to the section of the registration.

Instance Attribute Details

#field_paths ⇒ Array<String>

An array of paths to the registration form field.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2460

class DescribeRegistrationFieldDefinitionsRequest < Struct.new(
  :registration_type,
  :section_path,
  :field_paths,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per each request.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2460

class DescribeRegistrationFieldDefinitionsRequest < Struct.new(
  :registration_type,
  :section_path,
  :field_paths,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2460

class DescribeRegistrationFieldDefinitionsRequest < Struct.new(
  :registration_type,
  :section_path,
  :field_paths,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#registration_type ⇒ String

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2460

class DescribeRegistrationFieldDefinitionsRequest < Struct.new(
  :registration_type,
  :section_path,
  :field_paths,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#section_path ⇒ String

The path to the section of the registration.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 2460

class DescribeRegistrationFieldDefinitionsRequest < Struct.new(
  :registration_type,
  :section_path,
  :field_paths,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end