universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
897 lines • 94.8 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class CodePipeline extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodePipeline.Types.ClientConfiguration)
config: Config & CodePipeline.Types.ClientConfiguration;
/**
* Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
*/
acknowledgeJob(params: CodePipeline.Types.AcknowledgeJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request<CodePipeline.Types.AcknowledgeJobOutput, AWSError>;
/**
* Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
*/
acknowledgeJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request<CodePipeline.Types.AcknowledgeJobOutput, AWSError>;
/**
* Confirms a job worker has received the specified job. Used for partner actions only.
*/
acknowledgeThirdPartyJob(params: CodePipeline.Types.AcknowledgeThirdPartyJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
/**
* Confirms a job worker has received the specified job. Used for partner actions only.
*/
acknowledgeThirdPartyJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
/**
* Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
*/
createCustomActionType(params: CodePipeline.Types.CreateCustomActionTypeInput, callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
/**
* Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
*/
createCustomActionType(callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
/**
* 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.
*/
createPipeline(params: CodePipeline.Types.CreatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request<CodePipeline.Types.CreatePipelineOutput, AWSError>;
/**
* 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.
*/
createPipeline(callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request<CodePipeline.Types.CreatePipelineOutput, AWSError>;
/**
* 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.
*/
deleteCustomActionType(params: CodePipeline.Types.DeleteCustomActionTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteCustomActionType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified pipeline.
*/
deletePipeline(params: CodePipeline.Types.DeletePipelineInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified pipeline.
*/
deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a previously created webhook by name. Deleting the webhook stops AWS 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.
*/
deleteWebhook(params: CodePipeline.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
/**
* Deletes a previously created webhook by name. Deleting the webhook stops AWS 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.
*/
deleteWebhook(callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
/**
* 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.
*/
deregisterWebhookWithThirdParty(params: CodePipeline.Types.DeregisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput, AWSError>;
/**
* 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.
*/
deregisterWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput, AWSError>;
/**
* Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
*/
disableStageTransition(params: CodePipeline.Types.DisableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
*/
disableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables artifacts in a pipeline to transition to a stage in a pipeline.
*/
enableStageTransition(params: CodePipeline.Types.EnableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables artifacts in a pipeline to transition to a stage in a pipeline.
*/
enableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getJobDetails(params: CodePipeline.Types.GetJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
/**
* Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
/**
* 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.
*/
getPipeline(params: CodePipeline.Types.GetPipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request<CodePipeline.Types.GetPipelineOutput, AWSError>;
/**
* 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.
*/
getPipeline(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request<CodePipeline.Types.GetPipelineOutput, AWSError>;
/**
* 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.
*/
getPipelineExecution(params: CodePipeline.Types.GetPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request<CodePipeline.Types.GetPipelineExecutionOutput, AWSError>;
/**
* 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.
*/
getPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request<CodePipeline.Types.GetPipelineExecutionOutput, AWSError>;
/**
* 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.
*/
getPipelineState(params: CodePipeline.Types.GetPipelineStateInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
/**
* 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.
*/
getPipelineState(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
/**
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getThirdPartyJobDetails(params: CodePipeline.Types.GetThirdPartyJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
/**
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getThirdPartyJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
/**
* Lists the action executions that have occurred in a pipeline.
*/
listActionExecutions(params: CodePipeline.Types.ListActionExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
/**
* Lists the action executions that have occurred in a pipeline.
*/
listActionExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
/**
* Gets a summary of all AWS CodePipeline action types associated with your account.
*/
listActionTypes(params: CodePipeline.Types.ListActionTypesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
/**
* Gets a summary of all AWS CodePipeline action types associated with your account.
*/
listActionTypes(callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
/**
* Gets a summary of the most recent executions for a pipeline.
*/
listPipelineExecutions(params: CodePipeline.Types.ListPipelineExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request<CodePipeline.Types.ListPipelineExecutionsOutput, AWSError>;
/**
* Gets a summary of the most recent executions for a pipeline.
*/
listPipelineExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request<CodePipeline.Types.ListPipelineExecutionsOutput, AWSError>;
/**
* Gets a summary of all of the pipelines associated with your account.
*/
listPipelines(params: CodePipeline.Types.ListPipelinesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request<CodePipeline.Types.ListPipelinesOutput, AWSError>;
/**
* Gets a summary of all of the pipelines associated with your account.
*/
listPipelines(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request<CodePipeline.Types.ListPipelinesOutput, AWSError>;
/**
* Gets the set of key-value pairs (metadata) that are used to manage the resource.
*/
listTagsForResource(params: CodePipeline.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
/**
* Gets the set of key-value pairs (metadata) that are used to manage the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
/**
* Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
*/
listWebhooks(params: CodePipeline.Types.ListWebhooksInput, callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
/**
* Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
*/
listWebhooks(callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
/**
* Returns information about any jobs for AWS 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, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
pollForJobs(params: CodePipeline.Types.PollForJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
/**
* Returns information about any jobs for AWS 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, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
pollForJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
/**
* 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, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
*/
pollForThirdPartyJobs(params: CodePipeline.Types.PollForThirdPartyJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
/**
* 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, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
*/
pollForThirdPartyJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
/**
* Provides information to AWS CodePipeline about new revisions to a source.
*/
putActionRevision(params: CodePipeline.Types.PutActionRevisionInput, callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
/**
* Provides information to AWS CodePipeline about new revisions to a source.
*/
putActionRevision(callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
/**
* Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
*/
putApprovalResult(params: CodePipeline.Types.PutApprovalResultInput, callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
/**
* Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
*/
putApprovalResult(callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
/**
* Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobFailureResult(params: CodePipeline.Types.PutJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobSuccessResult(params: CodePipeline.Types.PutJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobFailureResult(params: CodePipeline.Types.PutThirdPartyJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobSuccessResult(params: CodePipeline.Types.PutThirdPartyJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
putWebhook(params: CodePipeline.Types.PutWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request<CodePipeline.Types.PutWebhookOutput, AWSError>;
/**
* 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.
*/
putWebhook(callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request<CodePipeline.Types.PutWebhookOutput, AWSError>;
/**
* Configures a connection between the webhook that was created and the external tool with events to be detected.
*/
registerWebhookWithThirdParty(params: CodePipeline.Types.RegisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.RegisterWebhookWithThirdPartyOutput, AWSError>;
/**
* Configures a connection between the webhook that was created and the external tool with events to be detected.
*/
registerWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.RegisterWebhookWithThirdPartyOutput, AWSError>;
/**
* 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.
*/
retryStageExecution(params: CodePipeline.Types.RetryStageExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request<CodePipeline.Types.RetryStageExecutionOutput, AWSError>;
/**
* 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.
*/
retryStageExecution(callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request<CodePipeline.Types.RetryStageExecutionOutput, AWSError>;
/**
* Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
*/
startPipelineExecution(params: CodePipeline.Types.StartPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request<CodePipeline.Types.StartPipelineExecutionOutput, AWSError>;
/**
* Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
*/
startPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request<CodePipeline.Types.StartPipelineExecutionOutput, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*/
tagResource(params: CodePipeline.Types.TagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*/
tagResource(callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
/**
* Removes tags from an AWS resource.
*/
untagResource(params: CodePipeline.Types.UntagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
/**
* Removes tags from an AWS resource.
*/
untagResource(callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
/**
* 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.
*/
updatePipeline(params: CodePipeline.Types.UpdatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
/**
* 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.
*/
updatePipeline(callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
}
declare namespace CodePipeline {
export type AWSRegionName = string;
export interface AWSSessionCredentials {
/**
* The access key for the session.
*/
accessKeyId: AccessKeyId;
/**
* The secret access key for the session.
*/
secretAccessKey: SecretAccessKey;
/**
* The token for the session.
*/
sessionToken: SessionToken;
}
export type AccessKeyId = string;
export type AccountId = string;
export interface AcknowledgeJobInput {
/**
* The unique system-generated ID of the job for which you want to confirm receipt.
*/
jobId: JobId;
/**
* A system-generated random number that AWS 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.
*/
nonce: Nonce;
}
export interface AcknowledgeJobOutput {
/**
* Whether the job worker has received the specified job.
*/
status?: JobStatus;
}
export interface AcknowledgeThirdPartyJobInput {
/**
* The unique system-generated ID of the job.
*/
jobId: ThirdPartyJobId;
/**
* A system-generated random number that AWS 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.
*/
nonce: Nonce;
/**
* 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.
*/
clientToken: ClientToken;
}
export interface AcknowledgeThirdPartyJobOutput {
/**
* The status information for the third party job, if any.
*/
status?: JobStatus;
}
export type ActionCategory = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval"|string;
export interface ActionConfiguration {
/**
* The configuration data for the action.
*/
configuration?: ActionConfigurationMap;
}
export type ActionConfigurationKey = string;
export type ActionConfigurationMap = {[key: string]: ActionConfigurationValue};
export interface ActionConfigurationProperty {
/**
* The name of the action configuration property.
*/
name: ActionConfigurationKey;
/**
* Whether the configuration property is a required value.
*/
required: Boolean;
/**
* Whether the configuration property is a key.
*/
key: Boolean;
/**
* Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
*/
secret: Boolean;
/**
* 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.
*/
queryable?: Boolean;
/**
* The description of the action configuration property that is displayed to users.
*/
description?: Description;
/**
* The type of the configuration property.
*/
type?: ActionConfigurationPropertyType;
}
export type ActionConfigurationPropertyList = ActionConfigurationProperty[];
export type ActionConfigurationPropertyType = "String"|"Number"|"Boolean"|string;
export type ActionConfigurationQueryableValue = string;
export type ActionConfigurationValue = string;
export interface ActionContext {
/**
* The name of the action in the context of a job.
*/
name?: ActionName;
/**
* The system-generated unique ID that corresponds to an action's execution.
*/
actionExecutionId?: ActionExecutionId;
}
export interface ActionDeclaration {
/**
* The action declaration's name.
*/
name: ActionName;
/**
* Specifies the action type and the provider of the action.
*/
actionTypeId: ActionTypeId;
/**
* The order in which actions are run.
*/
runOrder?: ActionRunOrder;
/**
* 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 AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS 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?: ActionConfigurationMap;
/**
* The name or ID of the result of the action declaration, such as a test or build artifact.
*/
outputArtifacts?: OutputArtifactList;
/**
* The name or ID of the artifact consumed by the action, such as a test or build artifact.
*/
inputArtifacts?: InputArtifactList;
/**
* The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*/
roleArn?: RoleArn;
/**
* The action declaration's AWS Region, such as us-east-1.
*/
region?: AWSRegionName;
}
export interface ActionExecution {
/**
* The status of the action, or for a completed action, the last status of the action.
*/
status?: ActionExecutionStatus;
/**
* A summary of the run of the action.
*/
summary?: ExecutionSummary;
/**
* The last status change of the action.
*/
lastStatusChange?: Timestamp;
/**
* 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.
*/
token?: ActionExecutionToken;
/**
* The ARN of the user who last changed the pipeline.
*/
lastUpdatedBy?: LastUpdatedBy;
/**
* The external ID of the run of the action.
*/
externalExecutionId?: ExecutionId;
/**
* The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
*/
externalExecutionUrl?: Url;
/**
* A percentage of completeness of the action as it runs.
*/
percentComplete?: Percentage;
/**
* The details of an error returned by a URL external to AWS.
*/
errorDetails?: ErrorDetails;
}
export interface ActionExecutionDetail {
/**
* The pipeline execution ID for the action execution.
*/
pipelineExecutionId?: PipelineExecutionId;
/**
* The action execution ID.
*/
actionExecutionId?: ActionExecutionId;
/**
* The version of the pipeline where the action was run.
*/
pipelineVersion?: PipelineVersion;
/**
* The name of the stage that contains the action.
*/
stageName?: StageName;
/**
* The name of the action.
*/
actionName?: ActionName;
/**
* The start time of the action execution.
*/
startTime?: Timestamp;
/**
* The last update time of the action execution.
*/
lastUpdateTime?: Timestamp;
/**
* The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
*/
status?: ActionExecutionStatus;
/**
* Input details for the action execution, such as role ARN, Region, and input artifacts.
*/
input?: ActionExecutionInput;
/**
* Output details for the action execution, such as the action execution result.
*/
output?: ActionExecutionOutput;
}
export type ActionExecutionDetailList = ActionExecutionDetail[];
export interface ActionExecutionFilter {
/**
* The pipeline execution ID used to filter action execution history.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export type ActionExecutionId = string;
export interface ActionExecutionInput {
actionTypeId?: ActionTypeId;
/**
* Configuration data for an action execution.
*/
configuration?: ActionConfigurationMap;
/**
* The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*/
roleArn?: RoleArn;
/**
* The AWS Region for the action, such as us-east-1.
*/
region?: AWSRegionName;
/**
* Details of input artifacts of the action that correspond to the action execution.
*/
inputArtifacts?: ArtifactDetailList;
}
export interface ActionExecutionOutput {
/**
* Details of output artifacts of the action that correspond to the action execution.
*/
outputArtifacts?: ArtifactDetailList;
/**
* Execution result information listed in the output details for an action execution.
*/
executionResult?: ActionExecutionResult;
}
export interface ActionExecutionResult {
/**
* The action provider's external ID for the action execution.
*/
externalExecutionId?: ExternalExecutionId;
/**
* The action provider's summary for the action execution.
*/
externalExecutionSummary?: ExternalExecutionSummary;
/**
* The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
*/
externalExecutionUrl?: Url;
}
export type ActionExecutionStatus = "InProgress"|"Succeeded"|"Failed"|string;
export type ActionExecutionToken = string;
export type ActionName = string;
export type ActionOwner = "AWS"|"ThirdParty"|"Custom"|string;
export type ActionProvider = string;
export interface ActionRevision {
/**
* The system-generated unique ID that identifies the revision number of the action.
*/
revisionId: Revision;
/**
* The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
*/
revisionChangeId: RevisionChangeIdentifier;
/**
* The date and time when the most recent version of the action was created, in timestamp format.
*/
created: Timestamp;
}
export type ActionRunOrder = number;
export interface ActionState {
/**
* The name of the action.
*/
actionName?: ActionName;
/**
* Represents information about the version (or revision) of an action.
*/
currentRevision?: ActionRevision;
/**
* Represents information about the run of an action.
*/
latestExecution?: ActionExecution;
/**
* A URL link for more information about the state of the action, such as a deployment group details page.
*/
entityUrl?: Url;
/**
* A URL link for more information about the revision, such as a commit details page.
*/
revisionUrl?: Url;
}
export type ActionStateList = ActionState[];
export interface ActionType {
/**
* Represents information about an action type.
*/
id: ActionTypeId;
/**
* The settings for the action type.
*/
settings?: ActionTypeSettings;
/**
* The configuration properties for the action type.
*/
actionConfigurationProperties?: ActionConfigurationPropertyList;
/**
* The details of the input artifact for the action, such as its commit ID.
*/
inputArtifactDetails: ArtifactDetails;
/**
* The details of the output artifact of the action, such as its commit ID.
*/
outputArtifactDetails: ArtifactDetails;
}
export interface ActionTypeId {
/**
* 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.
*/
category: ActionCategory;
/**
* The creator of the action being called.
*/
owner: ActionOwner;
/**
* 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 AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
*/
provider: ActionProvider;
/**
* A string that describes the action version.
*/
version: Version;
}
export type ActionTypeList = ActionType[];
export interface ActionTypeSettings {
/**
* 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.
*/
thirdPartyConfigurationUrl?: Url;
/**
* The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
*/
entityUrlTemplate?: UrlTemplate;
/**
* The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
*/
executionUrlTemplate?: UrlTemplate;
/**
* The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
*/
revisionUrlTemplate?: UrlTemplate;
}
export interface ApprovalResult {
/**
* The summary of the current status of the approval request.
*/
summary: ApprovalSummary;
/**
* The response submitted by a reviewer assigned to an approval action request.
*/
status: ApprovalStatus;
}
export type ApprovalStatus = "Approved"|"Rejected"|string;
export type ApprovalSummary = string;
export type ApprovalToken = string;
export interface Artifact {
/**
* The artifact's name.
*/
name?: ArtifactName;
/**
* The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
*/
revision?: Revision;
/**
* The location of an artifact.
*/
location?: ArtifactLocation;
}
export interface ArtifactDetail {
/**
* The artifact object name for the action execution.
*/
name?: ArtifactName;
/**
* The Amazon S3 artifact location for the action execution.
*/
s3location?: S3Location;
}
export type ArtifactDetailList = ArtifactDetail[];
export interface ArtifactDetails {
/**
* The minimum number of artifacts allowed for the action type.
*/
minimumCount: MinimumArtifactCount;
/**
* The maximum number of artifacts allowed for the action type.
*/
maximumCount: MaximumArtifactCount;
}
export type ArtifactList = Artifact[];
export interface ArtifactLocation {
/**
* The type of artifact in the location.
*/
type?: ArtifactLocationType;
/**
* The Amazon S3 bucket that contains the artifact.
*/
s3Location?: S3ArtifactLocation;
}
export type ArtifactLocationType = "S3"|string;
export type ArtifactName = string;
export interface ArtifactRevision {
/**
* The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
*/
name?: ArtifactName;
/**
* The revision ID of the artifact.
*/
revisionId?: Revision;
/**
* An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
*/
revisionChangeIdentifier?: RevisionChangeIdentifier;
/**
* Summary information about the most recent revision of the artifact. For GitHub and AWS 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.
*/
revisionSummary?: RevisionSummary;
/**
* The date and time when the most recent revision of the artifact was created, in timestamp format.
*/
created?: Timestamp;
/**
* The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
*/
revisionUrl?: Url;
}
export type ArtifactRevisionList = ArtifactRevision[];
export interface ArtifactStore {
/**
* The type of the artifact store, such as S3.
*/
type: ArtifactStoreType;
/**
* The Amazon 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 Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
*/
location: ArtifactStoreLocation;
/**
* The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
*/
encryptionKey?: EncryptionKey;
}
export type ArtifactStoreLocation = string;
export type ArtifactStoreMap = {[key: string]: ArtifactStore};
export type ArtifactStoreType = "S3"|string;
export interface BlockerDeclaration {
/**
* Reserved for future use.
*/
name: BlockerName;
/**
* Reserved for future use.
*/
type: BlockerType;
}
export type BlockerName = string;
export type BlockerType = "Schedule"|string;
export type Boolean = boolean;
export type ClientId = string;
export type ClientRequestToken = string;
export type ClientToken = string;
export type Code = string;
export type ContinuationToken = string;
export interface CreateCustomActionTypeInput {
/**
* The category of the custom action, such as a build action or a test action. Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.
*/
category: ActionCategory;
/**
* The provider of the service used in the custom action, such as AWS CodeDeploy.
*/
provider: ActionProvider;
/**
* The version identifier of the custom action.
*/
version: Version;
/**
* URLs that provide users information about this custom action.
*/
settings?: ActionTypeSettings;
/**
* 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.
*/
configurationProperties?: ActionConfigurationPropertyList;
/**
* The details of the input artifact for the action, such as its commit ID.
*/
inputArtifactDetails: ArtifactDetails;
/**
* The details of the output artifact of the action, such as its commit ID.
*/
outputArtifactDetails: ArtifactDetails;
/**
* The tags for the custom action.
*/
tags?: TagList;
}
export interface CreateCustomActionTypeOutput {
/**
* Returns information about the details of an action type.
*/
actionType: ActionType;
/**
* Specifies the tags applied to the custom action.
*/
tags?: TagList;
}
export interface CreatePipelineInput {
/**
* Represents the structure of actions and stages to be performed in the pipeline.
*/
pipeline: PipelineDeclaration;
/**
* The tags for the pipeline.
*/
tags?: TagList;
}
export interface CreatePipelineOutput {
/**
* Represents the structure of actions and stages to be performed in the pipeline.
*/
pipeline?: PipelineDeclaration;
/**
* Specifies the tags applied to the pipeline.
*/
tags?: TagList;
}
export interface CurrentRevision {
/**
* The revision ID of the current version of an artifact.
*/
revision: Revision;
/**
* The change identifier for the current revision.
*/
changeIdentifier: RevisionChangeIdentifier;
/**
* The date and time when the most recent revision of the artifact was created, in timestamp format.
*/
created?: Time;
/**
* The summary of the most recent revision of the artifact.
*/
revisionSummary?: RevisionSummary;
}
export interface DeleteCustomActionTypeInput {
/**
* The category of the custom action that you want to delete, such as source or deploy.
*/
category: ActionCategory;
/**
* The provider of the service used in the custom action, such as AWS CodeDeploy.
*/
provider: ActionProvider;
/**
* The version of the custom action to delete.
*/
version: Version;
}
export interface DeletePipelineInput {
/**