CodePipelineClient#
Index > CodePipeline > CodePipelineClient
Auto-generated documentation for CodePipeline type annotations stubs module types-aiobotocore-codepipeline.
CodePipelineClient#
Type annotations and code completion for session.create_client("codepipeline")
boto3 documentation
CodePipelineClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_codepipeline.client import CodePipelineClient
session = get_session()
async with session.create_client("codepipeline") as client:
client: CodePipelineClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("codepipeline").exceptions
structure.
CodePipelineClient.exceptions usage example
async with session.create_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)
CodePipelineClient usage 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.create_client("codepipeline").acknowledge_job
method.
boto3 documentation
# acknowledge_job method definition
await 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 session.create_client("codepipeline").acknowledge_third_party_job
method.
boto3 documentation
# acknowledge_third_party_job method definition
await 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 session.create_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 session.create_client("codepipeline").close
method.
boto3 documentation
# close 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 Amazon Web Services account.
Type annotations and code completion for session.create_client("codepipeline").create_custom_action_type
method.
boto3 documentation
# create_custom_action_type 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)
...
- 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 session.create_client("codepipeline").create_pipeline
method.
boto3 documentation
# create_pipeline method definition
await 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 session.create_client("codepipeline").delete_custom_action_type
method.
boto3 documentation
# delete_custom_action_type method definition
await 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 session.create_client("codepipeline").delete_pipeline
method.
boto3 documentation
# delete_pipeline method definition
await 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 session.create_client("codepipeline").delete_webhook
method.
boto3 documentation
# delete_webhook method definition
await 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 session.create_client("codepipeline").deregister_webhook_with_third_party
method.
boto3 documentation
# deregister_webhook_with_third_party method definition
await 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 session.create_client("codepipeline").disable_stage_transition
method.
boto3 documentation
# disable_stage_transition method definition
await 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 session.create_client("codepipeline").enable_stage_transition
method.
boto3 documentation
# enable_stage_transition method definition
await 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 session.create_client("codepipeline").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url 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.create_client("codepipeline").get_action_type
method.
boto3 documentation
# get_action_type method definition
await 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 session.create_client("codepipeline").get_job_details
method.
boto3 documentation
# get_job_details method definition
await 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 session.create_client("codepipeline").get_pipeline
method.
boto3 documentation
# get_pipeline method definition
await def get_pipeline(
self,
*,
name: str,
version: int = ...,
) -> GetPipelineOutputTypeDef: # (1)
...
# get_pipeline method usage example with argument unpacking
kwargs: GetPipelineInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_pipeline(**kwargs)
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.create_client("codepipeline").get_pipeline_execution
method.
boto3 documentation
# get_pipeline_execution method definition
await def get_pipeline_execution(
self,
*,
pipelineName: str,
pipelineExecutionId: str,
) -> GetPipelineExecutionOutputTypeDef: # (1)
...
# get_pipeline_execution method usage example with argument unpacking
kwargs: GetPipelineExecutionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"pipelineExecutionId": ...,
}
parent.get_pipeline_execution(**kwargs)
get_pipeline_state#
Returns information about the state of a pipeline, including the stages and actions.
Type annotations and code completion for session.create_client("codepipeline").get_pipeline_state
method.
boto3 documentation
# get_pipeline_state method definition
await def get_pipeline_state(
self,
*,
name: str,
) -> GetPipelineStateOutputTypeDef: # (1)
...
# get_pipeline_state method usage example with argument unpacking
kwargs: GetPipelineStateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_pipeline_state(**kwargs)
get_third_party_job_details#
Requests the details of a job for a third party action.
Type annotations and code completion for session.create_client("codepipeline").get_third_party_job_details
method.
boto3 documentation
# get_third_party_job_details method definition
await def get_third_party_job_details(
self,
*,
jobId: str,
clientToken: str,
) -> GetThirdPartyJobDetailsOutputTypeDef: # (1)
...
# get_third_party_job_details method usage example with argument unpacking
kwargs: GetThirdPartyJobDetailsInputRequestTypeDef = { # (1)
"jobId": ...,
"clientToken": ...,
}
parent.get_third_party_job_details(**kwargs)
list_action_executions#
Lists the action executions that have occurred in a pipeline.
Type annotations and code completion for session.create_client("codepipeline").list_action_executions
method.
boto3 documentation
# list_action_executions method definition
await def list_action_executions(
self,
*,
pipelineName: str,
filter: ActionExecutionFilterTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListActionExecutionsOutputTypeDef: # (2)
...
# list_action_executions method usage example with argument unpacking
kwargs: ListActionExecutionsInputRequestTypeDef = { # (1)
"pipelineName": ...,
}
parent.list_action_executions(**kwargs)
list_action_types#
Gets a summary of all CodePipeline action types associated with your account.
Type annotations and code completion for session.create_client("codepipeline").list_action_types
method.
boto3 documentation
# list_action_types method definition
await def list_action_types(
self,
*,
actionOwnerFilter: ActionOwnerType = ..., # (1)
nextToken: str = ...,
regionFilter: str = ...,
) -> ListActionTypesOutputTypeDef: # (2)
...
# list_action_types method usage example with argument unpacking
kwargs: ListActionTypesInputRequestTypeDef = { # (1)
"actionOwnerFilter": ...,
}
parent.list_action_types(**kwargs)
list_pipeline_executions#
Gets a summary of the most recent executions for a pipeline.
Type annotations and code completion for session.create_client("codepipeline").list_pipeline_executions
method.
boto3 documentation
# list_pipeline_executions method definition
await def list_pipeline_executions(
self,
*,
pipelineName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPipelineExecutionsOutputTypeDef: # (1)
...
# list_pipeline_executions method usage example with argument unpacking
kwargs: ListPipelineExecutionsInputRequestTypeDef = { # (1)
"pipelineName": ...,
}
parent.list_pipeline_executions(**kwargs)
list_pipelines#
Gets a summary of all of the pipelines associated with your account.
Type annotations and code completion for session.create_client("codepipeline").list_pipelines
method.
boto3 documentation
# list_pipelines method definition
await def list_pipelines(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPipelinesOutputTypeDef: # (1)
...
# list_pipelines method usage example with argument unpacking
kwargs: ListPipelinesInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_pipelines(**kwargs)
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.create_client("codepipeline").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_webhooks#
Gets a listing of all the webhooks in this Amazon Web Services Region for this account.
Type annotations and code completion for session.create_client("codepipeline").list_webhooks
method.
boto3 documentation
# list_webhooks method definition
await def list_webhooks(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListWebhooksOutputTypeDef: # (1)
...
# list_webhooks method usage example with argument unpacking
kwargs: ListWebhooksInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_webhooks(**kwargs)
poll_for_jobs#
Returns information about any jobs for CodePipeline to act on.
Type annotations and code completion for session.create_client("codepipeline").poll_for_jobs
method.
boto3 documentation
# poll_for_jobs method definition
await def poll_for_jobs(
self,
*,
actionTypeId: ActionTypeIdTypeDef, # (1)
maxBatchSize: int = ...,
queryParam: Mapping[str, str] = ...,
) -> PollForJobsOutputTypeDef: # (2)
...
# poll_for_jobs method usage example with argument unpacking
kwargs: PollForJobsInputRequestTypeDef = { # (1)
"actionTypeId": ...,
}
parent.poll_for_jobs(**kwargs)
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.create_client("codepipeline").poll_for_third_party_jobs
method.
boto3 documentation
# poll_for_third_party_jobs method definition
await def poll_for_third_party_jobs(
self,
*,
actionTypeId: ActionTypeIdTypeDef, # (1)
maxBatchSize: int = ...,
) -> PollForThirdPartyJobsOutputTypeDef: # (2)
...
# poll_for_third_party_jobs method usage example with argument unpacking
kwargs: PollForThirdPartyJobsInputRequestTypeDef = { # (1)
"actionTypeId": ...,
}
parent.poll_for_third_party_jobs(**kwargs)
put_action_revision#
Provides information to CodePipeline about new revisions to a source.
Type annotations and code completion for session.create_client("codepipeline").put_action_revision
method.
boto3 documentation
# put_action_revision method definition
await def put_action_revision(
self,
*,
pipelineName: str,
stageName: str,
actionName: str,
actionRevision: ActionRevisionTypeDef, # (1)
) -> PutActionRevisionOutputTypeDef: # (2)
...
# put_action_revision method usage example with argument unpacking
kwargs: PutActionRevisionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"actionName": ...,
"actionRevision": ...,
}
parent.put_action_revision(**kwargs)
put_approval_result#
Provides the response to a manual approval request to CodePipeline.
Type annotations and code completion for session.create_client("codepipeline").put_approval_result
method.
boto3 documentation
# put_approval_result method definition
await def put_approval_result(
self,
*,
pipelineName: str,
stageName: str,
actionName: str,
result: ApprovalResultTypeDef, # (1)
token: str,
) -> PutApprovalResultOutputTypeDef: # (2)
...
# put_approval_result method usage example with argument unpacking
kwargs: PutApprovalResultInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"actionName": ...,
"result": ...,
"token": ...,
}
parent.put_approval_result(**kwargs)
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.create_client("codepipeline").put_job_failure_result
method.
boto3 documentation
# put_job_failure_result method definition
await def put_job_failure_result(
self,
*,
jobId: str,
failureDetails: FailureDetailsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# put_job_failure_result method usage example with argument unpacking
kwargs: PutJobFailureResultInputRequestTypeDef = { # (1)
"jobId": ...,
"failureDetails": ...,
}
parent.put_job_failure_result(**kwargs)
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.create_client("codepipeline").put_job_success_result
method.
boto3 documentation
# put_job_success_result 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)
...
# put_job_success_result method usage example with argument unpacking
kwargs: PutJobSuccessResultInputRequestTypeDef = { # (1)
"jobId": ...,
}
parent.put_job_success_result(**kwargs)
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.create_client("codepipeline").put_third_party_job_failure_result
method.
boto3 documentation
# put_third_party_job_failure_result method definition
await def put_third_party_job_failure_result(
self,
*,
jobId: str,
clientToken: str,
failureDetails: FailureDetailsTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# 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)
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.create_client("codepipeline").put_third_party_job_success_result
method.
boto3 documentation
# put_third_party_job_success_result 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)
...
# 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)
put_webhook#
Defines a webhook and returns a unique webhook URL generated by CodePipeline.
Type annotations and code completion for session.create_client("codepipeline").put_webhook
method.
boto3 documentation
# put_webhook method definition
await def put_webhook(
self,
*,
webhook: WebhookDefinitionTypeDef, # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> PutWebhookOutputTypeDef: # (3)
...
# put_webhook method usage example with argument unpacking
kwargs: PutWebhookInputRequestTypeDef = { # (1)
"webhook": ...,
}
parent.put_webhook(**kwargs)
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.create_client("codepipeline").register_webhook_with_third_party
method.
boto3 documentation
# register_webhook_with_third_party method definition
await 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)
retry_stage_execution#
Resumes the pipeline execution by retrying the last failed actions in a stage.
Type annotations and code completion for session.create_client("codepipeline").retry_stage_execution
method.
boto3 documentation
# retry_stage_execution method definition
await def retry_stage_execution(
self,
*,
pipelineName: str,
stageName: str,
pipelineExecutionId: str,
retryMode: StageRetryModeType, # (1)
) -> RetryStageExecutionOutputTypeDef: # (2)
...
# retry_stage_execution method usage example with argument unpacking
kwargs: RetryStageExecutionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"stageName": ...,
"pipelineExecutionId": ...,
"retryMode": ...,
}
parent.retry_stage_execution(**kwargs)
start_pipeline_execution#
Starts the specified pipeline.
Type annotations and code completion for session.create_client("codepipeline").start_pipeline_execution
method.
boto3 documentation
# start_pipeline_execution method definition
await def start_pipeline_execution(
self,
*,
name: str,
clientRequestToken: str = ...,
) -> StartPipelineExecutionOutputTypeDef: # (1)
...
# start_pipeline_execution method usage example with argument unpacking
kwargs: StartPipelineExecutionInputRequestTypeDef = { # (1)
"name": ...,
}
parent.start_pipeline_execution(**kwargs)
stop_pipeline_execution#
Stops the specified pipeline execution.
Type annotations and code completion for session.create_client("codepipeline").stop_pipeline_execution
method.
boto3 documentation
# stop_pipeline_execution method definition
await def stop_pipeline_execution(
self,
*,
pipelineName: str,
pipelineExecutionId: str,
abandon: bool = ...,
reason: str = ...,
) -> StopPipelineExecutionOutputTypeDef: # (1)
...
# stop_pipeline_execution method usage example with argument unpacking
kwargs: StopPipelineExecutionInputRequestTypeDef = { # (1)
"pipelineName": ...,
"pipelineExecutionId": ...,
}
parent.stop_pipeline_execution(**kwargs)
tag_resource#
Adds to or modifies the tags of the given resource.
Type annotations and code completion for session.create_client("codepipeline").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes tags from an Amazon Web Services resource.
Type annotations and code completion for session.create_client("codepipeline").untag_resource
method.
boto3 documentation
# untag_resource method definition
await 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)
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.create_client("codepipeline").update_action_type
method.
boto3 documentation
# update_action_type method definition
await def update_action_type(
self,
*,
actionType: ActionTypeDeclarationTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_action_type method usage example with argument unpacking
kwargs: UpdateActionTypeInputRequestTypeDef = { # (1)
"actionType": ...,
}
parent.update_action_type(**kwargs)
update_pipeline#
Updates a specified pipeline with edits or changes to its structure.
Type annotations and code completion for session.create_client("codepipeline").update_pipeline
method.
boto3 documentation
# update_pipeline method definition
await def update_pipeline(
self,
*,
pipeline: PipelineDeclarationTypeDef, # (1)
) -> UpdatePipelineOutputTypeDef: # (2)
...
# update_pipeline method usage example with argument unpacking
kwargs: UpdatePipelineInputRequestTypeDef = { # (1)
"pipeline": ...,
}
parent.update_pipeline(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("codepipeline").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CodePipelineClient:
...
__aexit__#
Type annotations and code completion for session.create_client("codepipeline").__aexit__
method.
boto3 documentation
# __aexit__ 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.create_client("codepipeline").get_paginator
method with overloads.
client.get_paginator("list_action_executions")
-> ListActionExecutionsPaginatorclient.get_paginator("list_action_types")
-> ListActionTypesPaginatorclient.get_paginator("list_pipeline_executions")
-> ListPipelineExecutionsPaginatorclient.get_paginator("list_pipelines")
-> ListPipelinesPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("list_webhooks")
-> ListWebhooksPaginator