You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::SignUpRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass SignUpRequest data as a hash:

{
  client_id: "ClientIdType", # required
  secret_hash: "SecretHashType",
  username: "UsernameType", # required
  password: "PasswordType", # required
  user_attributes: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  validation_data: [
    {
      name: "AttributeNameType", # required
      value: "AttributeValueType",
    },
  ],
  analytics_metadata: {
    analytics_endpoint_id: "StringType",
  },
  user_context_data: {
    encoded_data: "StringType",
  },
}

Represents the request to register a user.

Instance Attribute Summary collapse

Instance Attribute Details

#analytics_metadataTypes::AnalyticsMetadataType

The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.



6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)


6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#passwordString

The password of the user you wish to register.

Returns:

  • (String)


6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#secret_hashString

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Returns:

  • (String)


6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#user_attributesArray<Types::AttributeType>

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:



6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#user_context_dataTypes::UserContextDataType

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.



6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#usernameString

The user name of the user you wish to register.

Returns:

  • (String)


6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end

#validation_dataArray<Types::AttributeType>

The validation data in the request to register a user.

Returns:



6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6729

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data)
  include Aws::Structure
end