CodePipelineClient
Index > CodePipeline > CodePipelineClient
Auto-generated documentation for CodePipeline type annotations stubs module mypy-boto3-codepipeline.
CodePipelineClient
Type annotations and code completion for boto3.client("codepipeline")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_codepipeline.client import CodePipelineClient
def get_codepipeline_client() -> CodePipelineClient:
return Session().client("codepipeline")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("codepipeline").exceptions
structure.
client = boto3.client("codepipeline")
try:
do_something(client)
except (
client.ActionNotFoundException,
client.ActionTypeAlreadyExistsException,
client.ActionTypeNotFoundException,
client.ApprovalAlreadyCompletedException,
client.ClientError,
client.ConcurrentModificationException,
client.ConflictException,
client.DuplicatedStopRequestException,
client.InvalidActionDeclarationException,
client.InvalidApprovalTokenException,
client.InvalidArnException,
client.InvalidBlockerDeclarationException,
client.InvalidClientTokenException,
client.InvalidJobException,
client.InvalidJobStateException,
client.InvalidNextTokenException,
client.InvalidNonceException,
client.InvalidStageDeclarationException,
client.InvalidStructureException,
client.InvalidTagsException,
client.InvalidWebhookAuthenticationParametersException,
client.InvalidWebhookFilterPatternException,
client.JobNotFoundException,
client.LimitExceededException,
client.NotLatestPipelineExecutionException,
client.OutputVariablesSizeExceededException,
client.PipelineExecutionNotFoundException,
client.PipelineExecutionNotStoppableException,
client.PipelineNameInUseException,
client.PipelineNotFoundException,
client.PipelineVersionNotFoundException,
client.RequestFailedException,
client.ResourceNotFoundException,
client.StageNotFoundException,
client.StageNotRetryableException,
client.TooManyTagsException,
client.ValidationException,
client.WebhookNotFoundException,
) as e:
print(e)
from mypy_boto3_codepipeline.client import Exceptions
def handle_error(exc: Exceptions.ActionNotFoundException) -> None:
...
Methods
acknowledge_job
Returns information about a specified job and whether that job has been received by the job worker.
Type annotations and code completion for boto3.client("codepipeline").acknowledge_job
method.
boto3 documentation
def acknowledge_job(
self,
*,
jobId: str,
nonce: str,
) -> AcknowledgeJobOutputTypeDef: # (1)
...
kwargs: AcknowledgeJobInputRequestTypeDef = { # (1)
"jobId": ...,
"nonce": ...,
}
parent.acknowledge_job(**kwargs)
acknowledge_third_party_job
Confirms a job worker has received the specified job.
Type annotations and code completion for boto3.client("codepipeline").acknowledge_third_party_job
method.
boto3 documentation
def acknowledge_third_party_job(
self,
*,
jobId: str,
nonce: str,
clientToken: str,
) -> AcknowledgeThirdPartyJobOutputTypeDef: # (1)
...
kwargs: AcknowledgeThirdPartyJobInputRequestTypeDef = { # (1)
"jobId": ...,
"nonce": ...,
"clientToken": ...,
}
parent.acknowledge_third_party_job(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("codepipeline").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("codepipeline").close
method.
boto3 documentation
create_custom_action_type
Creates a new custom action that can be used in all pipelines associated with the AWS account.
Type annotations and code completion for boto3.client("codepipeline").create_custom_action_type
method.
boto3 documentation
def create_custom_action_type(
self,
*,
category: ActionCategoryType, # (1)
provider: str,
version: str,
inputArtifactDetails: ArtifactDetailsTypeDef, # (2)
outputArtifactDetails: ArtifactDetailsTypeDef, # (2)
settings: ActionTypeSettingsTypeDef = ..., # (4)
configurationProperties: Sequence[ActionConfigurationPropertyTypeDef] = ..., # (5)
tags: Sequence[TagTypeDef] = ..., # (6)
) -> CreateCustomActionTypeOutputTypeDef: # (7)
...
- See ActionCategoryType
- See ArtifactDetailsTypeDef
- See ArtifactDetailsTypeDef
- See ActionTypeSettingsTypeDef
- See ActionConfigurationPropertyTypeDef
- See TagTypeDef
- See CreateCustomActionTypeOutputTypeDef
kwargs: CreateCustomActionTypeInputRequestTypeDef = { # (1)
"category": ...,
"provider": ...,
"version": ...,
"inputArtifactDetails": ...,
"outputArtifactDetails": ...,
}
parent.create_custom_action_type(**kwargs)
create_pipeline
Creates a pipeline.
Type annotations and code completion for boto3.client("codepipeline").create_pipeline
method.
boto3 documentation
def create_pipeline(
self,
*,
pipeline: PipelineDeclarationTypeDef, # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreatePipelineOutputTypeDef: # (3)
...
kwargs: CreatePipelineInputRequestTypeDef = { # (1)
"pipeline": ...,
}
parent.create_pipeline(**kwargs)
delete_custom_action_type
Marks a custom action as deleted.
Type annotations and code completion for boto3.client("codepipeline").delete_custom_action_type
method.
boto3 documentation
def delete_custom_action_type(
self,
*,
category: ActionCategoryType, # (1)
provider: str,
version: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: DeleteCustomActionTypeInputRequestTypeDef = { # (1)
"category": ...,
"provider": ...,
"version": ...,
}
parent.delete_custom_action_type(**kwargs)
delete_pipeline
Deletes the specified pipeline.
Type annotations and code completion for boto3.client("codepipeline").delete_pipeline
method.
boto3 documentation
def delete_pipeline(
self,
*,
name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePipelineInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_pipeline(**kwargs)
delete_webhook
Deletes a previously created webhook by name.
Type annotations and code completion for boto3.client("codepipeline").delete_webhook
method.
boto3 documentation
kwargs: DeleteWebhookInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_webhook(**kwargs)
deregister_webhook_with_third_party
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected.
Type annotations and code completion for boto3.client("codepipeline").deregister_webhook_with_third_party
method.
boto3 documentation
def deregister_webhook_with_third_party(
self,
*,
webhookName: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeregisterWebhookWithThirdPartyInputRequestTypeDef = { # (1)
"webhookName": ...,
}
parent.deregister_webhook_with_third_party(**kwargs)
disable_stage_transition
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
Type annotations and code completion for boto3.client("codepipeline").disable_stage_transition
method.
boto3 documentation
def disable_stage_transition(
self,
*,
pipelineName: str,
stageName: str,
transitionType: StageTransitionTypeType, # (1)
reason: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: DisableStageTransitionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"transitionType": ...,
"reason": ...,
}
parent.disable_stage_transition(**kwargs)
enable_stage_transition
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Type annotations and code completion for boto3.client("codepipeline").enable_stage_transition
method.
boto3 documentation
def enable_stage_transition(
self,
*,
pipelineName: str,
stageName: str,
transitionType: StageTransitionTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: EnableStageTransitionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"transitionType": ...,
}
parent.enable_stage_transition(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("codepipeline").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_action_type
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider.
Type annotations and code completion for boto3.client("codepipeline").get_action_type
method.
boto3 documentation
def get_action_type(
self,
*,
category: ActionCategoryType, # (1)
owner: str,
provider: str,
version: str,
) -> GetActionTypeOutputTypeDef: # (2)
...
kwargs: GetActionTypeInputRequestTypeDef = { # (1)
"category": ...,
"owner": ...,
"provider": ...,
"version": ...,
}
parent.get_action_type(**kwargs)
get_job_details
Returns information about a job.
Type annotations and code completion for boto3.client("codepipeline").get_job_details
method.
boto3 documentation
def get_job_details(
self,
*,
jobId: str,
) -> GetJobDetailsOutputTypeDef: # (1)
...
kwargs: GetJobDetailsInputRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_job_details(**kwargs)
get_pipeline
Returns the metadata, structure, stages, and actions of a pipeline.
Type annotations and code completion for boto3.client("codepipeline").get_pipeline
method.
boto3 documentation
def get_pipeline(
self,
*,
name: str,
version: int = ...,
) -> GetPipelineOutputTypeDef: # (1)
...
kwargs: GetPipelineInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_pipeline(**kwargs)
get_pipeline_execution
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.
Type annotations and code completion for boto3.client("codepipeline").get_pipeline_execution
method.
boto3 documentation
def get_pipeline_execution(
self,
*,
pipelineName: str,
pipelineExecutionId: str,
) -> GetPipelineExecutionOutputTypeDef: # (1)
...
kwargs: GetPipelineExecutionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"pipelineExecutionId": ...,
}
parent.get_pipeline_execution(**kwargs)
get_pipeline_state
Returns information about the state of a pipeline, including the stages and actions.
Type annotations and code completion for boto3.client("codepipeline").get_pipeline_state
method.
boto3 documentation
def get_pipeline_state(
self,
*,
name: str,
) -> GetPipelineStateOutputTypeDef: # (1)
...
kwargs: GetPipelineStateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_pipeline_state(**kwargs)
get_third_party_job_details
Requests the details of a job for a third party action.
Type annotations and code completion for boto3.client("codepipeline").get_third_party_job_details
method.
boto3 documentation
def get_third_party_job_details(
self,
*,
jobId: str,
clientToken: str,
) -> GetThirdPartyJobDetailsOutputTypeDef: # (1)
...
kwargs: GetThirdPartyJobDetailsInputRequestTypeDef = { # (1)
"jobId": ...,
"clientToken": ...,
}
parent.get_third_party_job_details(**kwargs)
list_action_executions
Lists the action executions that have occurred in a pipeline.
Type annotations and code completion for boto3.client("codepipeline").list_action_executions
method.
boto3 documentation
def list_action_executions(
self,
*,
pipelineName: str,
filter: ActionExecutionFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListActionExecutionsOutputTypeDef: # (2)
...
kwargs: ListActionExecutionsInputRequestTypeDef = { # (1)
"pipelineName": ...,
}
parent.list_action_executions(**kwargs)
list_action_types
Gets a summary of all AWS CodePipeline action types associated with your account.
Type annotations and code completion for boto3.client("codepipeline").list_action_types
method.
boto3 documentation
def list_action_types(
self,
*,
actionOwnerFilter: ActionOwnerType = ..., # (1)
nextToken: str = ...,
regionFilter: str = ...,
) -> ListActionTypesOutputTypeDef: # (2)
...
kwargs: ListActionTypesInputRequestTypeDef = { # (1)
"actionOwnerFilter": ...,
}
parent.list_action_types(**kwargs)
list_pipeline_executions
Gets a summary of the most recent executions for a pipeline.
Type annotations and code completion for boto3.client("codepipeline").list_pipeline_executions
method.
boto3 documentation
def list_pipeline_executions(
self,
*,
pipelineName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPipelineExecutionsOutputTypeDef: # (1)
...
kwargs: ListPipelineExecutionsInputRequestTypeDef = { # (1)
"pipelineName": ...,
}
parent.list_pipeline_executions(**kwargs)
list_pipelines
Gets a summary of all of the pipelines associated with your account.
Type annotations and code completion for boto3.client("codepipeline").list_pipelines
method.
boto3 documentation
def list_pipelines(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPipelinesOutputTypeDef: # (1)
...
kwargs: ListPipelinesInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_pipelines(**kwargs)
list_tags_for_resource
Gets the set of key-value pairs (metadata) that are used to manage the resource.
Type annotations and code completion for boto3.client("codepipeline").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_webhooks
Gets a listing of all the webhooks in this AWS Region for this account.
Type annotations and code completion for boto3.client("codepipeline").list_webhooks
method.
boto3 documentation
def list_webhooks(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListWebhooksOutputTypeDef: # (1)
...
kwargs: ListWebhooksInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_webhooks(**kwargs)
poll_for_jobs
Returns information about any jobs for AWS CodePipeline to act on.
Type annotations and code completion for boto3.client("codepipeline").poll_for_jobs
method.
boto3 documentation
def poll_for_jobs(
self,
*,
actionTypeId: ActionTypeIdTypeDef, # (1)
maxBatchSize: int = ...,
queryParam: Mapping[str, str] = ...,
) -> PollForJobsOutputTypeDef: # (2)
...
kwargs: PollForJobsInputRequestTypeDef = { # (1)
"actionTypeId": ...,
}
parent.poll_for_jobs(**kwargs)
poll_for_third_party_jobs
Determines whether there are any third party jobs for a job worker to act on.
Type annotations and code completion for boto3.client("codepipeline").poll_for_third_party_jobs
method.
boto3 documentation
def poll_for_third_party_jobs(
self,
*,
actionTypeId: ActionTypeIdTypeDef, # (1)
maxBatchSize: int = ...,
) -> PollForThirdPartyJobsOutputTypeDef: # (2)
...
kwargs: PollForThirdPartyJobsInputRequestTypeDef = { # (1)
"actionTypeId": ...,
}
parent.poll_for_third_party_jobs(**kwargs)
put_action_revision
Provides information to AWS CodePipeline about new revisions to a source.
Type annotations and code completion for boto3.client("codepipeline").put_action_revision
method.
boto3 documentation
def put_action_revision(
self,
*,
pipelineName: str,
stageName: str,
actionName: str,
actionRevision: ActionRevisionTypeDef, # (1)
) -> PutActionRevisionOutputTypeDef: # (2)
...
kwargs: PutActionRevisionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"actionName": ...,
"actionRevision": ...,
}
parent.put_action_revision(**kwargs)
put_approval_result
Provides the response to a manual approval request to AWS CodePipeline.
Type annotations and code completion for boto3.client("codepipeline").put_approval_result
method.
boto3 documentation
def put_approval_result(
self,
*,
pipelineName: str,
stageName: str,
actionName: str,
result: ApprovalResultTypeDef, # (1)
token: str,
) -> PutApprovalResultOutputTypeDef: # (2)
...
kwargs: PutApprovalResultInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"actionName": ...,
"result": ...,
"token": ...,
}
parent.put_approval_result(**kwargs)
put_job_failure_result
Represents the failure of a job as returned to the pipeline by a job worker.
Type annotations and code completion for boto3.client("codepipeline").put_job_failure_result
method.
boto3 documentation
def put_job_failure_result(
self,
*,
jobId: str,
failureDetails: FailureDetailsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutJobFailureResultInputRequestTypeDef = { # (1)
"jobId": ...,
"failureDetails": ...,
}
parent.put_job_failure_result(**kwargs)
put_job_success_result
Represents the success of a job as returned to the pipeline by a job worker.
Type annotations and code completion for boto3.client("codepipeline").put_job_success_result
method.
boto3 documentation
def put_job_success_result(
self,
*,
jobId: str,
currentRevision: CurrentRevisionTypeDef = ..., # (1)
continuationToken: str = ...,
executionDetails: ExecutionDetailsTypeDef = ..., # (2)
outputVariables: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef: # (3)
...
kwargs: PutJobSuccessResultInputRequestTypeDef = { # (1)
"jobId": ...,
}
parent.put_job_success_result(**kwargs)
put_third_party_job_failure_result
Represents the failure of a third party job as returned to the pipeline by a job worker.
Type annotations and code completion for boto3.client("codepipeline").put_third_party_job_failure_result
method.
boto3 documentation
def put_third_party_job_failure_result(
self,
*,
jobId: str,
clientToken: str,
failureDetails: FailureDetailsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutThirdPartyJobFailureResultInputRequestTypeDef = { # (1)
"jobId": ...,
"clientToken": ...,
"failureDetails": ...,
}
parent.put_third_party_job_failure_result(**kwargs)
put_third_party_job_success_result
Represents the success of a third party job as returned to the pipeline by a job worker.
Type annotations and code completion for boto3.client("codepipeline").put_third_party_job_success_result
method.
boto3 documentation
def put_third_party_job_success_result(
self,
*,
jobId: str,
clientToken: str,
currentRevision: CurrentRevisionTypeDef = ..., # (1)
continuationToken: str = ...,
executionDetails: ExecutionDetailsTypeDef = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
kwargs: PutThirdPartyJobSuccessResultInputRequestTypeDef = { # (1)
"jobId": ...,
"clientToken": ...,
}
parent.put_third_party_job_success_result(**kwargs)
put_webhook
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
Type annotations and code completion for boto3.client("codepipeline").put_webhook
method.
boto3 documentation
def put_webhook(
self,
*,
webhook: WebhookDefinitionTypeDef, # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> PutWebhookOutputTypeDef: # (3)
...
kwargs: PutWebhookInputRequestTypeDef = { # (1)
"webhook": ...,
}
parent.put_webhook(**kwargs)
register_webhook_with_third_party
Configures a connection between the webhook that was created and the external tool with events to be detected.
Type annotations and code completion for boto3.client("codepipeline").register_webhook_with_third_party
method.
boto3 documentation
def register_webhook_with_third_party(
self,
*,
webhookName: str = ...,
) -> Dict[str, Any]:
...
kwargs: RegisterWebhookWithThirdPartyInputRequestTypeDef = { # (1)
"webhookName": ...,
}
parent.register_webhook_with_third_party(**kwargs)
retry_stage_execution
Resumes the pipeline execution by retrying the last failed actions in a stage.
Type annotations and code completion for boto3.client("codepipeline").retry_stage_execution
method.
boto3 documentation
def retry_stage_execution(
self,
*,
pipelineName: str,
stageName: str,
pipelineExecutionId: str,
retryMode: StageRetryModeType, # (1)
) -> RetryStageExecutionOutputTypeDef: # (2)
...
kwargs: RetryStageExecutionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"pipelineExecutionId": ...,
"retryMode": ...,
}
parent.retry_stage_execution(**kwargs)
start_pipeline_execution
Starts the specified pipeline.
Type annotations and code completion for boto3.client("codepipeline").start_pipeline_execution
method.
boto3 documentation
def start_pipeline_execution(
self,
*,
name: str,
clientRequestToken: str = ...,
) -> StartPipelineExecutionOutputTypeDef: # (1)
...
kwargs: StartPipelineExecutionInputRequestTypeDef = { # (1)
"name": ...,
}
parent.start_pipeline_execution(**kwargs)
stop_pipeline_execution
Stops the specified pipeline execution.
Type annotations and code completion for boto3.client("codepipeline").stop_pipeline_execution
method.
boto3 documentation
def stop_pipeline_execution(
self,
*,
pipelineName: str,
pipelineExecutionId: str,
abandon: bool = ...,
reason: str = ...,
) -> StopPipelineExecutionOutputTypeDef: # (1)
...
kwargs: StopPipelineExecutionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"pipelineExecutionId": ...,
}
parent.stop_pipeline_execution(**kwargs)
tag_resource
Adds to or modifies the tags of the given resource.
Type annotations and code completion for boto3.client("codepipeline").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from an AWS resource.
Type annotations and code completion for boto3.client("codepipeline").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_action_type
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.
Type annotations and code completion for boto3.client("codepipeline").update_action_type
method.
boto3 documentation
def update_action_type(
self,
*,
actionType: ActionTypeDeclarationTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateActionTypeInputRequestTypeDef = { # (1)
"actionType": ...,
}
parent.update_action_type(**kwargs)
update_pipeline
Updates a specified pipeline with edits or changes to its structure.
Type annotations and code completion for boto3.client("codepipeline").update_pipeline
method.
boto3 documentation
def update_pipeline(
self,
*,
pipeline: PipelineDeclarationTypeDef, # (1)
) -> UpdatePipelineOutputTypeDef: # (2)
...
kwargs: UpdatePipelineInputRequestTypeDef = { # (1)
"pipeline": ...,
}
parent.update_pipeline(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("codepipeline").get_paginator
method with overloads.
client.get_paginator("list_action_executions")
-> ListActionExecutionsPaginatorclient.get_paginator("list_action_types")
-> ListActionTypesPaginatorclient.get_paginator("list_pipeline_executions")
-> ListPipelineExecutionsPaginatorclient.get_paginator("list_pipelines")
-> ListPipelinesPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_webhooks")
-> ListWebhooksPaginator