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
# CodePipelineClient usage example
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.
# Exceptions.exceptions usage example
client = boto3.client("codepipeline")
try:
do_something(client)
except (
client.exceptions.ActionNotFoundException,
client.exceptions.ActionTypeAlreadyExistsException,
client.exceptions.ActionTypeNotFoundException,
client.exceptions.ApprovalAlreadyCompletedException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.ConflictException,
client.exceptions.DuplicatedStopRequestException,
client.exceptions.InvalidActionDeclarationException,
client.exceptions.InvalidApprovalTokenException,
client.exceptions.InvalidArnException,
client.exceptions.InvalidBlockerDeclarationException,
client.exceptions.InvalidClientTokenException,
client.exceptions.InvalidJobException,
client.exceptions.InvalidJobStateException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidNonceException,
client.exceptions.InvalidStageDeclarationException,
client.exceptions.InvalidStructureException,
client.exceptions.InvalidTagsException,
client.exceptions.InvalidWebhookAuthenticationParametersException,
client.exceptions.InvalidWebhookFilterPatternException,
client.exceptions.JobNotFoundException,
client.exceptions.LimitExceededException,
client.exceptions.NotLatestPipelineExecutionException,
client.exceptions.OutputVariablesSizeExceededException,
client.exceptions.PipelineExecutionNotFoundException,
client.exceptions.PipelineExecutionNotStoppableException,
client.exceptions.PipelineNameInUseException,
client.exceptions.PipelineNotFoundException,
client.exceptions.PipelineVersionNotFoundException,
client.exceptions.RequestFailedException,
client.exceptions.ResourceNotFoundException,
client.exceptions.StageNotFoundException,
client.exceptions.StageNotRetryableException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
client.exceptions.WebhookNotFoundException,
) as e:
print(e)# Exceptions.exceptions type checking example
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
# acknowledge_job method definition
def acknowledge_job(
self,
*,
jobId: str,
nonce: str,
) -> AcknowledgeJobOutputTypeDef: # (1)
...# acknowledge_job method usage example with argument unpacking
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
# acknowledge_third_party_job method definition
def acknowledge_third_party_job(
self,
*,
jobId: str,
nonce: str,
clientToken: str,
) -> AcknowledgeThirdPartyJobOutputTypeDef: # (1)
...# acknowledge_third_party_job method usage example with argument unpacking
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("codepipeline").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_custom_action_type#
Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account.
Type annotations and code completion for boto3.client("codepipeline").create_custom_action_type method.
boto3 documentation
# create_custom_action_type method definition
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
# create_custom_action_type method usage example with argument unpacking
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
# create_pipeline method definition
def create_pipeline(
self,
*,
pipeline: PipelineDeclarationTypeDef, # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreatePipelineOutputTypeDef: # (3)
...# create_pipeline method usage example with argument unpacking
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
# delete_custom_action_type method definition
def delete_custom_action_type(
self,
*,
category: ActionCategoryType, # (1)
provider: str,
version: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# delete_custom_action_type method usage example with argument unpacking
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
# delete_pipeline method definition
def delete_pipeline(
self,
*,
name: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_pipeline method usage example with argument unpacking
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
# delete_webhook method definition
def delete_webhook(
self,
*,
name: str,
) -> Dict[str, Any]:
...# delete_webhook method usage example with argument unpacking
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
# deregister_webhook_with_third_party method definition
def deregister_webhook_with_third_party(
self,
*,
webhookName: str = ...,
) -> Dict[str, Any]:
...# deregister_webhook_with_third_party method usage example with argument unpacking
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
# disable_stage_transition method definition
def disable_stage_transition(
self,
*,
pipelineName: str,
stageName: str,
transitionType: StageTransitionTypeType, # (1)
reason: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# disable_stage_transition method usage example with argument unpacking
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
# enable_stage_transition method definition
def enable_stage_transition(
self,
*,
pipelineName: str,
stageName: str,
transitionType: StageTransitionTypeType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# enable_stage_transition method usage example with argument unpacking
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
# generate_presigned_url method definition
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
# get_action_type method definition
def get_action_type(
self,
*,
category: ActionCategoryType, # (1)
owner: str,
provider: str,
version: str,
) -> GetActionTypeOutputTypeDef: # (2)
...# get_action_type method usage example with argument unpacking
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
# get_job_details method definition
def get_job_details(
self,
*,
jobId: str,
) -> GetJobDetailsOutputTypeDef: # (1)
...# get_job_details method usage example with argument unpacking
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.