Class: Aws::CognitoIdentityProvider::Types::ContextDataType

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 ContextDataType data as a hash:

{
  ip_address: "StringType", # required
  server_name: "StringType", # required
  server_path: "StringType", # required
  http_headers: [ # required
    {
      header_name: "StringType",
      header_value: "StringType",
    },
  ],
  encoded_data: "StringType",
}

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encoded_data ⇒ String

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

Returns:

  • (String) 


3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3045

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#http_headers ⇒ Array<Types::HttpHeader>

HttpHeaders received on your server in same order.

Returns:



3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3045

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#ip_address ⇒ String

The source IP address of your user's device.

Returns:

  • (String) 


3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3045

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#server_name ⇒ String

Your server endpoint where this API is invoked.

Returns:

  • (String) 


3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3045

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end

#server_path ⇒ String

Your server path where this API is invoked.

Returns:

  • (String) 


3045
3046
3047
3048
3049
3050
3051
3052
3053
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3045

class ContextDataType < Struct.new(
  :ip_address,
  :server_name,
  :server_path,
  :http_headers,
  :encoded_data)
  SENSITIVE = []
  include Aws::Structure
end