Skip to content

RuleExecutionInput

Source code in docs_src/capo_codepipeline/types/rule_execution_input.py
class RuleExecutionInput(TypedDict, closed=True):
    rule_type_id: NotRequired["capo_codepipeline.types.rule_type_id.RuleTypeId"]
    """<p>The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>. For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>"""
    configuration: NotRequired[
        "capo_codepipeline.types.rule_configuration_map.RuleConfigurationMap"
    ]
    """<p>Configuration data for a rule execution, such as the resolved values for that run.</p>"""
    resolved_configuration: NotRequired[
        "capo_codepipeline.types.resolved_rule_configuration_map.ResolvedRuleConfigurationMap"
    ]
    """<p>Configuration data for a rule execution with all variable references replaced with their real values for the execution.</p>"""
    role_arn: NotRequired["capo_codepipeline.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.</p>"""
    region: NotRequired["capo_codepipeline.types.aws_region_name.AWSRegionName"]
    """<p>The Amazon Web Services Region for the rule, such as us-east-1.</p>"""
    input_artifacts: NotRequired[
        "capo_codepipeline.types.artifact_detail_list.ArtifactDetailList"
    ]
    """<p>Details of input artifacts of the rule that correspond to the rule execution.</p>"""

configuration instance-attribute

configuration: NotRequired[RuleConfigurationMap]

Configuration data for a rule execution, such as the resolved values for that run.

input_artifacts instance-attribute

input_artifacts: NotRequired[ArtifactDetailList]

Details of input artifacts of the rule that correspond to the rule execution.

region instance-attribute

region: NotRequired[AWSRegionName]

The Amazon Web Services Region for the rule, such as us-east-1.

resolved_configuration instance-attribute

resolved_configuration: NotRequired[ResolvedRuleConfigurationMap]

Configuration data for a rule execution with all variable references replaced with their real values for the execution.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.

rule_type_id instance-attribute

rule_type_id: NotRequired[RuleTypeId]

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see Stage conditions. For more information about rules, see the CodePipeline rule reference.