Skip to content

aws.codepipeline.list_rule_types

Example SQL Queries

SELECT * FROM
aws.codepipeline.list_rule_types;

Description

Lists the rules for the condition.

Table Definition

Column NameColumn Data Type
region_filter Input Column

The rule Region to filter on.

VARCHAR
rule_owner_filter Input Column

The rule owner to filter on.

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
rule_types

Lists the rules that are configured for the condition.

STRUCT(
"id" STRUCT(
"category" VARCHAR,
"owner" VARCHAR,
"provider" VARCHAR,
"version" VARCHAR
),
"settings" STRUCT(
"third_party_configuration_url" VARCHAR,
"entity_url_template" VARCHAR,
"execution_url_template" VARCHAR,
"revision_url_template" VARCHAR
),
"rule_configuration_properties" STRUCT(
"name" VARCHAR,
"required" BOOLEAN,
"key" BOOLEAN,
"secret" BOOLEAN,
"queryable" BOOLEAN,
"description" VARCHAR,
"type" VARCHAR
)[],
"input_artifact_details" STRUCT(
"minimum_count" BIGINT,
"maximum_count" BIGINT
)
)[]
Show child fields
rule_types[]
Show child fields
rule_types[].id

Represents information about a rule type.

Show child fields
rule_types[].id.category

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

  • INVOKE

  • Approval

  • Rule

rule_types[].id.owner

The creator of the rule being called. The valid value for the Owner field in the rule category is AWS.

rule_types[].id.provider

The provider of the service being called by the rule. Valid providers are determined by the rulecategory. For example, a managed rule in the Rule category type has an owner of AWS, which would be specified as AWS.

rule_types[].id.version

A string that describes the rule version.

rule_types[].input_artifact_details

Returns information about the details of an artifact.

Show child fields
rule_types[].input_artifact_details.maximum_count

The maximum number of artifacts allowed for the action type.

rule_types[].input_artifact_details.minimum_count

The minimum number of artifacts allowed for the action type.

rule_types[].rule_configuration_properties[]
Show child fields
rule_types[].rule_configuration_properties[].description

The description of the action configuration property that is displayed to users.

rule_types[].rule_configuration_properties[].key

Whether the configuration property is a key.

rule_types[].rule_configuration_properties[].name

The name of the rule configuration property.

rule_types[].rule_configuration_properties[].queryable

Indicates whether the property can be queried.

If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

rule_types[].rule_configuration_properties[].required

Whether the configuration property is a required value.

rule_types[].rule_configuration_properties[].secret

Whether the configuration property is secret.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

rule_types[].rule_configuration_properties[].type

The type of the configuration property.

rule_types[].settings

Returns information about the settings for a rule type.

Show child fields
rule_types[].settings.entity_url_template

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

rule_types[].settings.execution_url_template

The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.

rule_types[].settings.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.

rule_types[].settings.third_party_configuration_url

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.