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

Class: Aws::CognitoIdentityProvider::Types::DescribeUserImportJobRequest

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

{
  user_pool_id: "UserPoolIdType", # required
  job_id: "UserImportJobIdType", # required
}

Represents the request to describe the user import job.

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

The job ID for the user import job.

Returns:

  • (String)


2542
2543
2544
2545
2546
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2542

class DescribeUserImportJobRequest < Struct.new(
  :user_pool_id,
  :job_id)
  include Aws::Structure
end

#user_pool_idString

The user pool ID for the user pool that the users are being imported into.

Returns:

  • (String)


2542
2543
2544
2545
2546
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2542

class DescribeUserImportJobRequest < Struct.new(
  :user_pool_id,
  :job_id)
  include Aws::Structure
end