Skip to content

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.ConcurrentPipelineExecutionsLimitExceededException,
    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.PipelineExecutionOutdatedException,
    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.UnableToRollbackStageException,
    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)
    ...
  1. See AcknowledgeJobOutputTypeDef
# acknowledge_job method usage example with argument unpacking

kwargs: AcknowledgeJobInputRequestTypeDef = {  # (1)
    "jobId": ...,
    "nonce": ...,
}

parent.acknowledge_job(**kwargs)
  1. See AcknowledgeJobInputRequestTypeDef

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)
    ...
  1. See AcknowledgeThirdPartyJobOutputTypeDef
# acknowledge_third_party_job method usage example with argument unpacking

kwargs: AcknowledgeThirdPartyJobInputRequestTypeDef = {  # (1)
    "jobId": ...,
    "nonce": ...,
    "clientToken": ...,
}

parent.acknowledge_third_party_job(**kwargs)
  1. See AcknowledgeThirdPartyJobInputRequestTypeDef

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)
    ...
  1. See ActionCategoryType
  2. See ArtifactDetailsTypeDef
  3. See ArtifactDetailsTypeDef
  4. See ActionTypeSettingsTypeDef
  5. See ActionConfigurationPropertyTypeDef
  6. See TagTypeDef
  7. 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)
  1. See CreateCustomActionTypeInputRequestTypeDef

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: Union[PipelineDeclarationTypeDef, PipelineDeclarationOutputTypeDef],  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreatePipelineOutputTypeDef:  # (3)
    ...
  1. See PipelineDeclarationTypeDef PipelineDeclarationOutputTypeDef
  2. See TagTypeDef
  3. See CreatePipelineOutputTypeDef
# create_pipeline method usage example with argument unpacking

kwargs: CreatePipelineInputRequestTypeDef = {  # (1)
    "pipeline": ...,
}

parent.create_pipeline(**kwargs)
  1. See CreatePipelineInputRequestTypeDef

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)
    ...
  1. See ActionCategoryType
  2. See EmptyResponseMetadataTypeDef
# delete_custom_action_type method usage example with argument unpacking

kwargs: DeleteCustomActionTypeInputRequestTypeDef = {  # (1)
    "category": ...,
    "provider": ...,
    "version": ...,
}

parent.delete_custom_action_type(**kwargs)
  1. See DeleteCustomActionTypeInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_pipeline method usage example with argument unpacking

kwargs: DeletePipelineInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_pipeline(**kwargs)
  1. See DeletePipelineInputRequestTypeDef

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)
  1. See DeleteWebhookInputRequestTypeDef

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)
  1. See DeregisterWebhookWithThirdPartyInputRequestTypeDef

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.