Skip to content
AWS for Query.Farm

aws.codepipeline.get_job_details

Example SQL Queries

SELECT * FROM
aws.codepipeline.get_job_details
WHERE
"job_id" = 'VALUE';

Description

Returns information about a job. Used for custom actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

The unique system-generated ID for the job.

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
job_details

The details of the job.

If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

STRUCT(
    "id" VARCHAR,
    "data" STRUCT(
        "action_type_id" STRUCT(
            "category" VARCHAR,
            "owner" VARCHAR,
            "provider" VARCHAR,
            "version" VARCHAR
        ),
        "action_configuration" STRUCT(
            "configuration" MAP(VARCHAR, VARCHAR)
        ),
        "pipeline_context" STRUCT(
            "pipeline_name" VARCHAR,
            "stage" STRUCT(
                "name" VARCHAR
            ),
            "action" STRUCT(
                "name" VARCHAR,
                "action_execution_id" VARCHAR
            ),
            "pipeline_arn" VARCHAR,
            "pipeline_execution_id" VARCHAR
        ),
        "input_artifacts" STRUCT(
            "name" VARCHAR,
            "revision" VARCHAR,
            "location" STRUCT(
                "type" VARCHAR,
                "s3_location" STRUCT(
                    "bucket_name" VARCHAR,
                    "object_key" VARCHAR
                )
            )
        )[],
        "output_artifacts" STRUCT(
            "name" VARCHAR,
            "revision" VARCHAR,
            "location" STRUCT(
                "type" VARCHAR,
                "s3_location" STRUCT(
                    "bucket_name" VARCHAR,
                    "object_key" VARCHAR
                )
            )
        )[],
        "artifact_credentials" STRUCT(
            "access_key_id" VARCHAR,
            "secret_access_key" VARCHAR,
            "session_token" VARCHAR
        ),
        "continuation_token" VARCHAR,
        "encryption_key" STRUCT(
            "id" VARCHAR,
            "type" VARCHAR
        )
    ),
    "account_id" VARCHAR
)
Show child fields
job_details.account_id

The Amazon Web Services account ID associated with the job.

job_details.data

Represents other information about a job required for a job worker to complete the job.

Show child fields
job_details.data.action_configuration

Represents information about an action configuration.

Show child fields
job_details.data.action_configuration.configuration

The configuration data for the action.

job_details.data.action_type_id

Represents information about an action type.

Show child fields
job_details.data.action_type_id.category

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.

  • Source

  • Build

  • Test

  • Deploy

  • Invoke

  • Approval

job_details.data.action_type_id.owner

The creator of the action being called. There are three valid values for the Owner field in the action category section within your pipeline structure: AWS, ThirdParty, and Custom. For more information, see Valid Action Types and Providers in CodePipeline.

job_details.data.action_type_id.provider

The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

job_details.data.action_type_id.version

A string that describes the action version.

job_details.data.artifact_credentials

Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.

Show child fields
job_details.data.artifact_credentials.access_key_id

The access key for the session.

job_details.data.artifact_credentials.secret_access_key

The secret access key for the session.

job_details.data.artifact_credentials.session_token

The token for the session.

job_details.data.continuation_token

A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.

job_details.data.encryption_key

Represents information about the key used to encrypt data in the artifact store, such as an KMS key.

Show child fields
job_details.data.encryption_key.id

The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

job_details.data.encryption_key.type

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

job_details.data.input_artifacts[]
Show child fields
job_details.data.input_artifacts[].location

The location of an artifact.

Show child fields
job_details.data.input_artifacts[].location.s3_location

The S3 bucket that contains the artifact.

Show child fields
job_details.data.input_artifacts[].location.s3_location.bucket_name

The name of the S3 bucket.

job_details.data.input_artifacts[].location.s3_location.object_key

The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.

job_details.data.input_artifacts[].location.type

The type of artifact in the location.

job_details.data.input_artifacts[].name

The artifact's name.

job_details.data.input_artifacts[].revision

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

job_details.data.output_artifacts[]
Show child fields
job_details.data.output_artifacts[].location

The location of an artifact.

Show child fields
job_details.data.output_artifacts[].location.s3_location

The S3 bucket that contains the artifact.

Show child fields
job_details.data.output_artifacts[].location.s3_location.bucket_name

The name of the S3 bucket.

job_details.data.output_artifacts[].location.s3_location.object_key

The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.

job_details.data.output_artifacts[].location.type

The type of artifact in the location.

job_details.data.output_artifacts[].name

The artifact's name.

job_details.data.output_artifacts[].revision

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

job_details.data.pipeline_context

Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.

Show child fields
job_details.data.pipeline_context.action

The context of an action to a job worker in the stage of a pipeline.

Show child fields
job_details.data.pipeline_context.action.action_execution_id

The system-generated unique ID that corresponds to an action's execution.

job_details.data.pipeline_context.action.name

The name of the action in the context of a job.

job_details.data.pipeline_context.pipeline_arn

The Amazon Resource Name (ARN) of the pipeline.

job_details.data.pipeline_context.pipeline_execution_id

The execution ID of the pipeline.

job_details.data.pipeline_context.pipeline_name

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

job_details.data.pipeline_context.stage

The stage of the pipeline.

Show child fields
job_details.data.pipeline_context.stage.name

The name of the stage.

job_details.id

The unique system-generated ID of the job.