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",
  },
  client_metadata: {
    "StringType" => "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.



7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

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

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)


7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

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

#client_metadataHash<String,String>

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Returns:

  • (Hash<String,String>)


7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

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

#passwordString

The password of the user you wish to register.

Returns:

  • (String)


7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  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)


7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  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:



7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

class SignUpRequest < Struct.new(
  :client_id,
  :secret_hash,
  :username,
  :password,
  :user_attributes,
  :validation_data,
  :analytics_metadata,
  :user_context_data,
  :client_metadata)
  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.



7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

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

#usernameString

The user name of the user you wish to register.

Returns:

  • (String)


7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

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

#validation_dataArray<Types::AttributeType>

The validation data in the request to register a user.

Returns:



7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7763

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