Smaws_Client_CodePipeline.Typestype nonrec webhook_filter_rule = {match_equals : match_equals option;The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
json_path : json_path;A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
}The event criteria that specify when a webhook notification is sent to your URL.
type nonrec webhook_filters = webhook_filter_rule listtype nonrec webhook_auth_configuration = {secret_token : webhook_auth_configuration_secret_token option;The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.
If a secret token was provided, it will be redacted in the response.
*)allowed_ip_range : webhook_auth_configuration_allowed_ip_range option;The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
}The authentication applied to incoming webhook trigger requests.
type nonrec webhook_definition = {authentication_configuration : webhook_auth_configuration;Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
authentication : webhook_authentication_type;Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.
If a secret token was provided, it will be redacted in the response.
filters : webhook_filters;A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
*)target_action : action_name;The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
*)target_pipeline : pipeline_name;The name of the pipeline you want to connect to the webhook.
*)name : webhook_name;The name of the webhook.
*)}Represents information about a webhook and its definition.
A tag is a key-value pair that is used to manage the resource.
type nonrec tag_list = tag listtype nonrec list_webhook_item = {arn : webhook_arn option;The Amazon Resource Name (ARN) of the webhook.
*)last_triggered : webhook_last_triggered option;The date and time a webhook was last successfully triggered, in timestamp format.
*)error_code : webhook_error_code option;The number code of the error.
*)error_message : webhook_error_message option;The text of the error message about the webhook.
*)url : webhook_url;A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
*)definition : webhook_definition;The detail returned for each webhook, such as the webhook authentication type and filter rules.
*)}The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
type nonrec webhook_list = list_webhook_item listtype nonrec validation_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The validation was specified in an invalid format.
type nonrec encryption_key = {type_ : 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'.
*)id : 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).
*)}Represents information about the key used to encrypt data in the artifact store, such as an Amazon Web Services Key Management Service (Key Management Service) key.
type nonrec artifact_store = {encryption_key : encryption_key option;The encryption key used to encrypt the data in the artifact store, such as an Amazon Web Services Key Management Service key. If this is undefined, the default key for Amazon S3 is used.
*)location : artifact_store_location;The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same Amazon Web Services Region as the pipeline to store your pipeline artifacts.
*)type_ : artifact_store_type;The type of the artifact store, such as S3.
*)}The S3 bucket where artifacts for the pipeline are stored.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
type nonrec artifact_store_map = (aws_region_name * artifact_store) listtype nonrec blocker_declaration = {type_ : blocker_type;Reserved for future use.
*)name : blocker_name;Reserved for future use.
*)}Reserved for future use.
type nonrec stage_blocker_declaration_list = blocker_declaration listtype nonrec action_type_id = {version : version;A string that describes the action version.
*)provider : action_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.
owner : action_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.
category : action_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.
}Represents information about an action type.
type nonrec action_configuration_map =
(action_configuration_key * action_configuration_value) listtype nonrec command_list = command listtype nonrec file_path_list = file_path listtype nonrec output_artifact = {files : file_path_list option;The files that you want to associate with the output artifact that will be exported from the compute action.
*)name : artifact_name;The name of the output of an artifact, such as "My App".
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
Output artifact names must be unique within a pipeline.
*)}Represents information about the output of an action.
type nonrec output_artifact_list = output_artifact listtype nonrec input_artifact = {name : artifact_name;The name of the artifact to be worked on (for example, "My App").
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
*)}Represents information about an artifact to be worked on, such as a test or build artifact.
type nonrec input_artifact_list = input_artifact listtype nonrec output_variable_list = output_variable listtype nonrec environment_variable = {type_ : environment_variable_type option;Specifies the type of use for the environment variable value. The value can be either PLAINTEXT or SECRETS_MANAGER. If the value is SECRETS_MANAGER, provide the Secrets reference in the EnvironmentVariable value.
value : environment_variable_value;The environment variable value in the key-value pair.
*)name : environment_variable_name;The environment variable name in the key-value pair.
*)}The environment variables for the action.
type nonrec environment_variable_list = environment_variable listtype nonrec action_declaration = {environment_variables : environment_variable_list option;The environment variables for the action.
*)timeout_in_minutes : action_timeout option;A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in Quotas for CodePipeline. This attribute is available only to the manual approval ActionType.
*)namespace : action_namespace option;The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
*)region : aws_region_name option;The action declaration's Amazon Web Services Region, such as us-east-1.
*)role_arn : role_arn option;The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*)output_variables : output_variable_list option;The list of variables that are to be exported from the compute action. This is specifically CodeBuild environment variables as used for that action.
*)input_artifacts : input_artifact_list option;The name or ID of the artifact consumed by the action, such as a test or build artifact.
*)output_artifacts : output_artifact_list option;The name or ID of the result of the action declaration, such as a test or build artifact.
*)commands : command_list option;The shell commands to run with your compute action in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Using compute time for this action will incur separate charges in CodeBuild.
*)configuration : action_configuration_map option;The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide.
The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:
JSON:
"Configuration" : { Key : Value },
run_order : action_run_order option;The order in which actions are run.
*)action_type_id : action_type_id;Specifies the action type and the provider of the action.
*)name : action_name;The action declaration's name.
*)}Represents information about an action declaration.
type nonrec stage_action_declaration_list = action_declaration listtype nonrec retry_configuration = {retry_mode : stage_retry_mode option;The method that you want to configure for automatic stage retry on stage failure. You can specify to retry only failed action in the stage or all actions in the stage.
*)}The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
type nonrec rule_type_id = {version : version option;A string that describes the rule version.
*)provider : rule_provider;The rule provider, such as the DeploymentWindow rule. For a list of rule provider names, see the rules listed in the CodePipeline rule reference.
owner : rule_owner option;The creator of the rule being called. The valid value for the Owner field in the rule category is AWS.
category : rule_category;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.
}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.
type nonrec rule_configuration_map =
(rule_configuration_key * rule_configuration_value) listtype nonrec rule_declaration = {timeout_in_minutes : rule_timeout option;The action timeout for the rule.
*)region : aws_region_name option;The Region for the condition associated with the rule.
*)role_arn : role_arn option;The pipeline role ARN associated with the rule.
*)input_artifacts : input_artifact_list option;The input artifacts fields for the rule, such as specifying an input file for the rule.
*)commands : command_list option;The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.
Using compute time for this action will incur separate charges in CodeBuild.
*)configuration : rule_configuration_map option;The action configuration fields for the rule.
*)rule_type_id : rule_type_id;The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
*)name : rule_name;The name of the rule that is created for the condition, such as VariableCheck.
}Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage conditions and How do stage conditions work?. For more information about rules, see the CodePipeline rule reference.
type nonrec rule_declaration_list = rule_declaration listtype nonrec condition = {rules : rule_declaration_list option;The rules that make up the condition.
*)result_ : result_ option;The action to be done when the condition is met. For example, rolling back an execution for a failure condition.
*)}The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.. For more information about rules, see the CodePipeline rule reference.
type nonrec condition_list = condition listtype nonrec failure_conditions = {conditions : condition_list option;The conditions that are configured as failure conditions. For more information about conditions, see Stage conditions and How do stage conditions work?.
*)retry_configuration : retry_configuration option;The retry configuration specifies automatic retry for a failed stage, along with the configured retry mode.
*)result_ : result_ option;The specified result for when the failure conditions are met, such as rolling back the stage.
*)}The configuration that specifies the result, such as rollback, to occur upon stage failure. For more information about conditions, see Stage conditions and How do stage conditions work?.
type nonrec success_conditions = {conditions : condition_list;The conditions that are success conditions.
*)}The conditions for making checks that, if met, succeed a stage. For more information about conditions, see Stage conditions and How do stage conditions work?.
type nonrec before_entry_conditions = {conditions : condition_list;The conditions that are configured as entry conditions.
*)}The conditions for making checks for entry to a stage. For more information about conditions, see Stage conditions and How do stage conditions work?.
type nonrec stage_declaration = {before_entry : before_entry_conditions option;The method to use when a stage allows entry. For example, configuring this field for conditions will allow entry to the stage when the conditions are met.
*)on_success : success_conditions option;The method to use when a stage has succeeded. For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.
*)on_failure : failure_conditions option;The method to use when a stage has not completed successfully. For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.
*)actions : stage_action_declaration_list;The actions included in a stage.
*)blockers : stage_blocker_declaration_list option;Reserved for future use.
*)name : stage_name;The name of the stage.
*)}Represents information about a stage and its definition.
type nonrec pipeline_stage_declaration_list = stage_declaration listtype nonrec pipeline_variable_declaration = {description : pipeline_variable_description option;The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes.
*)default_value : pipeline_variable_value option;The value of a pipeline-level variable.
*)name : pipeline_variable_name;The name of a pipeline-level variable.
*)}A variable declared at the pipeline level.
type nonrec pipeline_variable_declaration_list =
pipeline_variable_declaration listtype nonrec git_tag_pattern_list = git_tag_name_pattern listtype nonrec git_tag_filter_criteria = {excludes : git_tag_pattern_list option;The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.
*)includes : git_tag_pattern_list option;The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the pipeline.
*)}The Git tags specified as filter criteria for whether a Git tag repository event will start the pipeline.
type nonrec git_branch_pattern_list = git_branch_name_pattern listtype nonrec git_branch_filter_criteria = {excludes : git_branch_pattern_list option;The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
*)includes : git_branch_pattern_list option;The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
*)}The Git repository branches specified as filter criteria to start the pipeline.
type nonrec git_file_path_pattern_list = git_file_path_pattern listtype nonrec git_file_path_filter_criteria = {excludes : git_file_path_pattern_list option;The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
*)includes : git_file_path_pattern_list option;The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
*)}The Git repository file paths specified as filter criteria to start the pipeline.
type nonrec git_push_filter = {file_paths : git_file_path_filter_criteria option;The field that specifies to filter on file paths for the push trigger configuration.
*)branches : git_branch_filter_criteria option;The field that specifies to filter on branches for the push trigger configuration.
*)}The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.
type nonrec git_push_filter_list = git_push_filter listtype nonrec git_pull_request_event_type_list = git_pull_request_event_type listtype nonrec git_pull_request_filter = {file_paths : git_file_path_filter_criteria option;The field that specifies to filter on file paths for the pull request trigger configuration.
*)branches : git_branch_filter_criteria option;The field that specifies to filter on branches for the pull request trigger configuration.
*)events : git_pull_request_event_type_list option;The field that specifies which pull request events to filter on (OPEN, UPDATED, CLOSED) for the trigger configuration.
*)}The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
The following are valid values for the events for this filter:
type nonrec git_pull_request_filter_list = git_pull_request_filter listtype nonrec git_configuration = {pull_request : git_pull_request_filter_list option;The field where the repository event that will start the pipeline is specified as pull requests.
*)push : git_push_filter_list option;The field where the repository event that will start the pipeline, such as pushing Git tags, is specified with details.
*)source_action_name : action_name;The name of the pipeline source action where the trigger configuration, such as Git tags, is specified. The trigger configuration will start the pipeline upon the specified change only.
You can only specify one trigger configuration per source action.
*)}A type of trigger configuration for Git-based source actions.
You can specify the Git configuration trigger type for all third-party Git-based source actions that are supported by the CodeStarSourceConnection action type.
type nonrec pipeline_trigger_declaration = {git_configuration : git_configuration;Provides the filter criteria and the source stage for the repository event that starts the pipeline, such as Git tags.
*)provider_type : pipeline_trigger_provider_type;The source provider for the event, such as connections configured for a repository with Git tags, for the specified trigger configuration.
*)}Represents information about the specified trigger configuration, such as the filter criteria and the source stage for the action that contains the trigger.
This is only supported for the CodeStarSourceConnection action type.
When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
type nonrec pipeline_trigger_declaration_list =
pipeline_trigger_declaration listtype nonrec pipeline_declaration = {triggers : pipeline_trigger_declaration_list option;The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
When a trigger configuration is specified, default change detection for repository and branch commits is disabled.
*)variables : pipeline_variable_declaration_list option;A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.
pipeline_type : pipeline_type option;CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.
For information about pricing for CodePipeline, see Pricing.
For information about which type of pipeline to choose, see What type of pipeline is right for me?.
*)execution_mode : execution_mode option;The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
*)version : pipeline_version option;The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
*)stages : pipeline_stage_declaration_list;The stage in which to perform the action.
*)artifact_stores : artifact_store_map option;A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
artifact_store : artifact_store option;Represents information about the S3 bucket where artifacts are stored for the pipeline.
You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
role_arn : role_arn;The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
name : pipeline_name;The name of the pipeline.
*)}Represents the structure of actions and stages to be performed in the pipeline.
type nonrec update_pipeline_output = {pipeline : pipeline_declaration option;The structure of the updated pipeline.
*)}Represents the output of an UpdatePipeline action.
type nonrec update_pipeline_input = {pipeline : pipeline_declaration;The name of the pipeline to be updated.
*)}Represents the input of an UpdatePipeline action.
type nonrec limit_exceeded_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
type nonrec invalid_structure_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The structure was specified in an invalid format.
type nonrec invalid_stage_declaration_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The stage declaration was specified in an invalid format.
type nonrec invalid_blocker_declaration_exception = {message : message option;The message provided to the user in the event of an exception.
*)}Reserved for future use.
type nonrec invalid_action_declaration_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The action declaration was specified in an invalid format.
type nonrec lambda_executor_configuration = {lambda_function_arn : lambda_function_arn;The ARN of the Lambda function used by the action engine.
*)}Details about the configuration for the Lambda action engine, or executor.
type nonrec polling_account_list = account_id listtype nonrec polling_service_principal_list = service_principal listtype nonrec job_worker_executor_configuration = {polling_service_principals : polling_service_principal_list option;The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
*)polling_accounts : polling_account_list option;The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
*)}Details about the polling configuration for the JobWorker action engine, or executor.
type nonrec executor_configuration = {job_worker_executor_configuration : job_worker_executor_configuration option;Details about the JobWorker executor of the action type.
lambda_executor_configuration : lambda_executor_configuration option;Details about the Lambda executor of the action type.
}The action engine, or executor, related to the supported integration model used to create and update the action type. The available executor types are Lambda and JobWorker.
type nonrec action_type_executor = {job_timeout : job_timeout option;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.
*)policy_statements_template : policy_statements_template option;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.
*)type_ : executor_type;The integration model used to create and update the action type, Lambda or JobWorker.
configuration : executor_configuration;The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
*)}The action engine, or executor, for an action type created for a provider, where the action is to be used by customers of the provider. The action engine is associated with the model used to create and update the action, such as the Lambda integration model.
type nonrec action_type_identifier = {version : version;A string that describes the action type version.
*)provider : action_provider;The provider of the action type being called. The provider name is supplied when the action type is created.
*)owner : action_type_owner;The creator of the action type being called: AWS or ThirdParty.
category : action_category;Defines what kind of action can be taken in the stage, one of the following:
SourceBuildTestDeployApprovalInvoke}Specifies the category, owner, provider, and version of the action type.
type nonrec action_type_artifact_details = {maximum_count : maximum_action_type_artifact_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.
minimum_count : minimum_action_type_artifact_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.
}Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.
type nonrec allowed_accounts = allowed_account listtype nonrec action_type_permissions = {allowed_accounts : allowed_accounts;A list of Amazon Web Services account IDs with access to use the action type in their pipelines.
*)}Details identifying the users with permissions to use the action type.
type nonrec action_type_property = {description : property_description option;The description of the property that is displayed to users.
*)queryable : boolean_ option;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.
*)no_echo : boolean_;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.
key : boolean_;Whether the configuration property is a key.
*)optional : boolean_;Whether the configuration property is an optional value.
*)name : action_configuration_key;The property name that is displayed to users.
*)}Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.
type nonrec action_type_properties = action_type_property listtype nonrec action_type_urls = {revision_url_template : url_template option;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.
*)execution_url_template : url_template option;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.
*)entity_url_template : url_template option;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.
*)configuration_url : url option;The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
*)}Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.
type nonrec action_type_declaration = {urls : action_type_urls option;The links associated with the action type to be updated.
*)properties : action_type_properties option;The properties of the action type to be updated.
*)permissions : action_type_permissions option;Details identifying the accounts with permissions to use the action type.
*)output_artifact_details : action_type_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.
*)input_artifact_details : action_type_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.
*)id : action_type_identifier;The action category, owner, provider, and version of the action type to be updated.
*)executor : action_type_executor;Information about the executor for an action type that was created with any supported integration model.
*)description : action_type_description option;The description for the action type to be updated.
*)}The parameters for the action type definition that are provided when the action type is created or updated.
type nonrec update_action_type_input = {action_type : action_type_declaration;The action type definition for the action type to be updated.
*)}The request failed because of an unknown error, exception, or failure.
type nonrec action_type_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The specified action type cannot be found.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_input = {tag_keys : tag_key_list;The list of keys for the tags to be removed from the resource.
*)resource_arn : resource_arn;The Amazon Resource Name (ARN) of the resource to remove tags from.
*)}type nonrec resource_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The resource was specified in an invalid format.
The specified resource ARN is invalid.
Unable to modify the tag due to a simultaneous update request.
Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.
type nonrec transition_state = {disabled_reason : disabled_reason option;The user-specified reason why the transition between two stages of a pipeline was disabled.
*)last_changed_at : last_changed_at option;The timestamp when the transition state was last changed.
*)last_changed_by : last_changed_by option;The ID of the user who last changed the transition state.
*)enabled : enabled option;Whether the transition between stages is enabled (true) or disabled (false).
*)}Represents information about the state of transitions between one stage and another stage.
type nonrec third_party_job = {job_id : job_id option;The identifier used to identify the job in CodePipeline.
*)client_id : client_id option;The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
}A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on by a partner action.
type nonrec third_party_job_list = third_party_job listtype nonrec action_configuration = {configuration : action_configuration_map option;The configuration data for the action.
*)}Represents information about an action configuration.
Represents information about a stage to a job worker.
type nonrec action_context = {action_execution_id : action_execution_id option;The system-generated unique ID that corresponds to an action's execution.
*)name : action_name option;The name of the action in the context of a job.
*)}Represents the context of an action in the stage of a pipeline to a job worker.
type nonrec pipeline_context = {pipeline_execution_id : pipeline_execution_id option;The execution ID of the pipeline.
*)pipeline_arn : pipeline_arn option;The Amazon Resource Name (ARN) of the pipeline.
*)action : action_context option;The context of an action to a job worker in the stage of a pipeline.
*)stage : stage_context option;The stage of the pipeline.
*)pipeline_name : pipeline_name option;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.
*)}Represents information about a pipeline to a job worker.
PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.
type nonrec s3_artifact_location = {object_key : s3_object_key;The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
*)bucket_name : s3_bucket_name;The name of the S3 bucket.
*)}The location of the S3 bucket that contains a revision.
type nonrec artifact_location = {s3_location : s3_artifact_location option;The S3 bucket that contains the artifact.
*)type_ : artifact_location_type option;The type of artifact in the location.
*)}Represents information about the location of an artifact.
type nonrec artifact = {location : artifact_location option;The location of an artifact.
*)revision : revision option;The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
*)name : artifact_name option;The artifact's name.
*)}Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip
type nonrec artifact_list = artifact listtype nonrec aws_session_credentials = {session_token : session_token;The token for the session.
*)secret_access_key : secret_access_key;The secret access key for the session.
*)access_key_id : access_key_id;The access key for the session.
*)}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 artifact for the pipeline in CodePipeline.
type nonrec third_party_job_data = {encryption_key : encryption_key option;The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.
*)continuation_token : continuation_token option;A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
*)artifact_credentials : aws_session_credentials option;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 artifact for the pipeline in CodePipeline.
*)output_artifacts : artifact_list option;The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
*)input_artifacts : artifact_list option;The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
*)pipeline_context : pipeline_context option;Represents information about a pipeline to a job worker.
Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
action_configuration : action_configuration option;Represents information about an action configuration.
*)action_type_id : action_type_id option;Represents information about an action type.
*)}Represents information about the job data for a partner action.
type nonrec third_party_job_details = {nonce : nonce option;A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
data : third_party_job_data option;The data to be returned by the third party job worker.
*)id : third_party_job_id option;The identifier used to identify the job details in CodePipeline.
*)}The details of a job sent in response to a GetThirdPartyJobDetails request.
type nonrec target_filter_value_list = target_filter_value listtype nonrec target_filter = {values : target_filter_value_list option;The values on which to filter.
*)name : target_filter_name option;The name on which to filter.
*)}Filters the list of targets.
type nonrec target_filter_list = target_filter listtype nonrec tag_resource_input = {resource_arn : resource_arn;The Amazon Resource Name (ARN) of the resource you want to add tags to.
*)}type nonrec succeeded_in_stage_filter = {stage_name : stage_name option;The name of the stage for filtering for pipeline executions where the stage was successful in the current pipeline version.
*)}Filter for pipeline executions that have successfully completed the stage in the current pipeline version.
type nonrec stop_pipeline_execution_output = {pipeline_execution_id : pipeline_execution_id option;The unique system-generated ID of the pipeline execution that was stopped.
*)}type nonrec stop_pipeline_execution_input = {reason : stop_pipeline_execution_reason option;Use this option to enter comments, such as the reason the pipeline was stopped.
*)abandon : boolean_ option;Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
*)pipeline_execution_id : pipeline_execution_id;The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
pipeline_name : pipeline_name;The name of the pipeline to stop.
*)}type nonrec pipeline_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The pipeline was specified in an invalid format or cannot be found.
Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.
The pipeline execution is already in a Stopping state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again.
Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
type nonrec stop_execution_trigger = {reason : stop_pipeline_execution_reason option;The user-specified reason the pipeline was stopped.
*)}The interaction that stopped a pipeline execution.
type nonrec start_pipeline_execution_output = {pipeline_execution_id : pipeline_execution_id option;The unique system-generated ID of the pipeline execution that was started.
*)}Represents the output of a StartPipelineExecution action.
type nonrec pipeline_variable = {value : pipeline_variable_value;The value of a pipeline-level variable.
*)name : pipeline_variable_name;The name of a pipeline-level variable.
*)}A pipeline-level variable used for a pipeline execution.
type nonrec pipeline_variable_list = pipeline_variable listtype nonrec source_revision_override = {revision_value : revision;The source revision, or version of your source artifact, with the changes that you want to run in the pipeline execution.
*)revision_type : source_revision_type;The type of source revision, based on the source provider. For example, the revision type for the CodeCommit action provider is the commit ID.
*)action_name : action_name;The name of the action where the override will be applied.
*)}A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.
For the S3_OBJECT_VERSION_ID and S3_OBJECT_KEY types of source revisions, either of the types can be used independently, or they can be used together to override the source with a specific ObjectKey and VersionID.
type nonrec source_revision_override_list = source_revision_override listtype nonrec start_pipeline_execution_input = {source_revisions : source_revision_override_list option;A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.
*)client_request_token : client_request_token option;The system-generated unique ID used to identify a unique execution request.
*)variables : pipeline_variable_list option;A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty string.
name : pipeline_name;The name of the pipeline to start.
*)}Represents the input of a StartPipelineExecution action.
The pipeline has reached the limit for concurrent pipeline executions.
type nonrec stage_execution = {type_ : execution_type option;The type of pipeline execution for the stage, such as a rollback pipeline execution.
*)status : stage_execution_status;The status of the stage, or for a completed stage, the last status of the stage.
A status of cancelled means that the pipeline’s definition was updated before the stage execution could be completed.
*)pipeline_execution_id : pipeline_execution_id;The ID of the pipeline execution associated with the stage.
*)}Represents information about the run of a stage.
type nonrec stage_execution_list = stage_execution listtype nonrec action_revision = {created : timestamp;The date and time when the most recent version of the action was created, in timestamp format.
*)revision_change_id : revision_change_identifier;The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
*)revision_id : revision;The system-generated unique ID that identifies the revision number of the action.
*)}Represents information about the version (or revision) of an action.
type nonrec error_details = {message : message option;The text of the error message.
*)code : code option;The system ID or number code of the error.
*)}Represents information about an error in CodePipeline.
type nonrec action_execution = {log_stream_ar_n : log_stream_ar_n option;The Amazon Resource Name (ARN) of the log stream for the action compute.
*)error_details : error_details option;The details of an error returned by a URL external to Amazon Web Services.
*)percent_complete : percentage option;A percentage of completeness of the action as it runs.
*)external_execution_url : url option;The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).
*)external_execution_id : execution_id option;The external ID of the run of the action.
*)last_updated_by : last_updated_by option;The ARN of the user who last changed the pipeline.
*)token : action_execution_token option;The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.
last_status_change : timestamp option;The last status change of the action.
*)summary : execution_summary option;A summary of the run of the action.
*)status : action_execution_status option;The status of the action, or for a completed action, the last status of the action.
*)action_execution_id : action_execution_id option;ID of the workflow action execution in the current stage. Use the GetPipelineState action to retrieve the current action execution details of the current stage.
For older executions, this field might be empty. The action execution ID is available for executions run on or after March 2020.
*)}Represents information about the run of an action.
type nonrec action_state = {revision_url : url option;A URL link for more information about the revision, such as a commit details page.
*)entity_url : url option;A URL link for more information about the state of the action, such as a deployment group details page.
*)latest_execution : action_execution option;Represents information about the run of an action.
*)current_revision : action_revision option;Represents information about the version (or revision) of an action.
*)action_name : action_name option;The name of the action.
*)}Represents information about the state of an action.
type nonrec action_state_list = action_state listtype nonrec stage_conditions_execution = {summary : execution_summary option;A summary of the run of the condition for a stage.
*)status : condition_execution_status option;The status of a run of a condition for a stage.
*)}Represents information about the run of a condition for a stage.
type nonrec condition_execution = {last_status_change : timestamp option;The last status change of the condition.
*)summary : execution_summary option;The summary of information about a run for a condition.
*)status : condition_execution_status option;The status of the run for a condition.
*)}The run of a condition.
type nonrec rule_revision = {created : timestamp;The date and time when the most recent version of the rule was created, in timestamp format.
*)revision_change_id : revision_change_identifier;The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
*)revision_id : revision;The system-generated unique ID that identifies the revision number of the rule.
*)}The change to a rule that creates a revision of the rule.
type nonrec rule_execution = {error_details : error_details option;external_execution_url : url option;The URL of a resource external to Amazon Web Services that is used when running the rule (for example, an external repository URL).
*)external_execution_id : execution_id option;The external ID of the run of the rule.
*)last_updated_by : last_updated_by option;The ARN of the user who last changed the rule.
*)token : rule_execution_token option;The system-generated token used to identify a unique request.
*)last_status_change : timestamp option;The last status change of the rule.
*)summary : execution_summary option;A summary of the run of the rule.
*)status : rule_execution_status option;The status of the run of the rule, such as FAILED.
*)rule_execution_id : rule_execution_id option;The execution ID for the run of the rule.
*)}Represents information about each time a rule is run as part of the pipeline execution for a pipeline configured with conditions.
type nonrec rule_state = {revision_url : url option;A URL link for more information about the revision, such as a commit details page.
*)entity_url : url option;A URL link for more information about the state of the action, such as a details page.
*)latest_execution : rule_execution option;Represents information about the latest run of an rule.
*)current_revision : rule_revision option;The ID of the current revision of the artifact successfully worked on by the job.
*)rule_name : rule_name option;The name of the rule.
*)}Returns information about the state of a rule.
Values returned in the revisionId field indicate the rule revision information, such as the commit ID, for the current state.
type nonrec rule_state_list = rule_state listtype nonrec condition_state = {rule_states : rule_state_list option;The state of the rules for the condition.
*)latest_execution : condition_execution option;The state of the latest run of the rule.
*)}Information about the state of the condition.
type nonrec condition_state_list = condition_state listtype nonrec stage_condition_state = {condition_states : condition_state_list option;The states of the conditions for a run of a condition for a stage.
*)latest_execution : stage_conditions_execution option;Represents information about the latest run of a condition for a stage.
*)}The state of a run of a condition for a stage.
type nonrec retry_stage_metadata = {latest_retry_trigger : retry_trigger option;The latest trigger for a specific stage where manual or automatic retries have been made upon stage failure.
*)manual_stage_retry_attempt : retry_attempt option;The number of attempts for a specific stage where manual retries have been made upon stage failure.
*)auto_stage_retry_attempt : retry_attempt option;The number of attempts for a specific stage with automatic retry on stage failure. One attempt is allowed for automatic stage retry on failure.
*)}The details of a specific automatic retry on stage failure, including the attempt number and trigger.
type nonrec stage_state = {retry_stage_metadata : retry_stage_metadata option;he details of a specific automatic retry on stage failure, including the attempt number and trigger.
*)on_failure_condition_state : stage_condition_state option;The state of the failure conditions for a stage.
*)on_success_condition_state : stage_condition_state option;The state of the success conditions for a stage.
*)before_entry_condition_state : stage_condition_state option;The state of the entry conditions for a stage.
*)latest_execution : stage_execution option;Information about the latest execution in the stage, including its ID and status.
*)action_states : action_state_list option;The state of the stage.
*)inbound_transition_state : transition_state option;The state of the inbound transition, which is either enabled or disabled.
*)inbound_executions : stage_execution_list option;The inbound executions for a stage.
*)inbound_execution : stage_execution option;stage_name : stage_name option;The name of the stage.
*)}Represents information about the state of the stage.
type nonrec stage_state_list = stage_state listtype nonrec stage_not_retryable_exception = {message : message option;The message provided to the user in the event of an exception.
*)}Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
type nonrec stage_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The stage was specified in an invalid format or cannot be found.
type nonrec source_revision = {revision_url : url option;The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
*)revision_summary : revision_summary option;Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
revision_id : revision option;The system-generated unique ID that identifies the revision number of the artifact.
*)action_name : action_name;The name of the action that processed the revision to the source artifact.
*)}Information about the version (or revision) of a source artifact that initiated a pipeline execution.
type nonrec source_revision_list = source_revision listtype nonrec s3_location = {key : s3_key option;The artifact name.
*)bucket : s3_bucket option;The Amazon S3 artifact bucket for an action's artifacts.
*)}The Amazon S3 artifact location for an action's artifacts.
type nonrec rule_type_settings = {revision_url_template : url_template option;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.
*)execution_url_template : url_template option;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.
*)entity_url_template : url_template option;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.
*)third_party_configuration_url : url option;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.
*)}Returns information about the settings for a rule type.
type nonrec rule_configuration_property = {type_ : rule_configuration_property_type option;The type of the configuration property.
*)description : description option;The description of the action configuration property that is displayed to users.
*)queryable : boolean_ option;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.
*)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.
*)key : boolean_;Whether the configuration property is a key.
*)required : boolean_;Whether the configuration property is a required value.
*)name : rule_configuration_key;The name of the rule configuration property.
*)}Represents information about a rule configuration property.
type nonrec rule_configuration_property_list = rule_configuration_property listtype nonrec artifact_details = {maximum_count : maximum_artifact_count;The maximum number of artifacts allowed for the action type.
*)minimum_count : minimum_artifact_count;The minimum number of artifacts allowed for the action type.
*)}Returns information about the details of an artifact.
type nonrec rule_type = {input_artifact_details : artifact_details;rule_configuration_properties : rule_configuration_property_list option;The configuration properties for the rule type.
*)settings : rule_type_settings option;Returns information about the settings for a rule type.
*)id : rule_type_id;Represents information about a rule type.
*)}The rule type, which is made up of the combined values for category, owner, provider, and version.
type nonrec rule_type_list = rule_type listtype nonrec rule_execution_result = {error_details : error_details option;external_execution_url : url option;The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the rule.
*)external_execution_summary : external_execution_summary option;The external provider summary for the rule execution.
*)external_execution_id : external_execution_id option;The external ID for the rule execution.
*)}Execution result information, such as the external execution ID.
type nonrec rule_execution_output = {execution_result : rule_execution_result option;Execution result information listed in the output details for a rule execution.
*)}Output details listed for a rule execution, such as the rule execution result.
type nonrec artifact_detail = {s3location : s3_location option;The Amazon S3 artifact location for the action execution.
*)name : artifact_name option;The artifact object name for the action execution.
*)}Artifact details for the action execution, such as the artifact location.
type nonrec artifact_detail_list = artifact_detail listtype nonrec rule_execution_input = {input_artifacts : artifact_detail_list option;Details of input artifacts of the rule that correspond to the rule execution.
*)region : aws_region_name option;The Amazon Web Services Region for the rule, such as us-east-1.
*)role_arn : role_arn option;The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.
*)resolved_configuration : resolved_rule_configuration_map option;Configuration data for a rule execution with all variable references replaced with their real values for the execution.
*)configuration : rule_configuration_map option;Configuration data for a rule execution, such as the resolved values for that run.
*)rule_type_id : rule_type_id option;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.
*)}Input information used for a rule execution.
type nonrec latest_in_pipeline_execution_filter = {start_time_range : start_time_range;The start time to filter on for the latest execution in the pipeline. Valid options:
pipeline_execution_id : pipeline_execution_id;The execution ID for the latest execution in the pipeline.
*)}The field that specifies to filter on the latest execution in the pipeline.
Filtering on the latest execution is available for executions run on or after February 08, 2024.
type nonrec rule_execution_filter = {latest_in_pipeline_execution : latest_in_pipeline_execution_filter option;pipeline_execution_id : pipeline_execution_id option;The pipeline execution ID used to filter rule execution history.
*)}Filter values for the rule execution.
type nonrec rule_execution_detail = {output : rule_execution_output option;Output details for the rule execution, such as the rule execution result.
*)input : rule_execution_input option;Input details for the rule execution, such as role ARN, Region, and input artifacts.
*)status : rule_execution_status option;The status of the rule execution. Status categories are InProgress, Succeeded, and Failed.
updated_by : last_updated_by option;The ARN of the user who changed the rule execution details.
*)last_update_time : timestamp option;The date and time of the last change to the rule execution, in timestamp format.
*)start_time : timestamp option;The start time of the rule execution.
*)rule_name : rule_name option;The name of the rule that was run in the stage.
*)stage_name : stage_name option;The name of the stage where the rule was run.
*)pipeline_version : pipeline_version option;The version number of the pipeline with the stage where the rule was run.
*)rule_execution_id : rule_execution_id option;The ID of the run for the rule.
*)pipeline_execution_id : pipeline_execution_id option;The ID of the pipeline execution in the stage where the rule was run. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the stage.
}The details of the runs for a rule and the results produced on an artifact as it passes through stages in the pipeline.
type nonrec rule_execution_detail_list = rule_execution_detail listtype nonrec rollback_stage_output = {pipeline_execution_id : pipeline_execution_id;The execution ID of the pipeline execution for the stage that has been rolled back.
*)}type nonrec rollback_stage_input = {target_pipeline_execution_id : pipeline_execution_id;The pipeline execution ID for the stage to be rolled back to.
*)stage_name : stage_name;The name of the stage in the pipeline to be rolled back.
*)pipeline_name : pipeline_name;The name of the pipeline for which the stage will be rolled back.
*)}The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.
type nonrec pipeline_execution_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
type nonrec retry_stage_execution_output = {pipeline_execution_id : pipeline_execution_id option;The ID of the current workflow execution in the failed stage.
*)}Represents the output of a RetryStageExecution action.
type nonrec retry_stage_execution_input = {retry_mode : stage_retry_mode;The scope of the retry attempt.
*)pipeline_execution_id : pipeline_execution_id;The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage
stage_name : stage_name;The name of the failed stage to be retried.
*)pipeline_name : pipeline_name;The name of the pipeline that contains the failed stage.
*)}Represents the input of a RetryStageExecution action.
type nonrec not_latest_pipeline_execution_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
type nonrec resolved_pipeline_variable = {resolved_value : string_ option;The resolved value of a pipeline-level variable.
*)name : string_ option;The name of a pipeline-level variable.
*)}A pipeline-level variable used for a pipeline execution.
type nonrec resolved_pipeline_variable_list = resolved_pipeline_variable listtype nonrec register_webhook_with_third_party_input = {webhook_name : webhook_name option;The name of an existing webhook created with PutWebhook to register with a supported third party.
*)}type nonrec query_param_map =
(action_configuration_key * action_configuration_queryable_value) listtype nonrec put_webhook_output = {webhook : list_webhook_item option;The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
*)}type nonrec put_webhook_input = {webhook : webhook_definition;The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.
*)}type nonrec invalid_webhook_filter_pattern_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The specified event filter rule is in an invalid format.
type nonrec invalid_webhook_authentication_parameters_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The specified authentication type is in an invalid format.
type nonrec current_revision = {revision_summary : revision_summary option;The summary of the most recent revision of the artifact.
*)created : time option;The date and time when the most recent revision of the artifact was created, in timestamp format.
*)change_identifier : revision_change_identifier;The change identifier for the current revision.
*)revision : revision;The revision ID of the current version of an artifact.
*)}Represents information about a current revision.
type nonrec execution_details = {percent_complete : percentage option;The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
*)external_execution_id : execution_id option;The system-generated unique ID of this action used to identify this job worker in any external systems, such as CodeDeploy.
*)summary : execution_summary option;The summary of the current status of the actions.
*)}The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
type nonrec put_third_party_job_success_result_input = {execution_details : execution_details option;The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
*)continuation_token : continuation_token option;A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
*)current_revision : current_revision option;Represents information about a current revision.
*)client_token : client_token;The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*)job_id : third_party_job_id;The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
}Represents the input of a PutThirdPartyJobSuccessResult action.
type nonrec job_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The job was specified in an invalid format or cannot be found.
type nonrec invalid_job_state_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The job state was specified in an invalid format.
type nonrec invalid_client_token_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The client token was specified in an invalid format
type nonrec failure_details = {external_execution_id : execution_id option;The external ID of the run of the action that failed.
*)message : message;The message about the failure.
*)type_ : failure_type;The type of the failure.
*)}Represents information about failure details.
type nonrec put_third_party_job_failure_result_input = {failure_details : failure_details;Represents information about failure details.
*)client_token : client_token;The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*)job_id : third_party_job_id;The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
}Represents the input of a PutThirdPartyJobFailureResult action.
type nonrec output_variables_map =
(output_variables_key * output_variables_value) listtype nonrec put_job_success_result_input = {output_variables : output_variables_map option;Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.
execution_details : execution_details option;The execution details of the successful job, such as the actions taken by the job worker.
*)continuation_token : continuation_token option;A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
*)current_revision : current_revision option;The ID of the current revision of the artifact successfully worked on by the job.
*)job_id : job_id;The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
}Represents the input of a PutJobSuccessResult action.
Exceeded the total size limit for all variables in the pipeline.
type nonrec put_job_failure_result_input = {failure_details : failure_details;The details about the failure of a job.
*)job_id : job_id;The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
}Represents the input of a PutJobFailureResult action.
type nonrec put_approval_result_output = {approved_at : timestamp option;The timestamp showing when the approval or rejection was submitted.
*)}Represents the output of a PutApprovalResult action.
type nonrec approval_result = {status : approval_status;The response submitted by a reviewer assigned to an approval action request.
*)summary : approval_summary;The summary of the current status of the approval request.
*)}Represents information about the result of an approval request.
type nonrec put_approval_result_input = {token : approval_token;The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject an approval request as detailed above is not available. Instead, use the externalExecutionId in the response output from the ListActionExecutions action as the token in the approval request.
result_ : approval_result;Represents information about the result of the approval request.
*)action_name : action_name;The name of the action for which approval is requested.
*)stage_name : stage_name;The name of the stage that contains the action.
*)pipeline_name : pipeline_name;The name of the pipeline that contains the action.
*)}Represents the input of a PutApprovalResult action.
type nonrec invalid_approval_token_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The approval request already received a response or has expired.
type nonrec approval_already_completed_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The approval action has already been approved or rejected.
type nonrec action_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The specified action cannot be found.
type nonrec put_action_revision_output = {pipeline_execution_id : pipeline_execution_id option;The ID of the current workflow state of the pipeline.
*)new_revision : boolean_ option;Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
*)}Represents the output of a PutActionRevision action.
type nonrec put_action_revision_input = {action_revision : action_revision;Represents information about the version (or revision) of an action.
*)action_name : action_name;The name of the action that processes the revision.
*)stage_name : stage_name;The name of the stage that contains the action that acts on the revision.
*)pipeline_name : pipeline_name;The name of the pipeline that starts processing the revision to the source.
*)}Represents the input of a PutActionRevision action.
type nonrec poll_for_third_party_jobs_output = {jobs : third_party_job_list option;Information about the jobs to take action on.
*)}Represents the output of a PollForThirdPartyJobs action.
type nonrec poll_for_third_party_jobs_input = {max_batch_size : max_batch_size option;The maximum number of jobs to return in a poll for jobs call.
*)action_type_id : action_type_id;Represents information about an action type.
*)}Represents the input of a PollForThirdPartyJobs action.
type nonrec job_data = {encryption_key : encryption_key option;Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
*)continuation_token : continuation_token option;A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
*)artifact_credentials : aws_session_credentials option;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.
*)output_artifacts : artifact_list option;The output of the job.
*)input_artifacts : artifact_list option;The artifact supplied to the job.
*)pipeline_context : pipeline_context option;Represents information about a pipeline to a job worker.
Includes pipelineArn and pipelineExecutionId for custom jobs.
action_configuration : action_configuration option;Represents information about an action configuration.
*)action_type_id : action_type_id option;Represents information about an action type.
*)}Represents other information about a job required for a job worker to complete the job.
type nonrec job = {account_id : account_id option;The ID of the Amazon Web Services account to use when performing the job.
*)nonce : nonce option;A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
data : job_data option;Other data about a job.
*)id : job_id option;The unique system-generated ID of the job.
*)}Represents information about a job.
type nonrec job_list = job listtype nonrec poll_for_jobs_output = {jobs : job_list option;Information about the jobs to take action on.
*)}Represents the output of a PollForJobs action.
type nonrec poll_for_jobs_input = {query_param : query_param_map option;A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.
*)max_batch_size : max_batch_size option;The maximum number of jobs to return in a poll for jobs call.
*)action_type_id : action_type_id;Represents information about an action type.
*)}Represents the input of a PollForJobs action.
type nonrec pipeline_version_not_found_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The pipeline version was specified in an invalid format or cannot be found.
type nonrec pipeline_summary = {updated : timestamp option;The date and time of the last update to the pipeline, in timestamp format.
*)created : timestamp option;The date and time the pipeline was created, in timestamp format.
*)execution_mode : execution_mode option;The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
*)pipeline_type : pipeline_type option;CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.
For information about pricing for CodePipeline, see Pricing.
For information about which type of pipeline to choose, see What type of pipeline is right for me?.
*)version : pipeline_version option;The version number of the pipeline.
*)name : pipeline_name option;The name of the pipeline.
*)}Returns a summary of a pipeline.
type nonrec pipeline_rollback_metadata = {rollback_target_pipeline_execution_id : pipeline_execution_id option;The pipeline execution ID to which the stage will be rolled back.
*)}The metadata for the stage execution to be rolled back.
type nonrec pipeline_name_in_use_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The specified pipeline name is already in use.
type nonrec pipeline_metadata = {polling_disabled_at : timestamp option;The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format.
Pipelines that are inactive for longer than 30 days will have polling disabled for the pipeline. For more information, see pollingDisabledAt in the pipeline structure reference. For the steps to migrate your pipeline from polling to event-based change detection, see Migrate polling pipelines to use event-based change detection.
You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.
*)updated : timestamp option;The date and time the pipeline was last updated, in timestamp format.
*)created : timestamp option;The date and time the pipeline was created, in timestamp format.
*)pipeline_arn : pipeline_arn option;The Amazon Resource Name (ARN) of the pipeline.
*)}Information about a pipeline.
type nonrec pipeline_list = pipeline_summary listtype nonrec execution_trigger = {trigger_detail : trigger_detail option;Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
trigger_type : trigger_type option;The type of change-detection method, command, or user interaction that started a pipeline execution.
*)}The interaction or event that started a pipeline execution.
type nonrec pipeline_execution_summary = {rollback_metadata : pipeline_rollback_metadata option;The metadata for the stage execution to be rolled back.
*)execution_type : execution_type option;Type of the pipeline execution.
*)execution_mode : execution_mode option;The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
*)stop_trigger : stop_execution_trigger option;The interaction that stopped a pipeline execution.
*)trigger : execution_trigger option;The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
source_revisions : source_revision_list option;A list of the source artifact revisions that initiated a pipeline execution.
*)last_update_time : timestamp option;The date and time of the last change to the pipeline execution, in timestamp format.
*)start_time : timestamp option;The date and time when the pipeline execution began, in timestamp format.
*)status_summary : pipeline_execution_status_summary option;Status summary for the pipeline.
*)status : pipeline_execution_status option;The status of the pipeline execution.
pipeline_execution_id : pipeline_execution_id option;The ID of the pipeline execution.
*)}Summary information about a pipeline execution.
type nonrec pipeline_execution_summary_list = pipeline_execution_summary listtype nonrec pipeline_execution_filter = {succeeded_in_stage : succeeded_in_stage_filter option;Filter for pipeline executions where the stage was successful in the current pipeline version.
*)}The pipeline execution to filter on.
type nonrec artifact_revision = {revision_url : url option;The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
*)created : timestamp option;The date and time when the most recent revision of the artifact was created, in timestamp format.
*)revision_summary : revision_summary option;Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
revision_change_identifier : revision_change_identifier option;An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
*)revision_id : revision option;The revision ID of the artifact.
*)name : artifact_name option;The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
*)}Represents revision details of an artifact.
type nonrec artifact_revision_list = artifact_revision listtype nonrec pipeline_execution = {rollback_metadata : pipeline_rollback_metadata option;The metadata about the execution pertaining to stage rollback.
*)execution_type : execution_type option;The type of the pipeline execution.
*)execution_mode : execution_mode option;The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
*)trigger : execution_trigger option;variables : resolved_pipeline_variable_list option;A list of pipeline variables used for the pipeline execution.
*)artifact_revisions : artifact_revision_list option;A list of ArtifactRevision objects included in a pipeline execution.
status_summary : pipeline_execution_status_summary option;A summary that contains a description of the pipeline execution status.
*)status : pipeline_execution_status option;The status of the pipeline execution.
pipeline_execution_id : pipeline_execution_id option;The ID of the pipeline execution.
*)pipeline_version : pipeline_version option;The version number of the pipeline with the specified pipeline execution.
*)pipeline_name : pipeline_name option;The name of the pipeline with the specified pipeline execution.
*)}Represents information about an execution of a pipeline.
type nonrec override_stage_condition_input = {condition_type : condition_type;The type of condition to override for the stage, such as entry conditions, failure conditions, or success conditions.
*)pipeline_execution_id : pipeline_execution_id;The ID of the pipeline execution for the override.
*)stage_name : stage_name;The name of the stage for the override.
*)pipeline_name : pipeline_name;The name of the pipeline with the stage that will override the condition.
*)}Unable to override because the condition does not allow overrides.
type nonrec list_webhooks_output = {next_token : next_token option;If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.
*)webhooks : webhook_list option;The JSON detail returned for each webhook in the list output for the ListWebhooks call.
*)}type nonrec list_webhooks_input = {max_results : max_results option;The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*)next_token : next_token option;The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
*)}type nonrec invalid_next_token_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.
type nonrec list_rule_types_output = {rule_types : rule_type_list;Lists the rules that are configured for the condition.
*)}type nonrec list_rule_types_input = {region_filter : aws_region_name option;The rule Region to filter on.
*)rule_owner_filter : rule_owner option;The rule owner to filter on.
*)}type nonrec list_rule_executions_output = {next_token : next_token option;A token that can be used in the next ListRuleExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
rule_execution_details : rule_execution_detail_list option;Details about the output for listing rule executions.
*)}type nonrec list_rule_executions_input = {next_token : next_token option;The token that was returned from the previous ListRuleExecutions call, which can be used to return the next set of rule executions in the list.
max_results : max_results option;The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
*)filter : rule_execution_filter option;Input information used to filter rule execution history.
*)pipeline_name : pipeline_name;The name of the pipeline for which you want to get execution summary information.
*)}type nonrec list_pipelines_output = {next_token : next_token option;If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
*)pipelines : pipeline_list option;The list of pipelines.
*)}Represents the output of a ListPipelines action.
type nonrec list_pipelines_input = {max_results : max_pipelines option;The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.
*)next_token : next_token option;An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
*)}Represents the input of a ListPipelines action.
type nonrec list_pipeline_executions_output = {next_token : next_token option;A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
pipeline_execution_summaries : pipeline_execution_summary_list option;A list of executions in the history of a pipeline.
*)}Represents the output of a ListPipelineExecutions action.
type nonrec list_pipeline_executions_input = {next_token : next_token option;The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
filter : pipeline_execution_filter option;The pipeline execution to filter on.
*)max_results : max_results option;The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
*)pipeline_name : pipeline_name;The name of the pipeline for which you want to get execution summary information.
*)}Represents the input of a ListPipelineExecutions action.
type nonrec deploy_target_event_context = {message : string_ option;The context message for the event for the deploy action.
*)ssm_command_id : string_ option;The command ID for the event for the deploy action.
*)}The context for the event for the deploy action.
type nonrec deploy_target_event = {context : deploy_target_event_context option;The context for the event for the deploy action.
*)end_time : timestamp option;The end time for the event for the deploy action.
*)start_time : timestamp option;The start time for the event for the deploy action.
*)status : string_ option;The status of the event for the deploy action.
*)name : string_ option;The name of the event for the deploy action.
*)}A lifecycle event for the deploy action.
type nonrec deploy_target_event_list = deploy_target_event listtype nonrec deploy_action_execution_target = {events : deploy_target_event_list option;The lifecycle events for the deploy action.
*)end_time : timestamp option;The end time for the deploy action.
*)start_time : timestamp option;The start time for the deploy action.
*)status : string_ option;The status of the deploy action.
*)target_type : string_ option;The type of target for the deploy action.
*)target_id : string_ option;The ID of the target for the deploy action.
*)}The target for the deploy action.
type nonrec deploy_action_execution_target_list =
deploy_action_execution_target listtype nonrec list_deploy_action_execution_targets_output = {next_token : next_token option;An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
*)targets : deploy_action_execution_target_list option;The targets for the deploy action.
*)}type nonrec list_deploy_action_execution_targets_input = {next_token : next_token option;An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
*)max_results : max_results option;The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*)filters : target_filter_list option;Filters the targets for a specified deploy action.
*)action_execution_id : action_execution_id;The execution ID for the deploy action.
*)pipeline_name : pipeline_name option;The name of the pipeline with the deploy action.
*)}The action execution was not found.
type nonrec action_type_settings = {revision_url_template : url_template option;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.
*)execution_url_template : url_template option;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.
*)entity_url_template : url_template option;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.
*)third_party_configuration_url : url option;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.
*)}Returns information about the settings for an action type.
type nonrec action_configuration_property = {type_ : action_configuration_property_type option;The type of the configuration property.
*)description : description option;The description of the action configuration property that is displayed to users.
*)queryable : boolean_ option;Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.
If you create a pipeline with a custom action type, and that custom action 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.
*)secret : boolean_;Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.
When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
*)key : boolean_;Whether the configuration property is a key.
*)required : boolean_;Whether the configuration property is a required value.
*)name : action_configuration_key;The name of the action configuration property.
*)}Represents information about an action configuration property.
type nonrec action_configuration_property_list =
action_configuration_property listtype nonrec action_type = {output_artifact_details : artifact_details;The details of the output artifact of the action, such as its commit ID.
*)input_artifact_details : artifact_details;The details of the input artifact for the action, such as its commit ID.
*)action_configuration_properties : action_configuration_property_list option;The configuration properties for the action type.
*)settings : action_type_settings option;The settings for the action type.
*)id : action_type_id;Represents information about an action type.
*)}Returns information about the details of an action type.
type nonrec action_type_list = action_type listtype nonrec list_action_types_output = {next_token : next_token option;If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.
*)action_types : action_type_list;Provides details of the action types.
*)}Represents the output of a ListActionTypes action.
type nonrec list_action_types_input = {region_filter : aws_region_name option;The Region to filter on for the list of action types.
*)next_token : next_token option;An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
*)action_owner_filter : action_owner option;Filters the list of action types to those created by a specified entity.
*)}Represents the input of a ListActionTypes action.
type nonrec action_execution_input = {namespace : action_namespace option;The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
*)input_artifacts : artifact_detail_list option;Details of input artifacts of the action that correspond to the action execution.
*)region : aws_region_name option;The Amazon Web Services Region for the action, such as us-east-1.
*)role_arn : role_arn option;The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*)resolved_configuration : resolved_action_configuration_map option;Configuration data for an action execution with all variable references replaced with their real values for the execution.
*)configuration : action_configuration_map option;Configuration data for an action execution.
*)action_type_id : action_type_id option;}Input information used for an action execution.
type nonrec action_execution_result = {log_stream_ar_n : log_stream_ar_n option;The Amazon Resource Name (ARN) of the log stream for the action compute.
*)error_details : error_details option;external_execution_url : url option;The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
*)external_execution_summary : external_execution_summary option;The action provider's summary for the action execution.
*)external_execution_id : external_execution_id option;The action provider's external ID for the action execution.
*)}Execution result information, such as the external execution ID.
type nonrec action_execution_output = {output_variables : output_variables_map option;The outputVariables field shows the key-value pairs that were output as part of that execution.
*)execution_result : action_execution_result option;Execution result information listed in the output details for an action execution.
*)output_artifacts : artifact_detail_list option;Details of output artifacts of the action that correspond to the action execution.
*)}Output details listed for an action execution, such as the action execution result.
type nonrec action_execution_detail = {output : action_execution_output option;Output details for the action execution, such as the action execution result.
*)input : action_execution_input option;Input details for the action execution, such as role ARN, Region, and input artifacts.
*)status : action_execution_status option;The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
updated_by : last_updated_by option;The ARN of the user who changed the pipeline execution details.
*)last_update_time : timestamp option;The last update time of the action execution.
*)start_time : timestamp option;The start time of the action execution.
*)action_name : action_name option;The name of the action.
*)stage_name : stage_name option;The name of the stage that contains the action.
*)pipeline_version : pipeline_version option;The version of the pipeline where the action was run.
*)action_execution_id : action_execution_id option;The action execution ID.
*)pipeline_execution_id : pipeline_execution_id option;The pipeline execution ID for the action execution.
*)}Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
type nonrec action_execution_detail_list = action_execution_detail listtype nonrec list_action_executions_output = {next_token : next_token option;If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.
action_execution_details : action_execution_detail_list option;The details for a list of recent executions, such as action execution ID.
*)}type nonrec action_execution_filter = {latest_in_pipeline_execution : latest_in_pipeline_execution_filter option;The latest execution in the pipeline.
Filtering on the latest execution is available for executions run on or after February 08, 2024.
*)pipeline_execution_id : pipeline_execution_id option;The pipeline execution ID used to filter action execution history.
*)}Filter values for the action execution.
type nonrec list_action_executions_input = {next_token : next_token option;The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.
max_results : max_results option;The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.
*)filter : action_execution_filter option;Input information used to filter action execution history.
*)pipeline_name : pipeline_name;The name of the pipeline for which you want to list action execution history.
*)}type nonrec job_details = {account_id : account_id option;The Amazon Web Services account ID associated with the job.
*)data : job_data option;Represents other information about a job required for a job worker to complete the job.
*)id : job_id option;The unique system-generated ID of the job.
*)}Represents information about the details of a job.
type nonrec invalid_nonce_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The nonce was specified in an invalid format.
type nonrec invalid_job_exception = {message : message option;The message provided to the user in the event of an exception.
*)}The job was specified in an invalid format or cannot be found.
type nonrec get_third_party_job_details_output = {job_details : third_party_job_details option;The details of the job, including any protected values defined for the job.
*)}Represents the output of a GetThirdPartyJobDetails action.
type nonrec get_third_party_job_details_input = {client_token : client_token;The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*)job_id : third_party_job_id;The unique system-generated ID used for identifying the job.
*)}Represents the input of a GetThirdPartyJobDetails action.
type nonrec get_pipeline_state_output = {updated : timestamp option;The date and time the pipeline was last updated, in timestamp format.
*)created : timestamp option;The date and time the pipeline was created, in timestamp format.
*)stage_states : stage_state_list option;A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
*)pipeline_version : pipeline_version option;The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1.
pipeline_name : pipeline_name option;The name of the pipeline for which you want to get the state.
*)}Represents the output of a GetPipelineState action.
type nonrec get_pipeline_state_input = {name : pipeline_name;The name of the pipeline about which you want to get information.
*)}Represents the input of a GetPipelineState action.
type nonrec get_pipeline_output = {metadata : pipeline_metadata option;Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
pipeline : pipeline_declaration option;Represents the structure of actions and stages to be performed in the pipeline.
*)}Represents the output of a GetPipeline action.
type nonrec get_pipeline_input = {version : pipeline_version option;The version number of the pipeline. If you do not specify a version, defaults to the current version.
*)name : pipeline_name;The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.
*)}Represents the input of a GetPipeline action.
type nonrec get_pipeline_execution_output = {pipeline_execution : pipeline_execution option;Represents information about the execution of a pipeline.
*)}Represents the output of a GetPipelineExecution action.
type nonrec get_pipeline_execution_input = {pipeline_execution_id : pipeline_execution_id;The ID of the pipeline execution about which you want to get execution details.
*)pipeline_name : pipeline_name;The name of the pipeline about which you want to get execution details.
*)}Represents the input of a GetPipelineExecution action.
type nonrec get_job_details_output = {job_details : job_details option;The details of the job.
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
}Represents the output of a GetJobDetails action.
type nonrec get_job_details_input = {job_id : job_id;The unique system-generated ID for the job.
*)}Represents the input of a GetJobDetails action.
type nonrec get_action_type_output = {action_type : action_type_declaration option;The action type information for the requested action type, such as the action type ID.
*)}type nonrec get_action_type_input = {version : version;A string that describes the action type version.
*)provider : action_provider;The provider of the action type being called. The provider name is specified when the action type is created.
*)owner : action_type_owner;The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty.
category : action_category;Defines what kind of action can be taken in the stage. The following are the valid values:
SourceBuildTestDeployApprovalInvokeCompute}type nonrec enable_stage_transition_input = {transition_type : stage_transition_type;Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
*)stage_name : stage_name;The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
*)pipeline_name : pipeline_name;The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
*)}Represents the input of an EnableStageTransition action.
type nonrec disable_stage_transition_input = {reason : disabled_reason;The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
*)transition_type : stage_transition_type;Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
*)stage_name : stage_name;The name of the stage where you want to disable the inbound or outbound transition of artifacts.
*)pipeline_name : pipeline_name;The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
*)}Represents the input of a DisableStageTransition action.
type nonrec deregister_webhook_with_third_party_input = {webhook_name : webhook_name option;The name of the webhook you want to deregister.
*)}type nonrec delete_webhook_input = {name : webhook_name;The name of the webhook you want to delete.
*)}type nonrec delete_pipeline_input = {name : pipeline_name;The name of the pipeline to be deleted.
*)}Represents the input of a DeletePipeline action.
type nonrec delete_custom_action_type_input = {version : version;The version of the custom action to delete.
*)provider : action_provider;The provider of the service used in the custom action, such as CodeDeploy.
*)category : action_category;The category of the custom action that you want to delete, such as source or deploy.
*)}Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
type nonrec create_pipeline_output = {pipeline : pipeline_declaration option;Represents the structure of actions and stages to be performed in the pipeline.
*)}Represents the output of a CreatePipeline action.
type nonrec create_pipeline_input = {pipeline : pipeline_declaration;Represents the structure of actions and stages to be performed in the pipeline.
*)}Represents the input of a CreatePipeline action.
type nonrec create_custom_action_type_output = {action_type : action_type;Returns information about the details of an action type.
*)}Represents the output of a CreateCustomActionType operation.
type nonrec create_custom_action_type_input = {output_artifact_details : artifact_details;The details of the output artifact of the action, such as its commit ID.
*)input_artifact_details : artifact_details;The details of the input artifact for the action, such as its commit ID.
*)configuration_properties : action_configuration_property_list option;The configuration properties for the custom action.
You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
*)settings : action_type_settings option;URLs that provide users information about this custom action.
*)version : version;The version identifier of the custom action.
*)provider : action_provider;The provider of the service used in the custom action, such as CodeDeploy.
*)category : action_category;The category of the custom action, such as a build action or a test action.
*)}Represents the input of a CreateCustomActionType operation.
type nonrec acknowledge_third_party_job_output = {status : job_status option;The status information for the third party job, if any.
*)}Represents the output of an AcknowledgeThirdPartyJob action.
type nonrec acknowledge_third_party_job_input = {client_token : client_token;The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*)nonce : nonce;A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
job_id : third_party_job_id;The unique system-generated ID of the job.
*)}Represents the input of an AcknowledgeThirdPartyJob action.
type nonrec acknowledge_job_output = {status : job_status option;Whether the job worker has received the specified job.
*)}Represents the output of an AcknowledgeJob action.
type nonrec acknowledge_job_input = {nonce : nonce;A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
job_id : job_id;The unique system-generated ID of the job for which you want to confirm receipt.
*)}Represents the input of an AcknowledgeJob action.