Skip to content
AWS for Query.Farm

aws.codepipeline.get_action_type

Example SQL Queries

SELECT * FROM
aws.codepipeline.get_action_type
WHERE
"category" = 'VALUE'
AND "owner" = 'VALUE'
AND "provider" = 'VALUE'
AND "version" = 'VALUE';

Description

Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.

Table Definition

Column NameColumn Data Type
category Required Input Column

Defines what kind of action can be taken in the stage. The following are the valid values:

  • Source

  • Build

  • Test

  • Deploy

  • Approval

  • Invoke 

VARCHAR
owner Required Input Column

The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty.

VARCHAR
provider Required Input Column

The provider of the action type being called. The provider name is specified when the action type is created.

VARCHAR
version Required Input Column

A string that describes the action type version.

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
action_type

The action type information for the requested action type, such as the action type ID.

STRUCT(
    "description" VARCHAR,
    "executor" STRUCT(
        "configuration" STRUCT(
            "lambda_executor_configuration" STRUCT(
                "lambda_function_arn" VARCHAR
            ),
            "job_worker_executor_configuration" STRUCT(
                "polling_accounts" VARCHAR[],
                "polling_service_principals" VARCHAR[]
            )
        ),
        "type" VARCHAR,
        "policy_statements_template" VARCHAR,
        "job_timeout" BIGINT
    ),
    "id" STRUCT(
        "category" VARCHAR,
        "owner" VARCHAR,
        "provider" VARCHAR,
        "version" VARCHAR
    ),
    "input_artifact_details" STRUCT(
        "minimum_count" BIGINT,
        "maximum_count" BIGINT
    ),
    "output_artifact_details" STRUCT(
        "minimum_count" BIGINT,
        "maximum_count" BIGINT
    ),
    "permissions" STRUCT(
        "allowed_accounts" VARCHAR[]
    ),
    "properties" STRUCT(
        "name" VARCHAR,
        "optional" BOOLEAN,
        "key" BOOLEAN,
        "no_echo" BOOLEAN,
        "queryable" BOOLEAN,
        "description" VARCHAR
    )[],
    "urls" STRUCT(
        "configuration_url" VARCHAR,
        "entity_url_template" VARCHAR,
        "execution_url_template" VARCHAR,
        "revision_url_template" VARCHAR
    )
)
Show child fields
action_type.description

The description for the action type to be updated.

action_type.executor

Information about the executor for an action type that was created with any supported integration model.

Show child fields
action_type.executor.configuration

The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.

Show child fields
action_type.executor.configuration.job_worker_executor_configuration

Details about the JobWorker executor of the action type.

Show child fields
action_type.executor.configuration.job_worker_executor_configuration.polling_accounts[]
action_type.executor.configuration.job_worker_executor_configuration.polling_service_principals[]
action_type.executor.configuration.lambda_executor_configuration

Details about the Lambda executor of the action type.

Show child fields
action_type.executor.configuration.lambda_executor_configuration.lambda_function_arn

The ARN of the Lambda function used by the action engine.

action_type.executor.job_timeout

The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.

action_type.executor.policy_statements_template

The policy statement that specifies the permissions in the CodePipeline customer account that are needed to successfully run an action.

To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com.

The size of the passed JSON policy document cannot exceed 2048 characters.

action_type.executor.type

The integration model used to create and update the action type, Lambda or JobWorker.

action_type.id

The action category, owner, provider, and version of the action type to be updated.

Show child fields
action_type.id.category

Defines what kind of action can be taken in the stage, one of the following:

  • Source

  • Build

  • Test

  • Deploy

  • Approval

  • Invoke

action_type.id.owner

The creator of the action type being called: AWS or ThirdParty.

action_type.id.provider

The provider of the action type being called. The provider name is supplied when the action type is created.

action_type.id.version

A string that describes the action type version.

action_type.input_artifact_details

Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.

Show child fields
action_type.input_artifact_details.maximum_count

The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source.

action_type.input_artifact_details.minimum_count

The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source.

action_type.output_artifact_details

Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.

Show child fields
action_type.output_artifact_details.maximum_count

The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source.

action_type.output_artifact_details.minimum_count

The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of source.

action_type.permissions

Details identifying the accounts with permissions to use the action type.

Show child fields
action_type.permissions.allowed_accounts[]
action_type.properties[]
Show child fields
action_type.properties[].description

The description of the property that is displayed to users.

action_type.properties[].key

Whether the configuration property is a key.

action_type.properties[].name

The property name that is displayed to users.

action_type.properties[].no_echo

Whether to omit the field value entered by the customer in the log. If true, the value is not saved in CloudTrail logs for the action execution.

action_type.properties[].optional

Whether the configuration property is an optional value.

action_type.properties[].queryable

Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.

action_type.urls

The links associated with the action type to be updated.

Show child fields
action_type.urls.configuration_url

The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.

action_type.urls.entity_url_template

The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.

action_type.urls.execution_url_template

The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.

action_type.urls.revision_url_template

The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.