Skip to content
AWS for Query.Farm

aws.cognito_idp.describe_user_import_job

Example SQL Queries

SELECT * FROM
aws.cognito_idp.describe_user_import_job
WHERE
"user_pool_id" = 'VALUE'
AND "job_id" = 'VALUE';

Description

Describes the user import job.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

The job ID for the user import job.

VARCHAR
user_pool_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
user_import_job

The job object that represents the user import job.

STRUCT(
    "job_name" VARCHAR,
    "job_id" VARCHAR,
    "user_pool_id" VARCHAR,
    "pre_signed_url" VARCHAR,
    "creation_date" TIMESTAMP_S,
    "start_date" TIMESTAMP_S,
    "completion_date" TIMESTAMP_S,
    "status" VARCHAR,
    "cloud_watch_logs_role_arn" VARCHAR,
    "imported_users" BIGINT,
    "skipped_users" BIGINT,
    "failed_users" BIGINT,
    "completion_message" VARCHAR
)
Show child fields
user_import_job.cloud_watch_logs_role_arn

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

user_import_job.completion_date

The date when the user import job was completed.

user_import_job.completion_message

The message returned when the user import job is completed.

user_import_job.creation_date

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

user_import_job.failed_users

The number of users that couldn't be imported.

user_import_job.imported_users

The number of users that were successfully imported.

user_import_job.job_id

The job ID for the user import job.

user_import_job.job_name

The job name for the user import job.

user_import_job.pre_signed_url

The pre-signed URL to be used to upload the .csv file.

user_import_job.skipped_users

The number of users that were skipped.

user_import_job.start_date

The date when the user import job was started.

user_import_job.status

The status of the user import job. One of the following:

  • Created - The job was created but not started.

  • Pending - A transition state. You have started the job, but it has not begun importing users yet.

  • InProgress - The job has started, and users are being imported.

  • Stopping - You have stopped the job, but the job has not stopped importing users yet.

  • Stopped - You have stopped the job, and the job has stopped importing users.

  • Succeeded - The job has completed successfully.

  • Failed - The job has stopped due to an error.

  • Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

user_import_job.user_pool_id

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