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.ConditionNotOverridableException,
    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: PipelineDeclarationTypeDef,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreatePipelineOutputTypeDef:  # (3)
    ...

1. See PipelineDeclarationTypeDef
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. boto3 documentation

# disable_stage_transition method definition

def disable_stage_transition(
    self,
    *,
    pipelineName: str,
    stageName: str,
    transitionType: StageTransitionTypeType,  # (1)
    reason: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See StageTransitionTypeType
2. See EmptyResponseMetadataTypeDef

# disable_stage_transition method usage example with argument unpacking

kwargs: DisableStageTransitionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "transitionType": ...,
    "reason": ...,
}

parent.disable_stage_transition(**kwargs)

1. See DisableStageTransitionInputRequestTypeDef

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)
    ...

1. See StageTransitionTypeType
2. See EmptyResponseMetadataTypeDef

# enable_stage_transition method usage example with argument unpacking

kwargs: EnableStageTransitionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "transitionType": ...,
}

parent.enable_stage_transition(**kwargs)

1. See EnableStageTransitionInputRequestTypeDef

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)
    ...

1. See ActionCategoryType
2. See GetActionTypeOutputTypeDef

# get_action_type method usage example with argument unpacking

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

parent.get_action_type(**kwargs)

1. See GetActionTypeInputRequestTypeDef

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)
    ...

1. See GetJobDetailsOutputTypeDef

# get_job_details method usage example with argument unpacking

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

parent.get_job_details(**kwargs)

1. See GetJobDetailsInputRequestTypeDef

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

# get_pipeline method definition

def get_pipeline(
    self,
    *,
    name: str,
    version: int = ...,
) -> GetPipelineOutputTypeDef:  # (1)
    ...

1. See GetPipelineOutputTypeDef

# get_pipeline method usage example with argument unpacking

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

parent.get_pipeline(**kwargs)

1. See GetPipelineInputRequestTypeDef

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

# get_pipeline_execution method definition

def get_pipeline_execution(
    self,
    *,
    pipelineName: str,
    pipelineExecutionId: str,
) -> GetPipelineExecutionOutputTypeDef:  # (1)
    ...

1. See GetPipelineExecutionOutputTypeDef

# get_pipeline_execution method usage example with argument unpacking

kwargs: GetPipelineExecutionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "pipelineExecutionId": ...,
}

parent.get_pipeline_execution(**kwargs)

1. See GetPipelineExecutionInputRequestTypeDef

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

# get_pipeline_state method definition

def get_pipeline_state(
    self,
    *,
    name: str,
) -> GetPipelineStateOutputTypeDef:  # (1)
    ...

1. See GetPipelineStateOutputTypeDef

# get_pipeline_state method usage example with argument unpacking

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

parent.get_pipeline_state(**kwargs)

1. See GetPipelineStateInputRequestTypeDef

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

# get_third_party_job_details method definition

def get_third_party_job_details(
    self,
    *,
    jobId: str,
    clientToken: str,
) -> GetThirdPartyJobDetailsOutputTypeDef:  # (1)
    ...

1. See GetThirdPartyJobDetailsOutputTypeDef

# get_third_party_job_details method usage example with argument unpacking

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

parent.get_third_party_job_details(**kwargs)

1. See GetThirdPartyJobDetailsInputRequestTypeDef

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

# list_action_executions method definition

def list_action_executions(
    self,
    *,
    pipelineName: str,
    filter: ActionExecutionFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListActionExecutionsOutputTypeDef:  # (2)
    ...

1. See ActionExecutionFilterTypeDef
2. See ListActionExecutionsOutputTypeDef

# list_action_executions method usage example with argument unpacking

kwargs: ListActionExecutionsInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
}

parent.list_action_executions(**kwargs)

1. See ListActionExecutionsInputRequestTypeDef

list_action_types

Gets a summary of all CodePipeline action types associated with your account.

Type annotations and code completion for boto3.client("codepipeline").list_action_types method. boto3 documentation

# list_action_types method definition

def list_action_types(
    self,
    *,
    actionOwnerFilter: ActionOwnerType = ...,  # (1)
    nextToken: str = ...,
    regionFilter: str = ...,
) -> ListActionTypesOutputTypeDef:  # (2)
    ...

1. See ActionOwnerType
2. See ListActionTypesOutputTypeDef

# list_action_types method usage example with argument unpacking

kwargs: ListActionTypesInputRequestTypeDef = {  # (1)
    "actionOwnerFilter": ...,
}

parent.list_action_types(**kwargs)

1. See ListActionTypesInputRequestTypeDef

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

# list_pipeline_executions method definition

def list_pipeline_executions(
    self,
    *,
    pipelineName: str,
    maxResults: int = ...,
    filter: PipelineExecutionFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
) -> ListPipelineExecutionsOutputTypeDef:  # (2)
    ...

1. See PipelineExecutionFilterTypeDef
2. See ListPipelineExecutionsOutputTypeDef

# list_pipeline_executions method usage example with argument unpacking

kwargs: ListPipelineExecutionsInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
}

parent.list_pipeline_executions(**kwargs)

1. See ListPipelineExecutionsInputRequestTypeDef

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

# list_pipelines method definition

def list_pipelines(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPipelinesOutputTypeDef:  # (1)
    ...

1. See ListPipelinesOutputTypeDef

# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_pipelines(**kwargs)

1. See ListPipelinesInputRequestTypeDef

list_rule_executions

Lists the rule executions that have occurred in a pipeline configured for conditions with rules.

Type annotations and code completion for boto3.client("codepipeline").list_rule_executions method. boto3 documentation

# list_rule_executions method definition

def list_rule_executions(
    self,
    *,
    pipelineName: str,
    filter: RuleExecutionFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRuleExecutionsOutputTypeDef:  # (2)
    ...

1. See RuleExecutionFilterTypeDef
2. See ListRuleExecutionsOutputTypeDef

# list_rule_executions method usage example with argument unpacking

kwargs: ListRuleExecutionsInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
}

parent.list_rule_executions(**kwargs)

1. See ListRuleExecutionsInputRequestTypeDef

list_rule_types

Lists the rules for the condition.

Type annotations and code completion for boto3.client("codepipeline").list_rule_types method. boto3 documentation

# list_rule_types method definition

def list_rule_types(
    self,
    *,
    ruleOwnerFilter: RuleOwnerType = ...,  # (1)
    regionFilter: str = ...,
) -> ListRuleTypesOutputTypeDef:  # (2)
    ...

1. See RuleOwnerType
2. See ListRuleTypesOutputTypeDef

# list_rule_types method usage example with argument unpacking

kwargs: ListRuleTypesInputRequestTypeDef = {  # (1)
    "ruleOwnerFilter": ...,
}

parent.list_rule_types(**kwargs)

1. See ListRuleTypesInputRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

list_webhooks

Gets a listing of all the webhooks in this Amazon Web Services Region for this account.

Type annotations and code completion for boto3.client("codepipeline").list_webhooks method. boto3 documentation

# list_webhooks method definition

def list_webhooks(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWebhooksOutputTypeDef:  # (1)
    ...

1. See ListWebhooksOutputTypeDef

# list_webhooks method usage example with argument unpacking

kwargs: ListWebhooksInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_webhooks(**kwargs)

1. See ListWebhooksInputRequestTypeDef

override_stage_condition

Used to override a stage condition.

Type annotations and code completion for boto3.client("codepipeline").override_stage_condition method. boto3 documentation

# override_stage_condition method definition

def override_stage_condition(
    self,
    *,
    pipelineName: str,
    stageName: str,
    pipelineExecutionId: str,
    conditionType: ConditionTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ConditionTypeType
2. See EmptyResponseMetadataTypeDef

# override_stage_condition method usage example with argument unpacking

kwargs: OverrideStageConditionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "pipelineExecutionId": ...,
    "conditionType": ...,
}

parent.override_stage_condition(**kwargs)

1. See OverrideStageConditionInputRequestTypeDef

poll_for_jobs

Returns information about any jobs for CodePipeline to act on.

Type annotations and code completion for boto3.client("codepipeline").poll_for_jobs method. boto3 documentation

# poll_for_jobs method definition

def poll_for_jobs(
    self,
    *,
    actionTypeId: ActionTypeIdTypeDef,  # (1)
    maxBatchSize: int = ...,
    queryParam: Mapping[str, str] = ...,
) -> PollForJobsOutputTypeDef:  # (2)
    ...

1. See ActionTypeIdTypeDef
2. See PollForJobsOutputTypeDef

# poll_for_jobs method usage example with argument unpacking

kwargs: PollForJobsInputRequestTypeDef = {  # (1)
    "actionTypeId": ...,
}

parent.poll_for_jobs(**kwargs)

1. See PollForJobsInputRequestTypeDef

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

# poll_for_third_party_jobs method definition

def poll_for_third_party_jobs(
    self,
    *,
    actionTypeId: ActionTypeIdTypeDef,  # (1)
    maxBatchSize: int = ...,
) -> PollForThirdPartyJobsOutputTypeDef:  # (2)
    ...

1. See ActionTypeIdTypeDef
2. See PollForThirdPartyJobsOutputTypeDef

# poll_for_third_party_jobs method usage example with argument unpacking

kwargs: PollForThirdPartyJobsInputRequestTypeDef = {  # (1)
    "actionTypeId": ...,
}

parent.poll_for_third_party_jobs(**kwargs)

1. See PollForThirdPartyJobsInputRequestTypeDef

put_action_revision

Provides information to CodePipeline about new revisions to a source.

Type annotations and code completion for boto3.client("codepipeline").put_action_revision method. boto3 documentation

# put_action_revision method definition

def put_action_revision(
    self,
    *,
    pipelineName: str,
    stageName: str,
    actionName: str,
    actionRevision: ActionRevisionTypeDef,  # (1)
) -> PutActionRevisionOutputTypeDef:  # (2)
    ...

1. See ActionRevisionTypeDef
2. See PutActionRevisionOutputTypeDef

# put_action_revision method usage example with argument unpacking

kwargs: PutActionRevisionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "actionName": ...,
    "actionRevision": ...,
}

parent.put_action_revision(**kwargs)

1. See PutActionRevisionInputRequestTypeDef

put_approval_result

Provides the response to a manual approval request to CodePipeline.

Type annotations and code completion for boto3.client("codepipeline").put_approval_result method. boto3 documentation

# put_approval_result method definition

def put_approval_result(
    self,
    *,
    pipelineName: str,
    stageName: str,
    actionName: str,
    result: ApprovalResultTypeDef,  # (1)
    token: str,
) -> PutApprovalResultOutputTypeDef:  # (2)
    ...

1. See ApprovalResultTypeDef
2. See PutApprovalResultOutputTypeDef

# put_approval_result method usage example with argument unpacking

kwargs: PutApprovalResultInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "actionName": ...,
    "result": ...,
    "token": ...,
}

parent.put_approval_result(**kwargs)

1. See PutApprovalResultInputRequestTypeDef

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

# put_job_failure_result method definition

def put_job_failure_result(
    self,
    *,
    jobId: str,
    failureDetails: FailureDetailsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See FailureDetailsTypeDef
2. See EmptyResponseMetadataTypeDef

# put_job_failure_result method usage example with argument unpacking

kwargs: PutJobFailureResultInputRequestTypeDef = {  # (1)
    "jobId": ...,
    "failureDetails": ...,
}

parent.put_job_failure_result(**kwargs)

1. See PutJobFailureResultInputRequestTypeDef

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

# put_job_success_result method definition

def put_job_success_result(
    self,
    *,
    jobId: str,
    currentRevision: CurrentRevisionTypeDef = ...,  # (1)
    continuationToken: str = ...,
    executionDetails: ExecutionDetailsTypeDef = ...,  # (2)
    outputVariables: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See CurrentRevisionTypeDef
2. See ExecutionDetailsTypeDef
3. See EmptyResponseMetadataTypeDef

# put_job_success_result method usage example with argument unpacking

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

parent.put_job_success_result(**kwargs)

1. See PutJobSuccessResultInputRequestTypeDef

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

# put_third_party_job_failure_result method definition

def put_third_party_job_failure_result(
    self,
    *,
    jobId: str,
    clientToken: str,
    failureDetails: FailureDetailsTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See FailureDetailsTypeDef
2. See EmptyResponseMetadataTypeDef

# put_third_party_job_failure_result method usage example with argument unpacking

kwargs: PutThirdPartyJobFailureResultInputRequestTypeDef = {  # (1)
    "jobId": ...,
    "clientToken": ...,
    "failureDetails": ...,
}

parent.put_third_party_job_failure_result(**kwargs)

1. See PutThirdPartyJobFailureResultInputRequestTypeDef

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

# put_third_party_job_success_result method definition

def put_third_party_job_success_result(
    self,
    *,
    jobId: str,
    clientToken: str,
    currentRevision: CurrentRevisionTypeDef = ...,  # (1)
    continuationToken: str = ...,
    executionDetails: ExecutionDetailsTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See CurrentRevisionTypeDef
2. See ExecutionDetailsTypeDef
3. See EmptyResponseMetadataTypeDef

# put_third_party_job_success_result method usage example with argument unpacking

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

parent.put_third_party_job_success_result(**kwargs)

1. See PutThirdPartyJobSuccessResultInputRequestTypeDef

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

# put_webhook method definition

def put_webhook(
    self,
    *,
    webhook: WebhookDefinitionTypeDef,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> PutWebhookOutputTypeDef:  # (3)
    ...

1. See WebhookDefinitionTypeDef
2. See TagTypeDef
3. See PutWebhookOutputTypeDef

# put_webhook method usage example with argument unpacking

kwargs: PutWebhookInputRequestTypeDef = {  # (1)
    "webhook": ...,
}

parent.put_webhook(**kwargs)

1. See PutWebhookInputRequestTypeDef

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

# register_webhook_with_third_party method definition

def register_webhook_with_third_party(
    self,
    *,
    webhookName: str = ...,
) -> Dict[str, Any]:
    ...

# register_webhook_with_third_party method usage example with argument unpacking

kwargs: RegisterWebhookWithThirdPartyInputRequestTypeDef = {  # (1)
    "webhookName": ...,
}

parent.register_webhook_with_third_party(**kwargs)

1. See RegisterWebhookWithThirdPartyInputRequestTypeDef

retry_stage_execution

You can retry a stage that has failed without having to run a pipeline again from the beginning.

Type annotations and code completion for boto3.client("codepipeline").retry_stage_execution method. boto3 documentation

# retry_stage_execution method definition

def retry_stage_execution(
    self,
    *,
    pipelineName: str,
    stageName: str,
    pipelineExecutionId: str,
    retryMode: StageRetryModeType,  # (1)
) -> RetryStageExecutionOutputTypeDef:  # (2)
    ...

1. See StageRetryModeType
2. See RetryStageExecutionOutputTypeDef

# retry_stage_execution method usage example with argument unpacking

kwargs: RetryStageExecutionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "pipelineExecutionId": ...,
    "retryMode": ...,
}

parent.retry_stage_execution(**kwargs)

1. See RetryStageExecutionInputRequestTypeDef

rollback_stage

Rolls back a stage execution.

Type annotations and code completion for boto3.client("codepipeline").rollback_stage method. boto3 documentation

# rollback_stage method definition

def rollback_stage(
    self,
    *,
    pipelineName: str,
    stageName: str,
    targetPipelineExecutionId: str,
) -> RollbackStageOutputTypeDef:  # (1)
    ...

1. See RollbackStageOutputTypeDef

# rollback_stage method usage example with argument unpacking

kwargs: RollbackStageInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "stageName": ...,
    "targetPipelineExecutionId": ...,
}

parent.rollback_stage(**kwargs)

1. See RollbackStageInputRequestTypeDef

start_pipeline_execution

Starts the specified pipeline.

Type annotations and code completion for boto3.client("codepipeline").start_pipeline_execution method. boto3 documentation

# start_pipeline_execution method definition

def start_pipeline_execution(
    self,
    *,
    name: str,
    variables: Sequence[PipelineVariableTypeDef] = ...,  # (1)
    clientRequestToken: str = ...,
    sourceRevisions: Sequence[SourceRevisionOverrideTypeDef] = ...,  # (2)
) -> StartPipelineExecutionOutputTypeDef:  # (3)
    ...

1. See PipelineVariableTypeDef
2. See SourceRevisionOverrideTypeDef
3. See StartPipelineExecutionOutputTypeDef

# start_pipeline_execution method usage example with argument unpacking

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

parent.start_pipeline_execution(**kwargs)

1. See StartPipelineExecutionInputRequestTypeDef

stop_pipeline_execution

Stops the specified pipeline execution.

Type annotations and code completion for boto3.client("codepipeline").stop_pipeline_execution method. boto3 documentation

# stop_pipeline_execution method definition

def stop_pipeline_execution(
    self,
    *,
    pipelineName: str,
    pipelineExecutionId: str,
    abandon: bool = ...,
    reason: str = ...,
) -> StopPipelineExecutionOutputTypeDef:  # (1)
    ...

1. See StopPipelineExecutionOutputTypeDef

# stop_pipeline_execution method usage example with argument unpacking

kwargs: StopPipelineExecutionInputRequestTypeDef = {  # (1)
    "pipelineName": ...,
    "pipelineExecutionId": ...,
}

parent.stop_pipeline_execution(**kwargs)

1. See StopPipelineExecutionInputRequestTypeDef

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes tags from an Amazon Web Services resource.

Type annotations and code completion for boto3.client("codepipeline").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

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

# update_action_type method definition

def update_action_type(
    self,
    *,
    actionType: ActionTypeDeclarationTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActionTypeDeclarationTypeDef
2. See EmptyResponseMetadataTypeDef

# update_action_type method usage example with argument unpacking

kwargs: UpdateActionTypeInputRequestTypeDef = {  # (1)
    "actionType": ...,
}

parent.update_action_type(**kwargs)

1. See UpdateActionTypeInputRequestTypeDef

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

# update_pipeline method definition

def update_pipeline(
    self,
    *,
    pipeline: PipelineDeclarationTypeDef,  # (1)
) -> UpdatePipelineOutputTypeDef:  # (2)
    ...

1. See PipelineDeclarationTypeDef
2. See UpdatePipelineOutputTypeDef

# update_pipeline method usage example with argument unpacking

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

parent.update_pipeline(**kwargs)

1. See UpdatePipelineInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("codepipeline").get_paginator method with overloads.

• client.get_paginator("list_action_executions") -> ListActionExecutionsPaginator
• client.get_paginator("list_action_types") -> ListActionTypesPaginator
• client.get_paginator("list_pipeline_executions") -> ListPipelineExecutionsPaginator
• client.get_paginator("list_pipelines") -> ListPipelinesPaginator
• client.get_paginator("list_rule_executions") -> ListRuleExecutionsPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("list_webhooks") -> ListWebhooksPaginator