Skip to content

CodePipeline module#

Index > CodePipeline

Auto-generated documentation for CodePipeline type annotations stubs module mypy-boto3-codepipeline.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CodePipeline.

From PyPI with pip#

Install boto3-stubs for CodePipeline service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[codepipeline]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codepipeline]'


# standalone installation
python -m pip install mypy-boto3-codepipeline

How to uninstall#

python -m pip uninstall -y mypy-boto3-codepipeline

Usage#

Code samples can be found in Examples.

CodePipelineClient#

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

# CodePipelineClient usage example

from boto3.session import Session

from mypy_boto3_codepipeline.client import CodePipelineClient

def get_client() -> CodePipelineClient:
    return Session().client("codepipeline")

Paginators#

Type annotations and code completion for paginators from boto3.client("codepipeline").get_paginator("...").

# ListActionExecutionsPaginator usage example

from boto3.session import Session

from mypy_boto3_codepipeline.paginator import ListActionExecutionsPaginator

def get_list_action_executions_paginator() -> ListActionExecutionsPaginator:
    return Session().client("codepipeline").get_paginator("list_action_executions"))

Literals#

Type annotations for literals used in methods and schemas.

# ActionCategoryType usage example

from mypy_boto3_codepipeline.literals import ActionCategoryType

def get_value() -> ActionCategoryType:
    return "Approval"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AWSSessionCredentialsTypeDef usage example

from mypy_boto3_codepipeline.type_defs import AWSSessionCredentialsTypeDef

def get_value() -> AWSSessionCredentialsTypeDef:
    return {
        "accessKeyId": ...,
        "secretAccessKey": ...,
        "sessionToken": ...,
    }