CodePipeline / Client / list_rule_types

list_rule_types

CodePipeline.Client.list_rule_types(**kwargs)

Lists the rules for the condition.

See also: AWS API Documentation

Request Syntax

response = client.list_rule_types(
    ruleOwnerFilter='AWS',
    regionFilter='string'
)

Parameters:

• ruleOwnerFilter (string) – The rule owner to filter on.

• regionFilter (string) – The rule Region to filter on.

Return type:

dict

Returns:

Response Syntax

{
    'ruleTypes': [
        {
            'id': {
                'category': 'Rule',
                'owner': 'AWS',
                'provider': 'string',
                'version': 'string'
            },
            'settings': {
                'thirdPartyConfigurationUrl': 'string',
                'entityUrlTemplate': 'string',
                'executionUrlTemplate': 'string',
                'revisionUrlTemplate': 'string'
            },
            'ruleConfigurationProperties': [
                {
                    'name': 'string',
                    'required': True|False,
                    'key': True|False,
                    'secret': True|False,
                    'queryable': True|False,
                    'description': 'string',
                    'type': 'String'|'Number'|'Boolean'
                },
            ],
            'inputArtifactDetails': {
                'minimumCount': 123,
                'maximumCount': 123
            }
        },
    ]
}

Response Structure

• (dict) –

  • ruleTypes (list) –

    Lists the rules that are configured for the condition.

    • (dict) –

      The rule type, which is made up of the combined values for category, owner, provider, and version.

      • id (dict) –

        Represents information about a rule type.

        • category (string) –

          A category defines what kind of rule can be run in the stage, and constrains the provider type for the rule. The valid category is Rule.

        • owner (string) –

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

        • provider (string) –

          The rule provider, such as the DeploymentWindow rule.

        • version (string) –

          A string that describes the rule version.

      • settings (dict) –

        Returns information about the settings for a rule type.

        • thirdPartyConfigurationUrl (string) –

          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.

        • entityUrlTemplate (string) –

          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.

        • executionUrlTemplate (string) –

          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.

        • revisionUrlTemplate (string) –

          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.

      • ruleConfigurationProperties (list) –

        The configuration properties for the rule type.

        • (dict) –

          Represents information about a rule configuration property.

          • name (string) –

            The name of the rule configuration property.

          • required (boolean) –

            Whether the configuration property is a required value.

          • key (boolean) –

            Whether the configuration property is a key.

          • secret (boolean) –

            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.

          • queryable (boolean) –

            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.

          • description (string) –

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

          • type (string) –

            The type of the configuration property.

      • inputArtifactDetails (dict) –

        Returns information about the details of an artifact.

        • minimumCount (integer) –

          The minimum number of artifacts allowed for the action type.

        • maximumCount (integer) –

          The maximum number of artifacts allowed for the action type.

Exceptions

• CodePipeline.Client.exceptions.ValidationException

• CodePipeline.Client.exceptions.InvalidNextTokenException