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

Class: Aws::CognitoIdentityProvider::Types::ListUserImportJobsRequest

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

{
  user_pool_id: "UserPoolIdType", # required
  max_results: 1, # required
  pagination_token: "PaginationKeyType",
}

Represents the request to list the user import jobs.

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

The maximum number of import jobs you want the request to return.

Returns:

  • (Integer)


4650
4651
4652
4653
4654
4655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4650

class ListUserImportJobsRequest < Struct.new(
  :user_pool_id,
  :max_results,
  :pagination_token)
  include Aws::Structure
end

#pagination_tokenString

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

Returns:

  • (String)


4650
4651
4652
4653
4654
4655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4650

class ListUserImportJobsRequest < Struct.new(
  :user_pool_id,
  :max_results,
  :pagination_token)
  include Aws::Structure
end

#user_pool_idString

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

Returns:

  • (String)


4650
4651
4652
4653
4654
4655
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4650

class ListUserImportJobsRequest < Struct.new(
  :user_pool_id,
  :max_results,
  :pagination_token)
  include Aws::Structure
end