Skip to content
AWS for Query.Farm

aws.personalize.describe_batch_segment_job

Example SQL Queries

SELECT * FROM
aws.personalize.describe_batch_segment_job
WHERE
"batch_segment_job_arn" = 'VALUE';

Description

Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

Table Definition

Column NameColumn Data Type
batch_segment_job_arn Required Input Column

The ARN of the batch segment job to describe.

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
batch_segment_job

Information on the specified batch segment job.

STRUCT(
    "job_name" VARCHAR,
    "batch_segment_job_arn" VARCHAR,
    "filter_arn" VARCHAR,
    "failure_reason" VARCHAR,
    "solution_version_arn" VARCHAR,
    "num_results" BIGINT,
    "job_input" STRUCT(
        "s3_data_source" STRUCT(
            "path" VARCHAR,
            "kms_key_arn" VARCHAR
        )
    ),
    "job_output" STRUCT(
        "s3_data_destination" STRUCT(
            "path" VARCHAR,
            "kms_key_arn" VARCHAR
        )
    ),
    "role_arn" VARCHAR,
    "status" VARCHAR,
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S
)
Show child fields
batch_segment_job.batch_segment_job_arn

The Amazon Resource Name (ARN) of the batch segment job.

batch_segment_job.creation_date_time

The time at which the batch segment job was created.

batch_segment_job.failure_reason

If the batch segment job failed, the reason for the failure.

batch_segment_job.filter_arn

The ARN of the filter used on the batch segment job.

batch_segment_job.job_input

The Amazon S3 path that leads to the input data used to generate the batch segment job.

Show child fields
batch_segment_job.job_input.s3_data_source

The configuration details of an Amazon S3 input or output bucket.

Show child fields
batch_segment_job.job_input.s3_data_source.kms_key_arn

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

batch_segment_job.job_input.s3_data_source.path

The file path of the Amazon S3 bucket.

batch_segment_job.job_name

The name of the batch segment job.

batch_segment_job.job_output

The Amazon S3 bucket that contains the output data generated by the batch segment job.

Show child fields
batch_segment_job.job_output.s3_data_destination

The configuration details of an Amazon S3 input or output bucket.

Show child fields
batch_segment_job.job_output.s3_data_destination.kms_key_arn

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

batch_segment_job.job_output.s3_data_destination.path

The file path of the Amazon S3 bucket.

batch_segment_job.last_updated_date_time

The time at which the batch segment job last updated.

batch_segment_job.num_results

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

batch_segment_job.role_arn

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

batch_segment_job.solution_version_arn

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

batch_segment_job.status

The status of the batch segment job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED