Skip to content
AWS for Query.Farm

aws.mediapackage.describe_harvest_job

Example SQL Queries

SELECT * FROM
aws.mediapackage.describe_harvest_job
WHERE
"id" = 'VALUE';

Description

Gets details about an existing HarvestJob.

Table Definition

Column NameColumn Data Type
id Required Input Column

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted. 

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
arn

The Amazon Resource Name (ARN) assigned to the HarvestJob. 

VARCHAR
channel_id

The ID of the Channel that the HarvestJob will harvest from. 

VARCHAR
created_at

The date and time the HarvestJob was submitted. 

VARCHAR
end_time

The end of the time-window which will be harvested. 

VARCHAR
origin_endpoint_id

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted. 

VARCHAR
s3_destination

Configuration parameters for where in an S3 bucket to place the harvested content 

STRUCT(
    "bucket_name" VARCHAR,
    "manifest_key" VARCHAR,
    "role_arn" VARCHAR
)
Show child fields
s3_destination.bucket_name

The name of an S3 bucket within which harvested content will be exported

s3_destination.manifest_key

The key in the specified S3 bucket where the harvested top-level manifest will be placed.

s3_destination.role_arn

The IAM role used to write to the specified S3 bucket

start_time

The start of the time-window which will be harvested. 

VARCHAR
status

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed. 

VARCHAR