Overview
This is the CodePipeline API Reference. This guide provides descriptions of the actions and data types for CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the CodePipeline User Guide.
You can use the CodePipeline API to work with pipelines, stages, actions, and transitions.
Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.
You can work with pipelines by calling:
CreatePipeline, which creates a uniquely named pipeline.
DeletePipeline, which deletes the specified pipeline.
GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).
GetPipelineExecution, which returns information about a specific execution of a pipeline.
GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.
ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.
ListPipelines, which gets a summary of all of the pipelines associated with your account.
ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
StopPipelineExecution, which stops the specified pipeline execution from continuing through the pipeline.
UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.
Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see CodePipeline Pipeline Structure Reference.
Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:
Source
Build
Test
Deploy
Approval
Invoke
Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.
You can work with transitions by calling:
DisableStageTransition, which prevents artifacts from transitioning to the next stage in a pipeline.
EnableStageTransition, which enables transition of artifacts between stages in a pipeline.
Using the API to integrate with CodePipeline
For third-party integrators or developers who want to create their own integrations with CodePipeline, the expected sequence varies from the standard API user. To integrate with CodePipeline, developers need to work with the following items:
Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.
You can work with jobs by calling:
AcknowledgeJob, which confirms whether a job worker has received the specified job.
GetJobDetails, which returns the details of a job.
PollForJobs, which determines whether there are any jobs to act on.
PutJobFailureResult, which provides details of a job failure.
PutJobSuccessResult, which provides details of a job success.
Third party jobs, which are instances of an action created by a partner action and integrated into CodePipeline. Partner actions are created by members of the Amazon Web Services Partner Network.
You can work with third party jobs by calling:
AcknowledgeThirdPartyJob, which confirms whether a job worker has received the specified job.
GetThirdPartyJobDetails, which requests the details of a job for a partner action.
PollForThirdPartyJobs, which determines whether there are any jobs to act on.
PutThirdPartyJobFailureResult, which provides details of a job failure.
PutThirdPartyJobSuccessResult, which provides details of a job success.
Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
', 'AcknowledgeThirdPartyJob' => 'Confirms a job worker has received the specified job. Used for partner actions only.
', 'CreateCustomActionType' => 'Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
', 'CreatePipeline' => 'Creates a pipeline.
In the pipeline structure, 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.
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
Deletes the specified pipeline.
', 'DeleteWebhook' => 'Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
', 'DeregisterWebhookWithThirdParty' => 'Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
', 'DisableStageTransition' => 'Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
', 'EnableStageTransition' => 'Enables artifacts in a pipeline to transition to a stage in a pipeline.
', 'GetActionType' => 'Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
', 'GetJobDetails' => 'Returns information about a job. Used for custom actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
', 'GetPipelineExecution' => 'Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
', 'GetPipelineState' => 'Returns information about the state of a pipeline, including the stages and actions.
Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
Requests the details of a job for a third party action. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Lists the action executions that have occurred in a pipeline.
', 'ListActionTypes' => 'Gets a summary of all CodePipeline action types associated with your account.
', 'ListPipelineExecutions' => 'Gets a summary of the most recent executions for a pipeline.
', 'ListPipelines' => 'Gets a summary of all of the pipelines associated with your account.
', 'ListTagsForResource' => 'Gets the set of key-value pairs (metadata) that are used to manage the resource.
', 'ListWebhooks' => 'Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
', 'PollForJobs' => 'Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
Provides information to CodePipeline about new revisions to a source.
', 'PutApprovalResult' => 'Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
', 'PutJobFailureResult' => 'Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
', 'PutJobSuccessResult' => 'Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
', 'PutThirdPartyJobFailureResult' => 'Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
', 'PutThirdPartyJobSuccessResult' => 'Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
', 'PutWebhook' => 'Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there\'s a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
', 'RegisterWebhookWithThirdParty' => 'Configures a connection between the webhook that was created and the external tool with events to be detected.
', 'RetryStageExecution' => 'Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
', 'StartPipelineExecution' => 'Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
', 'StopPipelineExecution' => 'Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
', 'UntagResource' => 'Removes tags from an Amazon Web Services resource.
', 'UpdateActionType' => 'Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and UpdateActionType to provide the full structure.
Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
The action declaration\'s Amazon Web Services Region, such as us-east-1.
', 'ActionExecutionInput$region' => 'The Amazon Web Services Region for the action, such as us-east-1.
', 'ArtifactStoreMap$key' => NULL, 'ListActionTypesInput$regionFilter' => 'The Region to filter on for the list of action types.
', ], ], 'AWSSessionCredentials' => [ 'base' => '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.
', 'refs' => [ 'JobData$artifactCredentials' => '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.
', 'ThirdPartyJobData$artifactCredentials' => '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.
', ], ], 'AccessKeyId' => [ 'base' => NULL, 'refs' => [ 'AWSSessionCredentials$accessKeyId' => 'The access key for the session.
', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'Job$accountId' => 'The ID of the Amazon Web Services account to use when performing the job.
', 'JobDetails$accountId' => 'The Amazon Web Services account ID associated with the job.
', 'PollingAccountList$member' => NULL, ], ], 'AcknowledgeJobInput' => [ 'base' => 'Represents the input of an AcknowledgeJob action.
', 'refs' => [], ], 'AcknowledgeJobOutput' => [ 'base' => 'Represents the output of an AcknowledgeJob action.
', 'refs' => [], ], 'AcknowledgeThirdPartyJobInput' => [ 'base' => 'Represents the input of an AcknowledgeThirdPartyJob action.
', 'refs' => [], ], 'AcknowledgeThirdPartyJobOutput' => [ 'base' => 'Represents the output of an AcknowledgeThirdPartyJob action.
', 'refs' => [], ], 'ActionCategory' => [ 'base' => NULL, 'refs' => [ 'ActionTypeId$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.
Source
Build
Test
Deploy
Invoke
Approval
Defines what kind of action can be taken in the stage, one of the following:
Source
Build
Test
Deploy
Approval
Invoke
The category of the custom action, such as a build action or a test action.
', 'DeleteCustomActionTypeInput$category' => 'The category of the custom action that you want to delete, such as source or deploy.
', 'GetActionTypeInput$category' => 'Defines what kind of action can be taken in the stage. The following are the valid values:
Source
Build
Test
Deploy
Approval
Invoke
Represents information about an action configuration.
', 'refs' => [ 'JobData$actionConfiguration' => 'Represents information about an action configuration.
', 'ThirdPartyJobData$actionConfiguration' => 'Represents information about an action configuration.
', ], ], 'ActionConfigurationKey' => [ 'base' => NULL, 'refs' => [ 'ActionConfigurationMap$key' => NULL, 'ActionConfigurationProperty$name' => 'The name of the action configuration property.
', 'ActionTypeProperty$name' => 'The property name that is displayed to users.
', 'QueryParamMap$key' => NULL, ], ], 'ActionConfigurationMap' => [ 'base' => NULL, 'refs' => [ 'ActionConfiguration$configuration' => 'The configuration data for the action.
', 'ActionDeclaration$configuration' => '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 },
Configuration data for an action execution.
', ], ], 'ActionConfigurationProperty' => [ 'base' => 'Represents information about an action configuration property.
', 'refs' => [ 'ActionConfigurationPropertyList$member' => NULL, ], ], 'ActionConfigurationPropertyList' => [ 'base' => NULL, 'refs' => [ 'ActionType$actionConfigurationProperties' => 'The configuration properties for the action type.
', 'CreateCustomActionTypeInput$configurationProperties' => '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.
The type of the configuration property.
', ], ], 'ActionConfigurationQueryableValue' => [ 'base' => NULL, 'refs' => [ 'QueryParamMap$value' => NULL, ], ], 'ActionConfigurationValue' => [ 'base' => NULL, 'refs' => [ 'ActionConfigurationMap$value' => NULL, ], ], 'ActionContext' => [ 'base' => 'Represents the context of an action in the stage of a pipeline to a job worker.
', 'refs' => [ 'PipelineContext$action' => 'The context of an action to a job worker in the stage of a pipeline.
', ], ], 'ActionDeclaration' => [ 'base' => 'Represents information about an action declaration.
', 'refs' => [ 'StageActionDeclarationList$member' => NULL, ], ], 'ActionExecution' => [ 'base' => 'Represents information about the run of an action.
', 'refs' => [ 'ActionState$latestExecution' => 'Represents information about the run of an action.
', ], ], 'ActionExecutionDetail' => [ 'base' => 'Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.
', 'refs' => [ 'ActionExecutionDetailList$member' => NULL, ], ], 'ActionExecutionDetailList' => [ 'base' => NULL, 'refs' => [ 'ListActionExecutionsOutput$actionExecutionDetails' => 'The details for a list of recent executions, such as action execution ID.
', ], ], 'ActionExecutionFilter' => [ 'base' => 'Filter values for the action execution.
', 'refs' => [ 'ListActionExecutionsInput$filter' => 'Input information used to filter action execution history.
', ], ], 'ActionExecutionId' => [ 'base' => NULL, 'refs' => [ 'ActionContext$actionExecutionId' => 'The system-generated unique ID that corresponds to an action\'s execution.
', 'ActionExecution$actionExecutionId' => '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.
The action execution ID.
', ], ], 'ActionExecutionInput' => [ 'base' => 'Input information used for an action execution.
', 'refs' => [ 'ActionExecutionDetail$input' => 'Input details for the action execution, such as role ARN, Region, and input artifacts.
', ], ], 'ActionExecutionOutput' => [ 'base' => 'Output details listed for an action execution, such as the action execution result.
', 'refs' => [ 'ActionExecutionDetail$output' => 'Output details for the action execution, such as the action execution result.
', ], ], 'ActionExecutionResult' => [ 'base' => 'Execution result information, such as the external execution ID.
', 'refs' => [ 'ActionExecutionOutput$executionResult' => 'Execution result information listed in the output details for an action execution.
', ], ], 'ActionExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$status' => 'The status of the action, or for a completed action, the last status of the action.
', 'ActionExecutionDetail$status' => ' The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
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.
The name of the action in the context of a job.
', 'ActionDeclaration$name' => 'The action declaration\'s name.
', 'ActionExecutionDetail$actionName' => 'The name of the action.
', 'ActionState$actionName' => 'The name of the action.
', 'PutActionRevisionInput$actionName' => 'The name of the action that processes the revision.
', 'PutApprovalResultInput$actionName' => 'The name of the action for which approval is requested.
', 'SourceRevision$actionName' => 'The name of the action that processed the revision to the source artifact.
', 'WebhookDefinition$targetAction' => '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.
', ], ], 'ActionNamespace' => [ 'base' => NULL, 'refs' => [ 'ActionDeclaration$namespace' => 'The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
', 'ActionExecutionInput$namespace' => 'The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
', ], ], 'ActionNotFoundException' => [ 'base' => 'The specified action cannot be found.
', 'refs' => [], ], 'ActionOwner' => [ 'base' => NULL, 'refs' => [ 'ActionTypeId$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.
Filters the list of action types to those created by a specified entity.
', ], ], 'ActionProvider' => [ 'base' => NULL, 'refs' => [ 'ActionTypeId$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.
The provider of the action type being called. The provider name is supplied when the action type is created.
', 'CreateCustomActionTypeInput$provider' => 'The provider of the service used in the custom action, such as CodeDeploy.
', 'DeleteCustomActionTypeInput$provider' => 'The provider of the service used in the custom action, such as CodeDeploy.
', 'GetActionTypeInput$provider' => 'The provider of the action type being called. The provider name is specified when the action type is created.
', ], ], 'ActionRevision' => [ 'base' => 'Represents information about the version (or revision) of an action.
', 'refs' => [ 'ActionState$currentRevision' => 'Represents information about the version (or revision) of an action.
', 'PutActionRevisionInput$actionRevision' => 'Represents information about the version (or revision) of an action.
', ], ], 'ActionRunOrder' => [ 'base' => NULL, 'refs' => [ 'ActionDeclaration$runOrder' => 'The order in which actions are run.
', ], ], 'ActionState' => [ 'base' => 'Represents information about the state of an action.
', 'refs' => [ 'ActionStateList$member' => NULL, ], ], 'ActionStateList' => [ 'base' => NULL, 'refs' => [ 'StageState$actionStates' => 'The state of the stage.
', ], ], 'ActionType' => [ 'base' => 'Returns information about the details of an action type.
', 'refs' => [ 'ActionTypeList$member' => NULL, 'CreateCustomActionTypeOutput$actionType' => 'Returns information about the details of an action type.
', ], ], 'ActionTypeAlreadyExistsException' => [ 'base' => 'The specified action type already exists with a different definition.
', 'refs' => [], ], 'ActionTypeArtifactDetails' => [ 'base' => 'Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.
', 'refs' => [ 'ActionTypeDeclaration$inputArtifactDetails' => '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.
', 'ActionTypeDeclaration$outputArtifactDetails' => '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.
', ], ], 'ActionTypeDeclaration' => [ 'base' => 'The parameters for the action type definition that are provided when the action type is created or updated.
', 'refs' => [ 'GetActionTypeOutput$actionType' => 'The action type information for the requested action type, such as the action type ID.
', 'UpdateActionTypeInput$actionType' => 'The action type definition for the action type to be updated.
', ], ], 'ActionTypeDescription' => [ 'base' => NULL, 'refs' => [ 'ActionTypeDeclaration$description' => 'The description for the action type to be updated.
', ], ], 'ActionTypeExecutor' => [ 'base' => '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.
', 'refs' => [ 'ActionTypeDeclaration$executor' => 'Information about the executor for an action type that was created with any supported integration model.
', ], ], 'ActionTypeId' => [ 'base' => 'Represents information about an action type.
', 'refs' => [ 'ActionDeclaration$actionTypeId' => 'Specifies the action type and the provider of the action.
', 'ActionExecutionInput$actionTypeId' => NULL, 'ActionType$id' => 'Represents information about an action type.
', 'JobData$actionTypeId' => 'Represents information about an action type.
', 'PollForJobsInput$actionTypeId' => 'Represents information about an action type.
', 'PollForThirdPartyJobsInput$actionTypeId' => 'Represents information about an action type.
', 'ThirdPartyJobData$actionTypeId' => 'Represents information about an action type.
', ], ], 'ActionTypeIdentifier' => [ 'base' => 'Specifies the category, owner, provider, and version of the action type.
', 'refs' => [ 'ActionTypeDeclaration$id' => 'The action category, owner, provider, and version of the action type to be updated.
', ], ], 'ActionTypeList' => [ 'base' => NULL, 'refs' => [ 'ListActionTypesOutput$actionTypes' => 'Provides details of the action types.
', ], ], 'ActionTypeNotFoundException' => [ 'base' => 'The specified action type cannot be found.
', 'refs' => [], ], 'ActionTypeOwner' => [ 'base' => NULL, 'refs' => [ 'ActionTypeIdentifier$owner' => 'The creator of the action type being called: AWS or ThirdParty.
The creator of an action type that was created with any supported integration model. There are two valid values: AWS and ThirdParty.
Details identifying the users with permissions to use the action type.
', 'refs' => [ 'ActionTypeDeclaration$permissions' => 'Details identifying the accounts with permissions to use the action type.
', ], ], 'ActionTypeProperties' => [ 'base' => NULL, 'refs' => [ 'ActionTypeDeclaration$properties' => 'The properties of the action type to be updated.
', ], ], 'ActionTypeProperty' => [ 'base' => '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.
', 'refs' => [ 'ActionTypeProperties$member' => NULL, ], ], 'ActionTypeSettings' => [ 'base' => 'Returns information about the settings for an action type.
', 'refs' => [ 'ActionType$settings' => 'The settings for the action type.
', 'CreateCustomActionTypeInput$settings' => 'URLs that provide users information about this custom action.
', ], ], 'ActionTypeUrls' => [ 'base' => '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.
', 'refs' => [ 'ActionTypeDeclaration$urls' => 'The links associated with the action type to be updated.
', ], ], 'AllowedAccount' => [ 'base' => NULL, 'refs' => [ 'AllowedAccounts$member' => NULL, ], ], 'AllowedAccounts' => [ 'base' => NULL, 'refs' => [ 'ActionTypePermissions$allowedAccounts' => 'A list of Amazon Web Services account IDs with access to use the action type in their pipelines.
', ], ], 'ApprovalAlreadyCompletedException' => [ 'base' => 'The approval action has already been approved or rejected.
', 'refs' => [], ], 'ApprovalResult' => [ 'base' => 'Represents information about the result of an approval request.
', 'refs' => [ 'PutApprovalResultInput$result' => 'Represents information about the result of the approval request.
', ], ], 'ApprovalStatus' => [ 'base' => NULL, 'refs' => [ 'ApprovalResult$status' => 'The response submitted by a reviewer assigned to an approval action request.
', ], ], 'ApprovalSummary' => [ 'base' => NULL, 'refs' => [ 'ApprovalResult$summary' => 'The summary of the current status of the approval request.
', ], ], 'ApprovalToken' => [ 'base' => NULL, 'refs' => [ 'PutApprovalResultInput$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.
', ], ], 'Artifact' => [ 'base' => '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
', 'refs' => [ 'ArtifactList$member' => NULL, ], ], 'ArtifactDetail' => [ 'base' => 'Artifact details for the action execution, such as the artifact location.
', 'refs' => [ 'ArtifactDetailList$member' => NULL, ], ], 'ArtifactDetailList' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionInput$inputArtifacts' => 'Details of input artifacts of the action that correspond to the action execution.
', 'ActionExecutionOutput$outputArtifacts' => 'Details of output artifacts of the action that correspond to the action execution.
', ], ], 'ArtifactDetails' => [ 'base' => 'Returns information about the details of an artifact.
', 'refs' => [ 'ActionType$inputArtifactDetails' => 'The details of the input artifact for the action, such as its commit ID.
', 'ActionType$outputArtifactDetails' => 'The details of the output artifact of the action, such as its commit ID.
', 'CreateCustomActionTypeInput$inputArtifactDetails' => 'The details of the input artifact for the action, such as its commit ID.
', 'CreateCustomActionTypeInput$outputArtifactDetails' => 'The details of the output artifact of the action, such as its commit ID.
', ], ], 'ArtifactList' => [ 'base' => NULL, 'refs' => [ 'JobData$inputArtifacts' => 'The artifact supplied to the job.
', 'JobData$outputArtifacts' => 'The output of the job.
', 'ThirdPartyJobData$inputArtifacts' => '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.
', 'ThirdPartyJobData$outputArtifacts' => '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.
', ], ], 'ArtifactLocation' => [ 'base' => 'Represents information about the location of an artifact.
', 'refs' => [ 'Artifact$location' => 'The location of an artifact.
', ], ], 'ArtifactLocationType' => [ 'base' => NULL, 'refs' => [ 'ArtifactLocation$type' => 'The type of artifact in the location.
', ], ], 'ArtifactName' => [ 'base' => NULL, 'refs' => [ 'Artifact$name' => 'The artifact\'s name.
', 'ArtifactDetail$name' => 'The artifact object name for the action execution.
', 'ArtifactRevision$name' => 'The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
', 'InputArtifact$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.
', 'OutputArtifact$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.
', ], ], 'ArtifactRevision' => [ 'base' => 'Represents revision details of an artifact.
', 'refs' => [ 'ArtifactRevisionList$member' => NULL, ], ], 'ArtifactRevisionList' => [ 'base' => NULL, 'refs' => [ 'PipelineExecution$artifactRevisions' => 'A list of ArtifactRevision objects included in a pipeline execution.
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.
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.
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.
', ], ], 'ArtifactStoreMap' => [ 'base' => NULL, 'refs' => [ 'PipelineDeclaration$artifactStores' => '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.
The type of the artifact store, such as S3.
', ], ], 'BlockerDeclaration' => [ 'base' => 'Reserved for future use.
', 'refs' => [ 'StageBlockerDeclarationList$member' => NULL, ], ], 'BlockerName' => [ 'base' => NULL, 'refs' => [ 'BlockerDeclaration$name' => 'Reserved for future use.
', ], ], 'BlockerType' => [ 'base' => NULL, 'refs' => [ 'BlockerDeclaration$type' => 'Reserved for future use.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ActionConfigurationProperty$required' => 'Whether the configuration property is a required value.
', 'ActionConfigurationProperty$key' => 'Whether the configuration property is a key.
', 'ActionConfigurationProperty$secret' => '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.
', 'ActionConfigurationProperty$queryable' => '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.
', 'ActionTypeProperty$optional' => 'Whether the configuration property is an optional value.
', 'ActionTypeProperty$key' => 'Whether the configuration property is a key.
', 'ActionTypeProperty$noEcho' => '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.
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.
', 'PutActionRevisionOutput$newRevision' => 'Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
', 'StopPipelineExecutionInput$abandon' => '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.
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.
The system-generated unique ID used to identify a unique execution request.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'AcknowledgeThirdPartyJobInput$clientToken' => '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.
', 'GetThirdPartyJobDetailsInput$clientToken' => '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.
', 'PutThirdPartyJobFailureResultInput$clientToken' => '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.
', 'PutThirdPartyJobSuccessResultInput$clientToken' => '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.
', ], ], 'Code' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$code' => 'The system ID or number code of the error.
', ], ], 'ConcurrentModificationException' => [ 'base' => 'Unable to modify the tag due to a simultaneous update request.
', 'refs' => [], ], 'ConflictException' => [ 'base' => 'Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.
', 'refs' => [], ], 'ContinuationToken' => [ 'base' => NULL, 'refs' => [ 'JobData$continuationToken' => 'A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
', 'PutJobSuccessResultInput$continuationToken' => '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.
', 'PutThirdPartyJobSuccessResultInput$continuationToken' => '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.
', 'ThirdPartyJobData$continuationToken' => 'A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
', ], ], 'CreateCustomActionTypeInput' => [ 'base' => 'Represents the input of a CreateCustomActionType operation.
', 'refs' => [], ], 'CreateCustomActionTypeOutput' => [ 'base' => 'Represents the output of a CreateCustomActionType operation.
Represents the input of a CreatePipeline action.
Represents the output of a CreatePipeline action.
Represents information about a current revision.
', 'refs' => [ 'PutJobSuccessResultInput$currentRevision' => 'The ID of the current revision of the artifact successfully worked on by the job.
', 'PutThirdPartyJobSuccessResultInput$currentRevision' => 'Represents information about a current revision.
', ], ], 'DeleteCustomActionTypeInput' => [ 'base' => 'Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.
Represents the input of a DeletePipeline action.
The description of the action configuration property that is displayed to users.
', ], ], 'DisableStageTransitionInput' => [ 'base' => 'Represents the input of a DisableStageTransition action.
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.
', 'TransitionState$disabledReason' => 'The user-specified reason why the transition between two stages of a pipeline was disabled.
', ], ], 'DuplicatedStopRequestException' => [ 'base' => '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.
Represents the input of an EnableStageTransition action.
Whether the transition between stages is enabled (true) or disabled (false).
', ], ], 'EncryptionKey' => [ 'base' => '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.
', 'refs' => [ 'ArtifactStore$encryptionKey' => '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.
', 'JobData$encryptionKey' => 'Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
', 'ThirdPartyJobData$encryptionKey' => '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.
', ], ], 'EncryptionKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionKey$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).
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\'.
', ], ], 'ErrorDetails' => [ 'base' => 'Represents information about an error in CodePipeline.
', 'refs' => [ 'ActionExecution$errorDetails' => 'The details of an error returned by a URL external to Amazon Web Services.
', ], ], 'ExecutionDetails' => [ 'base' => 'The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
', 'refs' => [ 'PutJobSuccessResultInput$executionDetails' => 'The execution details of the successful job, such as the actions taken by the job worker.
', 'PutThirdPartyJobSuccessResultInput$executionDetails' => 'The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
', ], ], 'ExecutionId' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$externalExecutionId' => 'The external ID of the run of the action.
', 'ExecutionDetails$externalExecutionId' => 'The system-generated unique ID of this action used to identify this job worker in any external systems, such as CodeDeploy.
', 'FailureDetails$externalExecutionId' => 'The external ID of the run of the action that failed.
', ], ], 'ExecutionSummary' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$summary' => 'A summary of the run of the action.
', 'ExecutionDetails$summary' => 'The summary of the current status of the actions.
', ], ], 'ExecutionTrigger' => [ 'base' => 'The interaction or event that started a pipeline execution.
', 'refs' => [ 'PipelineExecutionSummary$trigger' => 'The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
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.
The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.
', ], ], 'ExecutorType' => [ 'base' => NULL, 'refs' => [ 'ActionTypeExecutor$type' => 'The integration model used to create and update the action type, Lambda or JobWorker.
The action provider\'s external ID for the action execution.
', ], ], 'ExternalExecutionSummary' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionResult$externalExecutionSummary' => 'The action provider\'s summary for the action execution.
', ], ], 'FailureDetails' => [ 'base' => 'Represents information about failure details.
', 'refs' => [ 'PutJobFailureResultInput$failureDetails' => 'The details about the failure of a job.
', 'PutThirdPartyJobFailureResultInput$failureDetails' => 'Represents information about failure details.
', ], ], 'FailureType' => [ 'base' => NULL, 'refs' => [ 'FailureDetails$type' => 'The type of the failure.
', ], ], 'GetActionTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'GetActionTypeOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetJobDetailsInput' => [ 'base' => 'Represents the input of a GetJobDetails action.
Represents the output of a GetJobDetails action.
Represents the input of a GetPipelineExecution action.
Represents the output of a GetPipelineExecution action.
Represents the input of a GetPipeline action.
Represents the output of a GetPipeline action.
Represents the input of a GetPipelineState action.
Represents the output of a GetPipelineState action.
Represents the input of a GetThirdPartyJobDetails action.
Represents the output of a GetThirdPartyJobDetails action.
Represents information about an artifact to be worked on, such as a test or build artifact.
', 'refs' => [ 'InputArtifactList$member' => NULL, ], ], 'InputArtifactList' => [ 'base' => NULL, 'refs' => [ 'ActionDeclaration$inputArtifacts' => 'The name or ID of the artifact consumed by the action, such as a test or build artifact.
', ], ], 'InvalidActionDeclarationException' => [ 'base' => 'The action declaration was specified in an invalid format.
', 'refs' => [], ], 'InvalidApprovalTokenException' => [ 'base' => 'The approval request already received a response or has expired.
', 'refs' => [], ], 'InvalidArnException' => [ 'base' => 'The specified resource ARN is invalid.
', 'refs' => [], ], 'InvalidBlockerDeclarationException' => [ 'base' => 'Reserved for future use.
', 'refs' => [], ], 'InvalidClientTokenException' => [ 'base' => 'The client token was specified in an invalid format
', 'refs' => [], ], 'InvalidJobException' => [ 'base' => 'The job was specified in an invalid format or cannot be found.
', 'refs' => [], ], 'InvalidJobStateException' => [ 'base' => 'The job state was specified in an invalid format.
', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => '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.
', 'refs' => [], ], 'InvalidNonceException' => [ 'base' => 'The nonce was specified in an invalid format.
', 'refs' => [], ], 'InvalidStageDeclarationException' => [ 'base' => 'The stage declaration was specified in an invalid format.
', 'refs' => [], ], 'InvalidStructureException' => [ 'base' => 'The structure was specified in an invalid format.
', 'refs' => [], ], 'InvalidTagsException' => [ 'base' => 'The specified resource tags are invalid.
', 'refs' => [], ], 'InvalidWebhookAuthenticationParametersException' => [ 'base' => 'The specified authentication type is in an invalid format.
', 'refs' => [], ], 'InvalidWebhookFilterPatternException' => [ 'base' => 'The specified event filter rule is in an invalid format.
', 'refs' => [], ], 'Job' => [ 'base' => 'Represents information about a job.
', 'refs' => [ 'JobList$member' => NULL, ], ], 'JobData' => [ 'base' => 'Represents other information about a job required for a job worker to complete the job.
', 'refs' => [ 'Job$data' => 'Other data about a job.
', 'JobDetails$data' => 'Represents other information about a job required for a job worker to complete the job.
', ], ], 'JobDetails' => [ 'base' => 'Represents information about the details of a job.
', 'refs' => [ 'GetJobDetailsOutput$jobDetails' => 'The details of the job.
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
The unique system-generated ID of the job for which you want to confirm receipt.
', 'GetJobDetailsInput$jobId' => 'The unique system-generated ID for the job.
', 'Job$id' => 'The unique system-generated ID of the job.
', 'JobDetails$id' => 'The unique system-generated ID of the job.
', 'PutJobFailureResultInput$jobId' => 'The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
The identifier used to identify the job in CodePipeline.
', ], ], 'JobList' => [ 'base' => NULL, 'refs' => [ 'PollForJobsOutput$jobs' => 'Information about the jobs to take action on.
', ], ], 'JobNotFoundException' => [ 'base' => 'The job was specified in an invalid format or cannot be found.
', 'refs' => [], ], 'JobStatus' => [ 'base' => NULL, 'refs' => [ 'AcknowledgeJobOutput$status' => 'Whether the job worker has received the specified job.
', 'AcknowledgeThirdPartyJobOutput$status' => 'The status information for the third party job, if any.
', ], ], 'JobTimeout' => [ 'base' => NULL, 'refs' => [ 'ActionTypeExecutor$jobTimeout' => '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.
', ], ], 'JobWorkerExecutorConfiguration' => [ 'base' => 'Details about the polling configuration for the JobWorker action engine, or executor.
Details about the JobWorker executor of the action type.
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.
Details about the configuration for the Lambda action engine, or executor.
Details about the Lambda executor of the action type.
The ARN of the Lambda function used by the action engine.
', ], ], 'LastChangedAt' => [ 'base' => NULL, 'refs' => [ 'TransitionState$lastChangedAt' => 'The timestamp when the transition state was last changed.
', ], ], 'LastChangedBy' => [ 'base' => NULL, 'refs' => [ 'TransitionState$lastChangedBy' => 'The ID of the user who last changed the transition state.
', ], ], 'LastUpdatedBy' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$lastUpdatedBy' => 'The ARN of the user who last changed the pipeline.
', ], ], 'LimitExceededException' => [ 'base' => 'The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
', 'refs' => [], ], 'ListActionExecutionsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListActionExecutionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListActionTypesInput' => [ 'base' => 'Represents the input of a ListActionTypes action.
Represents the output of a ListActionTypes action.
Represents the input of a ListPipelineExecutions action.
Represents the output of a ListPipelineExecutions action.
Represents the input of a ListPipelines action.
Represents the output of a ListPipelines action.
The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.
', 'refs' => [ 'PutWebhookOutput$webhook' => 'The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
', 'WebhookList$member' => NULL, ], ], 'ListWebhooksInput' => [ 'base' => NULL, 'refs' => [], ], 'ListWebhooksOutput' => [ 'base' => NULL, 'refs' => [], ], 'MatchEquals' => [ 'base' => NULL, 'refs' => [ 'WebhookFilterRule$matchEquals' => '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.
The maximum number of jobs to return in a poll for jobs call.
', 'PollForThirdPartyJobsInput$maxBatchSize' => 'The maximum number of jobs to return in a poll for jobs call.
', ], ], 'MaxPipelines' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesInput$maxResults' => '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.
', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListActionExecutionsInput$maxResults' => '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.
Detailed execution history is available for executions run on or after February 21, 2019.
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.
', 'ListTagsForResourceInput$maxResults' => 'The maximum number of results to return in a single call.
', 'ListWebhooksInput$MaxResults' => 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
', ], ], 'MaximumActionTypeArtifactCount' => [ 'base' => NULL, 'refs' => [ 'ActionTypeArtifactDetails$maximumCount' => '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.
The maximum number of artifacts allowed for the action type.
', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ConcurrentModificationException$message' => NULL, 'ConflictException$message' => NULL, 'DuplicatedStopRequestException$message' => NULL, 'ErrorDetails$message' => 'The text of the error message.
', 'FailureDetails$message' => 'The message about the failure.
', 'InvalidArnException$message' => NULL, 'InvalidTagsException$message' => NULL, 'OutputVariablesSizeExceededException$message' => NULL, 'PipelineExecutionNotStoppableException$message' => NULL, 'RequestFailedException$message' => NULL, 'TooManyTagsException$message' => NULL, ], ], 'MinimumActionTypeArtifactCount' => [ 'base' => NULL, 'refs' => [ 'ActionTypeArtifactDetails$minimumCount' => '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.
The minimum number of artifacts allowed for the action type.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListActionExecutionsInput$nextToken' => '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.
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.
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.
', 'ListActionTypesOutput$nextToken' => '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.
', 'ListPipelineExecutionsInput$nextToken' => '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.
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.
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.
', 'ListPipelinesOutput$nextToken' => '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.
', 'ListTagsForResourceInput$nextToken' => 'The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
', 'ListTagsForResourceOutput$nextToken' => 'If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
', 'ListWebhooksInput$NextToken' => 'The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
', 'ListWebhooksOutput$NextToken' => '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.
', ], ], 'Nonce' => [ 'base' => NULL, 'refs' => [ 'AcknowledgeJobInput$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.
', 'AcknowledgeThirdPartyJobInput$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$nonce' => '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.
', 'ThirdPartyJobDetails$nonce' => '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.
', ], ], 'NotLatestPipelineExecutionException' => [ 'base' => 'The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.
Represents information about the output of an action.
', 'refs' => [ 'OutputArtifactList$member' => NULL, ], ], 'OutputArtifactList' => [ 'base' => NULL, 'refs' => [ 'ActionDeclaration$outputArtifacts' => 'The name or ID of the result of the action declaration, such as a test or build artifact.
', ], ], 'OutputVariablesKey' => [ 'base' => NULL, 'refs' => [ 'OutputVariablesMap$key' => NULL, ], ], 'OutputVariablesMap' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionOutput$outputVariables' => 'The outputVariables field shows the key-value pairs that were output as part of that execution.
', 'PutJobSuccessResultInput$outputVariables' => '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.
Exceeded the total size limit for all variables in the pipeline.
', 'refs' => [], ], 'OutputVariablesValue' => [ 'base' => NULL, 'refs' => [ 'OutputVariablesMap$value' => NULL, ], ], 'Percentage' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$percentComplete' => 'A percentage of completeness of the action as it runs.
', 'ExecutionDetails$percentComplete' => 'The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
', ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'PipelineContext$pipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', 'PipelineMetadata$pipelineArn' => 'The Amazon Resource Name (ARN) of the pipeline.
', ], ], 'PipelineContext' => [ 'base' => '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.
Represents information about a pipeline to a job worker.
Includes pipelineArn and pipelineExecutionId for custom jobs.
Represents information about a pipeline to a job worker.
Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
Represents the structure of actions and stages to be performed in the pipeline.
', 'refs' => [ 'CreatePipelineInput$pipeline' => 'Represents the structure of actions and stages to be performed in the pipeline.
', 'CreatePipelineOutput$pipeline' => 'Represents the structure of actions and stages to be performed in the pipeline.
', 'GetPipelineOutput$pipeline' => 'Represents the structure of actions and stages to be performed in the pipeline.
', 'UpdatePipelineInput$pipeline' => 'The name of the pipeline to be updated.
', 'UpdatePipelineOutput$pipeline' => 'The structure of the updated pipeline.
', ], ], 'PipelineExecution' => [ 'base' => 'Represents information about an execution of a pipeline.
', 'refs' => [ 'GetPipelineExecutionOutput$pipelineExecution' => 'Represents information about the execution of a pipeline.
', ], ], 'PipelineExecutionId' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionDetail$pipelineExecutionId' => 'The pipeline execution ID for the action execution.
', 'ActionExecutionFilter$pipelineExecutionId' => 'The pipeline execution ID used to filter action execution history.
', 'GetPipelineExecutionInput$pipelineExecutionId' => 'The ID of the pipeline execution about which you want to get execution details.
', 'PipelineContext$pipelineExecutionId' => 'The execution ID of the pipeline.
', 'PipelineExecution$pipelineExecutionId' => 'The ID of the pipeline execution.
', 'PipelineExecutionSummary$pipelineExecutionId' => 'The ID of the pipeline execution.
', 'PutActionRevisionOutput$pipelineExecutionId' => 'The ID of the current workflow state of the pipeline.
', 'RetryStageExecutionInput$pipelineExecutionId' => '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
', 'RetryStageExecutionOutput$pipelineExecutionId' => 'The ID of the current workflow execution in the failed stage.
', 'StageExecution$pipelineExecutionId' => 'The ID of the pipeline execution associated with the stage.
', 'StartPipelineExecutionOutput$pipelineExecutionId' => 'The unique system-generated ID of the pipeline execution that was started.
', 'StopPipelineExecutionInput$pipelineExecutionId' => 'The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
The unique system-generated ID of the pipeline execution that was stopped.
', ], ], 'PipelineExecutionNotFoundException' => [ 'base' => 'The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.
', 'refs' => [], ], 'PipelineExecutionNotStoppableException' => [ 'base' => 'Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.
The status of the pipeline execution.
Cancelled: The pipeline’s definition was updated before the pipeline execution could be completed.
InProgress: The pipeline execution is currently running.
Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
Succeeded: The pipeline execution was completed successfully.
Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
Failed: The pipeline execution was not completed successfully.
The status of the pipeline execution.
InProgress: The pipeline execution is currently running.
Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
Succeeded: The pipeline execution was completed successfully.
Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions.
Failed: The pipeline execution was not completed successfully.
A summary that contains a description of the pipeline execution status.
', ], ], 'PipelineExecutionSummary' => [ 'base' => 'Summary information about a pipeline execution.
', 'refs' => [ 'PipelineExecutionSummaryList$member' => NULL, ], ], 'PipelineExecutionSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineExecutionsOutput$pipelineExecutionSummaries' => 'A list of executions in the history of a pipeline.
', ], ], 'PipelineList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesOutput$pipelines' => 'The list of pipelines.
', ], ], 'PipelineMetadata' => [ 'base' => 'Information about a pipeline.
', 'refs' => [ 'GetPipelineOutput$metadata' => 'Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
The name of the pipeline to be deleted.
', 'DisableStageTransitionInput$pipelineName' => 'The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
', 'EnableStageTransitionInput$pipelineName' => 'The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
', 'GetPipelineExecutionInput$pipelineName' => 'The name of the pipeline about which you want to get execution details.
', 'GetPipelineInput$name' => 'The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.
', 'GetPipelineStateInput$name' => 'The name of the pipeline about which you want to get information.
', 'GetPipelineStateOutput$pipelineName' => 'The name of the pipeline for which you want to get the state.
', 'ListActionExecutionsInput$pipelineName' => 'The name of the pipeline for which you want to list action execution history.
', 'ListPipelineExecutionsInput$pipelineName' => 'The name of the pipeline for which you want to get execution summary information.
', 'PipelineContext$pipelineName' => '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.
', 'PipelineDeclaration$name' => 'The name of the pipeline.
', 'PipelineExecution$pipelineName' => 'The name of the pipeline with the specified pipeline execution.
', 'PipelineSummary$name' => 'The name of the pipeline.
', 'PutActionRevisionInput$pipelineName' => 'The name of the pipeline that starts processing the revision to the source.
', 'PutApprovalResultInput$pipelineName' => 'The name of the pipeline that contains the action.
', 'RetryStageExecutionInput$pipelineName' => 'The name of the pipeline that contains the failed stage.
', 'StartPipelineExecutionInput$name' => 'The name of the pipeline to start.
', 'StopPipelineExecutionInput$pipelineName' => 'The name of the pipeline to stop.
', 'WebhookDefinition$targetPipeline' => 'The name of the pipeline you want to connect to the webhook.
', ], ], 'PipelineNameInUseException' => [ 'base' => 'The specified pipeline name is already in use.
', 'refs' => [], ], 'PipelineNotFoundException' => [ 'base' => 'The pipeline was specified in an invalid format or cannot be found.
', 'refs' => [], ], 'PipelineStageDeclarationList' => [ 'base' => NULL, 'refs' => [ 'PipelineDeclaration$stages' => 'The stage in which to perform the action.
', ], ], 'PipelineSummary' => [ 'base' => 'Returns a summary of a pipeline.
', 'refs' => [ 'PipelineList$member' => NULL, ], ], 'PipelineVersion' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionDetail$pipelineVersion' => 'The version of the pipeline where the action was run.
', 'GetPipelineInput$version' => 'The version number of the pipeline. If you do not specify a version, defaults to the current version.
', 'GetPipelineStateOutput$pipelineVersion' => 'The version number of the pipeline.
A newly created pipeline is always assigned a version number of 1.
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.
', 'PipelineExecution$pipelineVersion' => 'The version number of the pipeline with the specified pipeline execution.
', 'PipelineSummary$version' => 'The version number of the pipeline.
', ], ], 'PipelineVersionNotFoundException' => [ 'base' => 'The pipeline version was specified in an invalid format or cannot be found.
', 'refs' => [], ], 'PolicyStatementsTemplate' => [ 'base' => NULL, 'refs' => [ 'ActionTypeExecutor$policyStatementsTemplate' => '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.
Represents the input of a PollForJobs action.
Represents the output of a PollForJobs action.
Represents the input of a PollForThirdPartyJobs action.
Represents the output of a PollForThirdPartyJobs action.
The accounts in which the job worker is configured and might poll for jobs as part of the action execution.
', ], ], 'PollingServicePrincipalList' => [ 'base' => NULL, 'refs' => [ 'JobWorkerExecutorConfiguration$pollingServicePrincipals' => 'The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.
', ], ], 'PropertyDescription' => [ 'base' => NULL, 'refs' => [ 'ActionTypeProperty$description' => 'The description of the property that is displayed to users.
', ], ], 'PutActionRevisionInput' => [ 'base' => 'Represents the input of a PutActionRevision action.
Represents the output of a PutActionRevision action.
Represents the input of a PutApprovalResult action.
Represents the output of a PutApprovalResult action.
Represents the input of a PutJobFailureResult action.
Represents the input of a PutJobSuccessResult action.
Represents the input of a PutThirdPartyJobFailureResult action.
Represents the input of a PutThirdPartyJobSuccessResult action.
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.
', ], ], 'RegisterWebhookWithThirdPartyInput' => [ 'base' => NULL, 'refs' => [], ], 'RegisterWebhookWithThirdPartyOutput' => [ 'base' => NULL, 'refs' => [], ], 'RequestFailedException' => [ 'base' => 'The request failed because of an unknown error, exception, or failure.
', 'refs' => [], ], 'ResolvedActionConfigurationMap' => [ 'base' => NULL, 'refs' => [ 'ActionExecutionInput$resolvedConfiguration' => 'Configuration data for an action execution with all variable references replaced with their real values for the execution.
', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) of the resource to get tags for.
', 'TagResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) of the resource you want to add tags to.
', 'UntagResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) of the resource to remove tags from.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The resource was specified in an invalid format.
', 'refs' => [], ], 'RetryStageExecutionInput' => [ 'base' => 'Represents the input of a RetryStageExecution action.
Represents the output of a RetryStageExecution action.
The system-generated unique ID that identifies the revision number of the action.
', 'Artifact$revision' => 'The artifact\'s revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
', 'ArtifactRevision$revisionId' => 'The revision ID of the artifact.
', 'CurrentRevision$revision' => 'The revision ID of the current version of an artifact.
', 'SourceRevision$revisionId' => 'The system-generated unique ID that identifies the revision number of the artifact.
', ], ], 'RevisionChangeIdentifier' => [ 'base' => NULL, 'refs' => [ 'ActionRevision$revisionChangeId' => 'The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
', 'ArtifactRevision$revisionChangeIdentifier' => 'An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
', 'CurrentRevision$changeIdentifier' => 'The change identifier for the current revision.
', ], ], 'RevisionSummary' => [ 'base' => NULL, 'refs' => [ 'ArtifactRevision$revisionSummary' => '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.
The summary of the most recent revision of the artifact.
', 'SourceRevision$revisionSummary' => '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.
The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
', 'ActionExecutionInput$roleArn' => 'The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
', 'PipelineDeclaration$roleArn' => '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.
The location of the S3 bucket that contains a revision.
', 'refs' => [ 'ArtifactLocation$s3Location' => 'The S3 bucket that contains the artifact.
', ], ], 'S3Bucket' => [ 'base' => NULL, 'refs' => [ 'S3Location$bucket' => 'The Amazon S3 artifact bucket for an action\'s artifacts.
', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'S3ArtifactLocation$bucketName' => 'The name of the S3 bucket.
', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'S3Location$key' => 'The artifact name.
', ], ], 'S3Location' => [ 'base' => 'The Amazon S3 artifact location for an action\'s artifacts.
', 'refs' => [ 'ArtifactDetail$s3location' => 'The Amazon S3 artifact location for the action execution.
', ], ], 'S3ObjectKey' => [ 'base' => NULL, 'refs' => [ 'S3ArtifactLocation$objectKey' => 'The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
', ], ], 'SecretAccessKey' => [ 'base' => NULL, 'refs' => [ 'AWSSessionCredentials$secretAccessKey' => 'The secret access key for the session.
', ], ], 'ServicePrincipal' => [ 'base' => NULL, 'refs' => [ 'PollingServicePrincipalList$member' => NULL, ], ], 'SessionToken' => [ 'base' => NULL, 'refs' => [ 'AWSSessionCredentials$sessionToken' => 'The token for the session.
', ], ], 'SourceRevision' => [ 'base' => 'Information about the version (or revision) of a source artifact that initiated a pipeline execution.
', 'refs' => [ 'SourceRevisionList$member' => NULL, ], ], 'SourceRevisionList' => [ 'base' => NULL, 'refs' => [ 'PipelineExecutionSummary$sourceRevisions' => 'A list of the source artifact revisions that initiated a pipeline execution.
', ], ], 'StageActionDeclarationList' => [ 'base' => NULL, 'refs' => [ 'StageDeclaration$actions' => 'The actions included in a stage.
', ], ], 'StageBlockerDeclarationList' => [ 'base' => NULL, 'refs' => [ 'StageDeclaration$blockers' => 'Reserved for future use.
', ], ], 'StageContext' => [ 'base' => 'Represents information about a stage to a job worker.
', 'refs' => [ 'PipelineContext$stage' => 'The stage of the pipeline.
', ], ], 'StageDeclaration' => [ 'base' => 'Represents information about a stage and its definition.
', 'refs' => [ 'PipelineStageDeclarationList$member' => NULL, ], ], 'StageExecution' => [ 'base' => 'Represents information about the run of a stage.
', 'refs' => [ 'StageState$inboundExecution' => NULL, 'StageState$latestExecution' => 'Information about the latest execution in the stage, including its ID and status.
', ], ], 'StageExecutionStatus' => [ 'base' => NULL, 'refs' => [ 'StageExecution$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.
The name of the stage that contains the action.
', 'DisableStageTransitionInput$stageName' => 'The name of the stage where you want to disable the inbound or outbound transition of artifacts.
', 'EnableStageTransitionInput$stageName' => '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).
', 'PutActionRevisionInput$stageName' => 'The name of the stage that contains the action that acts on the revision.
', 'PutApprovalResultInput$stageName' => 'The name of the stage that contains the action.
', 'RetryStageExecutionInput$stageName' => 'The name of the failed stage to be retried.
', 'StageContext$name' => 'The name of the stage.
', 'StageDeclaration$name' => 'The name of the stage.
', 'StageState$stageName' => 'The name of the stage.
', ], ], 'StageNotFoundException' => [ 'base' => 'The stage was specified in an invalid format or cannot be found.
', 'refs' => [], ], 'StageNotRetryableException' => [ 'base' => 'Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.
', 'refs' => [], ], 'StageRetryMode' => [ 'base' => NULL, 'refs' => [ 'RetryStageExecutionInput$retryMode' => 'The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
', ], ], 'StageState' => [ 'base' => 'Represents information about the state of the stage.
', 'refs' => [ 'StageStateList$member' => NULL, ], ], 'StageStateList' => [ 'base' => NULL, 'refs' => [ 'GetPipelineStateOutput$stageStates' => 'A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
', ], ], 'StageTransitionType' => [ 'base' => NULL, 'refs' => [ 'DisableStageTransitionInput$transitionType' => '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).
', 'EnableStageTransitionInput$transitionType' => '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).
', ], ], 'StartPipelineExecutionInput' => [ 'base' => 'Represents the input of a StartPipelineExecution action.
Represents the output of a StartPipelineExecution action.
The interaction that stopped a pipeline execution.
', 'refs' => [ 'PipelineExecutionSummary$stopTrigger' => 'The interaction that stopped a pipeline execution.
', ], ], 'StopPipelineExecutionInput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionOutput' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineExecutionReason' => [ 'base' => NULL, 'refs' => [ 'StopExecutionTrigger$reason' => 'The user-specified reason the pipeline was stopped.
', 'StopPipelineExecutionInput$reason' => 'Use this option to enter comments, such as the reason the pipeline was stopped.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ResolvedActionConfigurationMap$key' => NULL, 'ResolvedActionConfigurationMap$value' => NULL, ], ], 'Tag' => [ 'base' => 'A tag is a key-value pair that is used to manage the resource.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'The tag\'s key.
', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => 'The list of keys for the tags to be removed from the resource.
', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateCustomActionTypeInput$tags' => 'The tags for the custom action.
', 'CreateCustomActionTypeOutput$tags' => 'Specifies the tags applied to the custom action.
', 'CreatePipelineInput$tags' => 'The tags for the pipeline.
', 'CreatePipelineOutput$tags' => 'Specifies the tags applied to the pipeline.
', 'ListTagsForResourceOutput$tags' => 'The tags for the resource.
', 'ListWebhookItem$tags' => 'Specifies the tags applied to the webhook.
', 'PutWebhookInput$tags' => 'The tags for the webhook.
', 'TagResourceInput$tags' => 'The tags you want to modify or add to the resource.
', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The tag\'s value.
', ], ], 'ThirdPartyJob' => [ 'base' => 'A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job to be worked on by a partner action.
Represents information about the job data for a partner action.
', 'refs' => [ 'ThirdPartyJobDetails$data' => 'The data to be returned by the third party job worker.
', ], ], 'ThirdPartyJobDetails' => [ 'base' => 'The details of a job sent in response to a GetThirdPartyJobDetails request.
The details of the job, including any protected values defined for the job.
', ], ], 'ThirdPartyJobId' => [ 'base' => NULL, 'refs' => [ 'AcknowledgeThirdPartyJobInput$jobId' => 'The unique system-generated ID of the job.
', 'GetThirdPartyJobDetailsInput$jobId' => 'The unique system-generated ID used for identifying the job.
', 'PutThirdPartyJobFailureResultInput$jobId' => 'The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
The identifier used to identify the job details in CodePipeline.
', ], ], 'ThirdPartyJobList' => [ 'base' => NULL, 'refs' => [ 'PollForThirdPartyJobsOutput$jobs' => 'Information about the jobs to take action on.
', ], ], 'Time' => [ 'base' => NULL, 'refs' => [ 'CurrentRevision$created' => 'The date and time when the most recent revision of the artifact was created, in timestamp format.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ActionExecution$lastStatusChange' => 'The last status change of the action.
', 'ActionExecutionDetail$startTime' => 'The start time of the action execution.
', 'ActionExecutionDetail$lastUpdateTime' => 'The last update time of the action execution.
', 'ActionRevision$created' => 'The date and time when the most recent version of the action was created, in timestamp format.
', 'ArtifactRevision$created' => 'The date and time when the most recent revision of the artifact was created, in timestamp format.
', 'GetPipelineStateOutput$created' => 'The date and time the pipeline was created, in timestamp format.
', 'GetPipelineStateOutput$updated' => 'The date and time the pipeline was last updated, in timestamp format.
', 'PipelineExecutionSummary$startTime' => 'The date and time when the pipeline execution began, in timestamp format.
', 'PipelineExecutionSummary$lastUpdateTime' => 'The date and time of the last change to the pipeline execution, in timestamp format.
', 'PipelineMetadata$created' => 'The date and time the pipeline was created, in timestamp format.
', 'PipelineMetadata$updated' => 'The date and time the pipeline was last updated, in timestamp format.
', 'PipelineMetadata$pollingDisabledAt' => 'The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. 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.
', 'PipelineSummary$created' => 'The date and time the pipeline was created, in timestamp format.
', 'PipelineSummary$updated' => 'The date and time of the last update to the pipeline, in timestamp format.
', 'PutApprovalResultOutput$approvedAt' => 'The timestamp showing when the approval or rejection was submitted.
', ], ], 'TooManyTagsException' => [ 'base' => 'The tags limit for a resource has been exceeded.
', 'refs' => [], ], 'TransitionState' => [ 'base' => 'Represents information about the state of transitions between one stage and another stage.
', 'refs' => [ 'StageState$inboundTransitionState' => 'The state of the inbound transition, which is either enabled or disabled.
', ], ], 'TriggerDetail' => [ 'base' => NULL, 'refs' => [ 'ExecutionTrigger$triggerDetail' => '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.
The type of change-detection method, command, or user interaction that started a pipeline execution.
', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionTypeInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineInput' => [ 'base' => 'Represents the input of an UpdatePipeline action.
Represents the output of an UpdatePipeline action.
The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).
', 'ActionExecutionResult$externalExecutionUrl' => 'The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
', 'ActionState$entityUrl' => 'A URL link for more information about the state of the action, such as a deployment group details page.
', 'ActionState$revisionUrl' => 'A URL link for more information about the revision, such as a commit details page.
', 'ActionTypeSettings$thirdPartyConfigurationUrl' => '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.
', 'ActionTypeUrls$configurationUrl' => 'The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.
', 'ArtifactRevision$revisionUrl' => '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.
', 'SourceRevision$revisionUrl' => '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.
', ], ], 'UrlTemplate' => [ 'base' => NULL, 'refs' => [ 'ActionTypeSettings$entityUrlTemplate' => '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.
', 'ActionTypeSettings$executionUrlTemplate' => '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.
', 'ActionTypeSettings$revisionUrlTemplate' => '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.
', 'ActionTypeUrls$entityUrlTemplate' => '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.
', 'ActionTypeUrls$executionUrlTemplate' => '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.
', 'ActionTypeUrls$revisionUrlTemplate' => '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.
', ], ], 'ValidationException' => [ 'base' => 'The validation was specified in an invalid format.
', 'refs' => [], ], 'Version' => [ 'base' => NULL, 'refs' => [ 'ActionTypeId$version' => 'A string that describes the action version.
', 'ActionTypeIdentifier$version' => 'A string that describes the action type version.
', 'CreateCustomActionTypeInput$version' => 'The version identifier of the custom action.
', 'DeleteCustomActionTypeInput$version' => 'The version of the custom action to delete.
', 'GetActionTypeInput$version' => 'A string that describes the action type version.
', ], ], 'WebhookArn' => [ 'base' => NULL, 'refs' => [ 'ListWebhookItem$arn' => 'The Amazon Resource Name (ARN) of the webhook.
', ], ], 'WebhookAuthConfiguration' => [ 'base' => 'The authentication applied to incoming webhook trigger requests.
', 'refs' => [ 'WebhookDefinition$authenticationConfiguration' => '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.
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 property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.
IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.
UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
Represents information about a webhook and its definition.
', 'refs' => [ 'ListWebhookItem$definition' => 'The detail returned for each webhook, such as the webhook authentication type and filter rules.
', 'PutWebhookInput$webhook' => '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.
', ], ], 'WebhookErrorCode' => [ 'base' => NULL, 'refs' => [ 'ListWebhookItem$errorCode' => 'The number code of the error.
', ], ], 'WebhookErrorMessage' => [ 'base' => NULL, 'refs' => [ 'ListWebhookItem$errorMessage' => 'The text of the error message about the webhook.
', ], ], 'WebhookFilterRule' => [ 'base' => 'The event criteria that specify when a webhook notification is sent to your URL.
', 'refs' => [ 'WebhookFilters$member' => NULL, ], ], 'WebhookFilters' => [ 'base' => NULL, 'refs' => [ 'WebhookDefinition$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.
', ], ], 'WebhookLastTriggered' => [ 'base' => NULL, 'refs' => [ 'ListWebhookItem$lastTriggered' => 'The date and time a webhook was last successfully triggered, in timestamp format.
', ], ], 'WebhookList' => [ 'base' => NULL, 'refs' => [ 'ListWebhooksOutput$webhooks' => 'The JSON detail returned for each webhook in the list output for the ListWebhooks call.
', ], ], 'WebhookName' => [ 'base' => NULL, 'refs' => [ 'DeleteWebhookInput$name' => 'The name of the webhook you want to delete.
', 'DeregisterWebhookWithThirdPartyInput$webhookName' => 'The name of the webhook you want to deregister.
', 'RegisterWebhookWithThirdPartyInput$webhookName' => 'The name of an existing webhook created with PutWebhook to register with a supported third party.
', 'WebhookDefinition$name' => 'The name of the webhook.
', ], ], 'WebhookNotFoundException' => [ 'base' => 'The specified webhook was entered in an invalid format or cannot be found.
', 'refs' => [], ], 'WebhookUrl' => [ 'base' => NULL, 'refs' => [ 'ListWebhookItem$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.
', ], ], ],];