CodePipelineClient

Index > CodePipeline > CodePipelineClient

Auto-generated documentation for CodePipeline type annotations stubs module types-aiobotocore-codepipeline.

CodePipelineClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_codepipeline.client import CodePipelineClient

session = Session()
async with session.client("codepipeline") as client:
    client: CodePipelineClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("codepipeline").exceptions structure.

Usage example

async with session.client("codepipeline") as client:
    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)

Type checking example

from types_aiobotocore_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 session.client("codepipeline").acknowledge_job method. boto3 documentation

Method definition

await def acknowledge_job(
    self,
    *,
    jobId: str,
    nonce: str,
) -> AcknowledgeJobOutputTypeDef:  # (1)
    ...

1. See AcknowledgeJobOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").acknowledge_third_party_job method. boto3 documentation

Method definition

await def acknowledge_third_party_job(
    self,
    *,
    jobId: str,
    nonce: str,
    clientToken: str,
) -> AcknowledgeThirdPartyJobOutputTypeDef:  # (1)
    ...

1. See AcknowledgeThirdPartyJobOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

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

Method definition

await def close(
    self,
) -> None:
    ...

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 session.client("codepipeline").create_custom_action_type method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("codepipeline").create_pipeline method. boto3 documentation

Method definition

await def create_pipeline(
    self,
    *,
    pipeline: PipelineDeclarationTypeDef,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreatePipelineOutputTypeDef:  # (3)
    ...

1. See PipelineDeclarationTypeDef
2. See TagTypeDef
3. See CreatePipelineOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").delete_custom_action_type method. boto3 documentation

Method definition

await def delete_custom_action_type(
    self,
    *,
    category: ActionCategoryType,  # (1)
    provider: str,
    version: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActionCategoryType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").delete_pipeline method. boto3 documentation

Method definition

await def delete_pipeline(
    self,
    *,
    name: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").delete_webhook method. boto3 documentation

Method definition

await def delete_webhook(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("codepipeline").deregister_webhook_with_third_party method. boto3 documentation

Method definition

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

Usage example with kwargs

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 session.client("codepipeline").disable_stage_transition method. boto3 documentation

Method definition

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

1. See StageTransitionTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").enable_stage_transition method. boto3 documentation

Method definition

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

1. See StageTransitionTypeType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("codepipeline").get_action_type method. boto3 documentation

Method definition

await def get_action_type(
    self,
    *,
    category: ActionCategoryType,  # (1)
    owner: str,
    provider: str,
    version: str,
) -> GetActionTypeOutputTypeDef:  # (2)
    ...

1. See ActionCategoryType
2. See GetActionTypeOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").get_job_details method. boto3 documentation

Method definition

await def get_job_details(
    self,
    *,
    jobId: str,
) -> GetJobDetailsOutputTypeDef:  # (1)
    ...

1. See GetJobDetailsOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").get_pipeline method. boto3 documentation

Method definition

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

1. See GetPipelineOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").get_pipeline_execution method. boto3 documentation

Method definition

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

1. See GetPipelineExecutionOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").get_pipeline_state method. boto3 documentation

Method definition

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

1. See GetPipelineStateOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").get_third_party_job_details method. boto3 documentation

Method definition

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

1. See GetThirdPartyJobDetailsOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").list_action_executions method. boto3 documentation

Method definition

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

1. See ActionExecutionFilterTypeDef
2. See ListActionExecutionsOutputTypeDef

Usage example with kwargs

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

parent.list_action_executions(**kwargs)

1. See ListActionExecutionsInputRequestTypeDef

list_action_types

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

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

Method definition

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

1. See ActionOwnerType
2. See ListActionTypesOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").list_pipeline_executions method. boto3 documentation

Method definition

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

1. See ListPipelineExecutionsOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").list_pipelines method. boto3 documentation

Method definition

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

1. See ListPipelinesOutputTypeDef

Usage example with kwargs

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

parent.list_pipelines(**kwargs)

1. See ListPipelinesInputRequestTypeDef

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 session.client("codepipeline").list_tags_for_resource method. boto3 documentation

Method definition

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

1. See ListTagsForResourceOutputTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

list_webhooks

Gets a listing of all the webhooks in this AWS Region for this account.

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

Method definition

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

1. See ListWebhooksOutputTypeDef

Usage example with kwargs

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

parent.list_webhooks(**kwargs)

1. See ListWebhooksInputRequestTypeDef

poll_for_jobs

Returns information about any jobs for AWS CodePipeline to act on.

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

Method definition

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

1. See ActionTypeIdTypeDef
2. See PollForJobsOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").poll_for_third_party_jobs method. boto3 documentation

Method definition

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

1. See ActionTypeIdTypeDef
2. See PollForThirdPartyJobsOutputTypeDef

Usage example with kwargs

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

parent.poll_for_third_party_jobs(**kwargs)

1. See PollForThirdPartyJobsInputRequestTypeDef

put_action_revision

Provides information to AWS CodePipeline about new revisions to a source.

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

Method definition

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

1. See ActionRevisionTypeDef
2. See PutActionRevisionOutputTypeDef

Usage example with kwargs

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 AWS CodePipeline.

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

Method definition

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

1. See ApprovalResultTypeDef
2. See PutApprovalResultOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").put_job_failure_result method. boto3 documentation

Method definition

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

1. See FailureDetailsTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").put_job_success_result method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("codepipeline").put_third_party_job_failure_result method. boto3 documentation

Method definition

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

1. See FailureDetailsTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").put_third_party_job_success_result method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("codepipeline").put_webhook method. boto3 documentation

Method definition

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

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

Usage example with kwargs

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 session.client("codepipeline").register_webhook_with_third_party method. boto3 documentation

Method definition

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

Usage example with kwargs

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

parent.register_webhook_with_third_party(**kwargs)

1. See RegisterWebhookWithThirdPartyInputRequestTypeDef

retry_stage_execution

Resumes the pipeline execution by retrying the last failed actions in a stage.

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

Method definition

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

1. See StageRetryModeType
2. See RetryStageExecutionOutputTypeDef

Usage example with kwargs

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

parent.retry_stage_execution(**kwargs)

1. See RetryStageExecutionInputRequestTypeDef

start_pipeline_execution

Starts the specified pipeline.

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

Method definition

await def start_pipeline_execution(
    self,
    *,
    name: str,
    clientRequestToken: str = ...,
) -> StartPipelineExecutionOutputTypeDef:  # (1)
    ...

1. See StartPipelineExecutionOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").stop_pipeline_execution method. boto3 documentation

Method definition

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

1. See StopPipelineExecutionOutputTypeDef

Usage example with kwargs

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 session.client("codepipeline").tag_resource method. boto3 documentation

Method definition

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

1. See TagTypeDef

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes tags from an AWS resource.

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

Method definition

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

Usage example with kwargs

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 session.client("codepipeline").update_action_type method. boto3 documentation

Method definition

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

1. See ActionTypeDeclarationTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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 session.client("codepipeline").update_pipeline method. boto3 documentation

Method definition

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

1. See PipelineDeclarationTypeDef
2. See UpdatePipelineOutputTypeDef

Usage example with kwargs

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

parent.update_pipeline(**kwargs)

1. See UpdatePipelineInputRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> CodePipelineClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.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_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("list_webhooks") -> ListWebhooksPaginator