ProtonClient#
Auto-generated documentation for Proton type annotations stubs module mypy-boto3-proton.
ProtonClient#
Type annotations and code completion for boto3.client("proton")
.
boto3 documentation
# ProtonClient usage example
from boto3.session import Session
from mypy_boto3_proton.client import ProtonClient
def get_proton_client() -> ProtonClient:
return Session().client("proton")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("proton").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("proton")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_proton.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
accept_environment_account_connection#
In a management account, an environment account connection request is accepted.
Type annotations and code completion for boto3.client("proton").accept_environment_account_connection
method.
boto3 documentation
# accept_environment_account_connection method definition
def accept_environment_account_connection(
self,
*,
id: str,
) -> AcceptEnvironmentAccountConnectionOutputTypeDef: # (1)
...
# accept_environment_account_connection method usage example with argument unpacking
kwargs: AcceptEnvironmentAccountConnectionInputRequestTypeDef = { # (1)
"id": ...,
}
parent.accept_environment_account_connection(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("proton").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_component_deployment#
Attempts to cancel a component deployment (for a component that is in the
IN_PROGRESS
deployment
status).
Type annotations and code completion for boto3.client("proton").cancel_component_deployment
method.
boto3 documentation
# cancel_component_deployment method definition
def cancel_component_deployment(
self,
*,
componentName: str,
) -> CancelComponentDeploymentOutputTypeDef: # (1)
...
# cancel_component_deployment method usage example with argument unpacking
kwargs: CancelComponentDeploymentInputRequestTypeDef = { # (1)
"componentName": ...,
}
parent.cancel_component_deployment(**kwargs)
cancel_environment_deployment#
Attempts to cancel an environment deployment on an UpdateEnvironment action,
if the deployment is
IN_PROGRESS
.
Type annotations and code completion for boto3.client("proton").cancel_environment_deployment
method.
boto3 documentation
# cancel_environment_deployment method definition
def cancel_environment_deployment(
self,
*,
environmentName: str,
) -> CancelEnvironmentDeploymentOutputTypeDef: # (1)
...
# cancel_environment_deployment method usage example with argument unpacking
kwargs: CancelEnvironmentDeploymentInputRequestTypeDef = { # (1)
"environmentName": ...,
}
parent.cancel_environment_deployment(**kwargs)
cancel_service_instance_deployment#
Attempts to cancel a service instance deployment on an UpdateServiceInstance
action, if the deployment is
IN_PROGRESS
.
Type annotations and code completion for boto3.client("proton").cancel_service_instance_deployment
method.
boto3 documentation
# cancel_service_instance_deployment method definition
def cancel_service_instance_deployment(
self,
*,
serviceInstanceName: str,
serviceName: str,
) -> CancelServiceInstanceDeploymentOutputTypeDef: # (1)
...
# cancel_service_instance_deployment method usage example with argument unpacking
kwargs: CancelServiceInstanceDeploymentInputRequestTypeDef = { # (1)
"serviceInstanceName": ...,
"serviceName": ...,
}
parent.cancel_service_instance_deployment(**kwargs)
cancel_service_pipeline_deployment#
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline
action, if the deployment is
IN_PROGRESS
.
Type annotations and code completion for boto3.client("proton").cancel_service_pipeline_deployment
method.
boto3 documentation
# cancel_service_pipeline_deployment method definition
def cancel_service_pipeline_deployment(
self,
*,
serviceName: str,
) -> CancelServicePipelineDeploymentOutputTypeDef: # (1)
...
# cancel_service_pipeline_deployment method usage example with argument unpacking
kwargs: CancelServicePipelineDeploymentInputRequestTypeDef = { # (1)
"serviceName": ...,
}
parent.cancel_service_pipeline_deployment(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("proton").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_component#
Create an Proton component.
Type annotations and code completion for boto3.client("proton").create_component
method.
boto3 documentation
# create_component method definition
def create_component(
self,
*,
manifest: str,
name: str,
templateFile: str,
clientToken: str = ...,
description: str = ...,
environmentName: str = ...,
serviceInstanceName: str = ...,
serviceName: str = ...,
serviceSpec: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateComponentOutputTypeDef: # (2)
...
# create_component method usage example with argument unpacking
kwargs: CreateComponentInputRequestTypeDef = { # (1)
"manifest": ...,
"name": ...,
"templateFile": ...,
}
parent.create_component(**kwargs)
create_environment#
Deploy a new environment.
Type annotations and code completion for boto3.client("proton").create_environment
method.
boto3 documentation
# create_environment method definition
def create_environment(
self,
*,
name: str,
spec: str,
templateMajorVersion: str,
templateName: str,
codebuildRoleArn: str = ...,
componentRoleArn: str = ...,
description: str = ...,
environmentAccountConnectionId: str = ...,
protonServiceRoleArn: str = ...,
provisioningRepository: RepositoryBranchInputTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
templateMinorVersion: str = ...,
) -> CreateEnvironmentOutputTypeDef: # (3)
...
# create_environment method usage example with argument unpacking
kwargs: CreateEnvironmentInputRequestTypeDef = { # (1)
"name": ...,
"spec": ...,
"templateMajorVersion": ...,
"templateName": ...,
}
parent.create_environment(**kwargs)
create_environment_account_connection#
Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
Type annotations and code completion for boto3.client("proton").create_environment_account_connection
method.
boto3 documentation
# create_environment_account_connection method definition
def create_environment_account_connection(
self,
*,
environmentName: str,
managementAccountId: str,
clientToken: str = ...,
codebuildRoleArn: str = ...,
componentRoleArn: str = ...,
roleArn: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateEnvironmentAccountConnectionOutputTypeDef: # (2)
...
# create_environment_account_connection method usage example with argument unpacking
kwargs: CreateEnvironmentAccountConnectionInputRequestTypeDef = { # (1)
"environmentName": ...,
"managementAccountId": ...,
}
parent.create_environment_account_connection(**kwargs)
create_environment_template#
Create an environment template for Proton.
Type annotations and code completion for boto3.client("proton").create_environment_template
method.
boto3 documentation
# create_environment_template method definition
def create_environment_template(
self,
*,
name: str,
description: str = ...,
displayName: str = ...,
encryptionKey: str = ...,
provisioning: ProvisioningType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateEnvironmentTemplateOutputTypeDef: # (3)
...
# create_environment_template method usage example with argument unpacking
kwargs: CreateEnvironmentTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.create_environment_template(**kwargs)