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
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.
client = boto3.client("proton")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
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
def accept_environment_account_connection(
self,
*,
id: str,
) -> AcceptEnvironmentAccountConnectionOutputTypeDef: # (1)
...
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
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
def cancel_component_deployment(
self,
*,
componentName: str,
) -> CancelComponentDeploymentOutputTypeDef: # (1)
...
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
def cancel_environment_deployment(
self,
*,
environmentName: str,
) -> CancelEnvironmentDeploymentOutputTypeDef: # (1)
...
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
def cancel_service_instance_deployment(
self,
*,
serviceInstanceName: str,
serviceName: str,
) -> CancelServiceInstanceDeploymentOutputTypeDef: # (1)
...
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
def cancel_service_pipeline_deployment(
self,
*,
serviceName: str,
) -> CancelServicePipelineDeploymentOutputTypeDef: # (1)
...
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
create_component
Create an Proton component.
Type annotations and code completion for boto3.client("proton").create_component
method.
boto3 documentation
def create_component(
self,
*,
manifest: str,
name: str,
templateFile: str,
description: str = ...,
environmentName: str = ...,
serviceInstanceName: str = ...,
serviceName: str = ...,
serviceSpec: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateComponentOutputTypeDef: # (2)
...
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
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)
...
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
def create_environment_account_connection(
self,
*,
environmentName: str,
managementAccountId: str,
clientToken: str = ...,
codebuildRoleArn: str = ...,
componentRoleArn: str = ...,
roleArn: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateEnvironmentAccountConnectionOutputTypeDef: # (2)
...
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
def create_environment_template(
self,
*,
name: str,
description: str = ...,
displayName: str = ...,
encryptionKey: str = ...,
provisioning: ProvisioningType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateEnvironmentTemplateOutputTypeDef: # (3)
...
kwargs: CreateEnvironmentTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.create_environment_template(**kwargs)
create_environment_template_version
Create a new major or minor version of an environment template.
Type annotations and code completion for boto3.client("proton").create_environment_template_version
method.
boto3 documentation
def create_environment_template_version(
self,
*,
source: TemplateVersionSourceInputTypeDef, # (1)
templateName: str,
clientToken: str = ...,
description: str = ...,
majorVersion: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateEnvironmentTemplateVersionOutputTypeDef: # (3)
...
- See TemplateVersionSourceInputTypeDef
- See TagTypeDef
- See CreateEnvironmentTemplateVersionOutputTypeDef
kwargs: CreateEnvironmentTemplateVersionInputRequestTypeDef = { # (1)
"source": ...,
"templateName": ...,
}
parent.create_environment_template_version(**kwargs)
create_repository
Create and register a link to a repository.
Type annotations and code completion for boto3.client("proton").create_repository
method.
boto3 documentation
def create_repository(
self,
*,
connectionArn: str,
name: str,
provider: RepositoryProviderType, # (1)
encryptionKey: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateRepositoryOutputTypeDef: # (3)
...
kwargs: CreateRepositoryInputRequestTypeDef = { # (1)
"connectionArn": ...,
"name": ...,
"provider": ...,
}
parent.create_repository(**kwargs)
create_service
Create an Proton service.
Type annotations and code completion for boto3.client("proton").create_service
method.
boto3 documentation
def create_service(
self,
*,
name: str,
spec: str,
templateMajorVersion: str,
templateName: str,
branchName: str = ...,
description: str = ...,
repositoryConnectionArn: str = ...,
repositoryId: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
templateMinorVersion: str = ...,
) -> CreateServiceOutputTypeDef: # (2)
...
- See TagTypeDef
- See CreateServiceOutputTypeDef
kwargs: CreateServiceInputRequestTypeDef = { # (1)
"name": ...,
"spec": ...,
"templateMajorVersion": ...,
"templateName": ...,
}
parent.create_service(**kwargs)
create_service_template
Create a service template.
Type annotations and code completion for boto3.client("proton").create_service_template
method.
boto3 documentation
def create_service_template(
self,
*,
name: str,
description: str = ...,
displayName: str = ...,
encryptionKey: str = ...,
pipelineProvisioning: ProvisioningType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateServiceTemplateOutputTypeDef: # (3)
...
kwargs: CreateServiceTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.create_service_template(**kwargs)
create_service_template_version
Create a new major or minor version of a service template.
Type annotations and code completion for boto3.client("proton").create_service_template_version
method.
boto3 documentation
def create_service_template_version(
self,
*,
compatibleEnvironmentTemplates: Sequence[CompatibleEnvironmentTemplateInputTypeDef], # (1)
source: TemplateVersionSourceInputTypeDef, # (2)
templateName: str,
clientToken: str = ...,
description: str = ...,
majorVersion: str = ...,
supportedComponentSources: Sequence[ServiceTemplateSupportedComponentSourceTypeType] = ..., # (3)
tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateServiceTemplateVersionOutputTypeDef: # (5)
...
- See CompatibleEnvironmentTemplateInputTypeDef
- See TemplateVersionSourceInputTypeDef
- See ServiceTemplateSupportedComponentSourceTypeType
- See TagTypeDef
- See CreateServiceTemplateVersionOutputTypeDef
kwargs: CreateServiceTemplateVersionInputRequestTypeDef = { # (1)
"compatibleEnvironmentTemplates": ...,
"source": ...,
"templateName": ...,
}
parent.create_service_template_version(**kwargs)
create_template_sync_config
Set up a template to create new template versions automatically by tracking a linked repository.
Type annotations and code completion for boto3.client("proton").create_template_sync_config
method.
boto3 documentation
def create_template_sync_config(
self,
*,
branch: str,
repositoryName: str,
repositoryProvider: RepositoryProviderType, # (1)
templateName: str,
templateType: TemplateTypeType, # (2)
subdirectory: str = ...,
) -> CreateTemplateSyncConfigOutputTypeDef: # (3)
...
kwargs: CreateTemplateSyncConfigInputRequestTypeDef = { # (1)
"branch": ...,
"repositoryName": ...,
"repositoryProvider": ...,
"templateName": ...,
"templateType": ...,
}
parent.create_template_sync_config(**kwargs)
delete_component
Delete an Proton component resource.
Type annotations and code completion for boto3.client("proton").delete_component
method.
boto3 documentation
def delete_component(
self,
*,
name: str,
) -> DeleteComponentOutputTypeDef: # (1)
...
kwargs: DeleteComponentInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_component(**kwargs)
delete_environment
Delete an environment.
Type annotations and code completion for boto3.client("proton").delete_environment
method.
boto3 documentation
def delete_environment(
self,
*,
name: str,
) -> DeleteEnvironmentOutputTypeDef: # (1)
...
kwargs: DeleteEnvironmentInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_environment(**kwargs)
delete_environment_account_connection
In an environment account, delete an environment account connection.
Type annotations and code completion for boto3.client("proton").delete_environment_account_connection
method.
boto3 documentation
def delete_environment_account_connection(
self,
*,
id: str,
) -> DeleteEnvironmentAccountConnectionOutputTypeDef: # (1)
...
kwargs: DeleteEnvironmentAccountConnectionInputRequestTypeDef = { # (1)
"id": ...,
}
parent.delete_environment_account_connection(**kwargs)
delete_environment_template
If no other major or minor versions of an environment template exist, delete the environment template.
Type annotations and code completion for boto3.client("proton").delete_environment_template
method.
boto3 documentation
def delete_environment_template(
self,
*,
name: str,
) -> DeleteEnvironmentTemplateOutputTypeDef: # (1)
...
kwargs: DeleteEnvironmentTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_environment_template(**kwargs)
delete_environment_template_version
If no other minor versions of an environment template exist, delete a major
version of the environment template if it's not the Recommended
version.
Type annotations and code completion for boto3.client("proton").delete_environment_template_version
method.
boto3 documentation
def delete_environment_template_version(
self,
*,
majorVersion: str,
minorVersion: str,
templateName: str,
) -> DeleteEnvironmentTemplateVersionOutputTypeDef: # (1)
...
kwargs: DeleteEnvironmentTemplateVersionInputRequestTypeDef = { # (1)
"majorVersion": ...,
"minorVersion": ...,
"templateName": ...,
}
parent.delete_environment_template_version(**kwargs)
delete_repository
De-register and unlink your repository.
Type annotations and code completion for boto3.client("proton").delete_repository
method.
boto3 documentation
def delete_repository(
self,
*,
name: str,
provider: RepositoryProviderType, # (1)
) -> DeleteRepositoryOutputTypeDef: # (2)
...
kwargs: DeleteRepositoryInputRequestTypeDef = { # (1)
"name": ...,
"provider": ...,
}
parent.delete_repository(**kwargs)
delete_service
Delete a service, with its instances and pipeline.
Type annotations and code completion for boto3.client("proton").delete_service
method.
boto3 documentation
kwargs: DeleteServiceInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_service(**kwargs)
delete_service_template
If no other major or minor versions of the service template exist, delete the service template.
Type annotations and code completion for boto3.client("proton").delete_service_template
method.
boto3 documentation
def delete_service_template(
self,
*,
name: str,
) -> DeleteServiceTemplateOutputTypeDef: # (1)
...
kwargs: DeleteServiceTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_service_template(**kwargs)
delete_service_template_version
If no other minor versions of a service template exist, delete a major version
of the service template if it's not the Recommended
version.
Type annotations and code completion for boto3.client("proton").delete_service_template_version
method.
boto3 documentation
def delete_service_template_version(
self,
*,
majorVersion: str,
minorVersion: str,
templateName: str,
) -> DeleteServiceTemplateVersionOutputTypeDef: # (1)
...
kwargs: DeleteServiceTemplateVersionInputRequestTypeDef = { # (1)
"majorVersion": ...,
"minorVersion": ...,
"templateName": ...,
}
parent.delete_service_template_version(**kwargs)
delete_template_sync_config
Delete a template sync configuration.
Type annotations and code completion for boto3.client("proton").delete_template_sync_config
method.
boto3 documentation
def delete_template_sync_config(
self,
*,
templateName: str,
templateType: TemplateTypeType, # (1)
) -> DeleteTemplateSyncConfigOutputTypeDef: # (2)
...
kwargs: DeleteTemplateSyncConfigInputRequestTypeDef = { # (1)
"templateName": ...,
"templateType": ...,
}
parent.delete_template_sync_config(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("proton").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_account_settings
Get detail data for Proton account-wide settings.
Type annotations and code completion for boto3.client("proton").get_account_settings
method.
boto3 documentation
get_component
Get detailed data for a component.
Type annotations and code completion for boto3.client("proton").get_component
method.
boto3 documentation
kwargs: GetComponentInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_component(**kwargs)
get_environment
Get detailed data for an environment.
Type annotations and code completion for boto3.client("proton").get_environment
method.
boto3 documentation
def get_environment(
self,
*,
name: str,
) -> GetEnvironmentOutputTypeDef: # (1)
...
kwargs: GetEnvironmentInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_environment(**kwargs)
get_environment_account_connection
In an environment account, get the detailed data for an environment account connection.
Type annotations and code completion for boto3.client("proton").get_environment_account_connection
method.
boto3 documentation
def get_environment_account_connection(
self,
*,
id: str,
) -> GetEnvironmentAccountConnectionOutputTypeDef: # (1)
...
kwargs: GetEnvironmentAccountConnectionInputRequestTypeDef = { # (1)
"id": ...,
}
parent.get_environment_account_connection(**kwargs)
get_environment_template
Get detailed data for an environment template.
Type annotations and code completion for boto3.client("proton").get_environment_template
method.
boto3 documentation
def get_environment_template(
self,
*,
name: str,
) -> GetEnvironmentTemplateOutputTypeDef: # (1)
...
kwargs: GetEnvironmentTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_environment_template(**kwargs)
get_environment_template_version
Get detailed data for a major or minor version of an environment template.
Type annotations and code completion for boto3.client("proton").get_environment_template_version
method.
boto3 documentation
def get_environment_template_version(
self,
*,
majorVersion: str,
minorVersion: str,
templateName: str,
) -> GetEnvironmentTemplateVersionOutputTypeDef: # (1)
...
kwargs: GetEnvironmentTemplateVersionInputRequestTypeDef = { # (1)
"majorVersion": ...,
"minorVersion": ...,
"templateName": ...,
}
parent.get_environment_template_version(**kwargs)
get_repository
Get detail data for a linked repository.
Type annotations and code completion for boto3.client("proton").get_repository
method.
boto3 documentation
def get_repository(
self,
*,
name: str,
provider: RepositoryProviderType, # (1)
) -> GetRepositoryOutputTypeDef: # (2)
...
kwargs: GetRepositoryInputRequestTypeDef = { # (1)
"name": ...,
"provider": ...,
}
parent.get_repository(**kwargs)
get_repository_sync_status
Get the sync status of a repository used for Proton template sync.
Type annotations and code completion for boto3.client("proton").get_repository_sync_status
method.
boto3 documentation
def get_repository_sync_status(
self,
*,
branch: str,
repositoryName: str,
repositoryProvider: RepositoryProviderType, # (1)
syncType: SyncTypeType, # (2)
) -> GetRepositorySyncStatusOutputTypeDef: # (3)
...
kwargs: GetRepositorySyncStatusInputRequestTypeDef = { # (1)
"branch": ...,
"repositoryName": ...,
"repositoryProvider": ...,
"syncType": ...,
}
parent.get_repository_sync_status(**kwargs)
get_resources_summary
Get counts of Proton resources.
Type annotations and code completion for boto3.client("proton").get_resources_summary
method.
boto3 documentation
get_service
Get detailed data for a service.
Type annotations and code completion for boto3.client("proton").get_service
method.
boto3 documentation
kwargs: GetServiceInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_service(**kwargs)
get_service_instance
Get detailed data for a service instance.
Type annotations and code completion for boto3.client("proton").get_service_instance
method.
boto3 documentation
def get_service_instance(
self,
*,
name: str,
serviceName: str,
) -> GetServiceInstanceOutputTypeDef: # (1)
...
kwargs: GetServiceInstanceInputRequestTypeDef = { # (1)
"name": ...,
"serviceName": ...,
}
parent.get_service_instance(**kwargs)
get_service_template
Get detailed data for a service template.
Type annotations and code completion for boto3.client("proton").get_service_template
method.
boto3 documentation
def get_service_template(
self,
*,
name: str,
) -> GetServiceTemplateOutputTypeDef: # (1)
...
kwargs: GetServiceTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.get_service_template(**kwargs)
get_service_template_version
Get detailed data for a major or minor version of a service template.
Type annotations and code completion for boto3.client("proton").get_service_template_version
method.
boto3 documentation
def get_service_template_version(
self,
*,
majorVersion: str,
minorVersion: str,
templateName: str,
) -> GetServiceTemplateVersionOutputTypeDef: # (1)
...
kwargs: GetServiceTemplateVersionInputRequestTypeDef = { # (1)
"majorVersion": ...,
"minorVersion": ...,
"templateName": ...,
}
parent.get_service_template_version(**kwargs)
get_template_sync_config
Get detail data for a template sync configuration.
Type annotations and code completion for boto3.client("proton").get_template_sync_config
method.
boto3 documentation
def get_template_sync_config(
self,
*,
templateName: str,
templateType: TemplateTypeType, # (1)
) -> GetTemplateSyncConfigOutputTypeDef: # (2)
...
kwargs: GetTemplateSyncConfigInputRequestTypeDef = { # (1)
"templateName": ...,
"templateType": ...,
}
parent.get_template_sync_config(**kwargs)
get_template_sync_status
Get the status of a template sync.
Type annotations and code completion for boto3.client("proton").get_template_sync_status
method.
boto3 documentation
def get_template_sync_status(
self,
*,
templateName: str,
templateType: TemplateTypeType, # (1)
templateVersion: str,
) -> GetTemplateSyncStatusOutputTypeDef: # (2)
...
kwargs: GetTemplateSyncStatusInputRequestTypeDef = { # (1)
"templateName": ...,
"templateType": ...,
"templateVersion": ...,
}
parent.get_template_sync_status(**kwargs)
list_component_outputs
Get a list of component Infrastructure as Code (IaC) outputs.
Type annotations and code completion for boto3.client("proton").list_component_outputs
method.
boto3 documentation
def list_component_outputs(
self,
*,
componentName: str,
nextToken: str = ...,
) -> ListComponentOutputsOutputTypeDef: # (1)
...
kwargs: ListComponentOutputsInputRequestTypeDef = { # (1)
"componentName": ...,
}
parent.list_component_outputs(**kwargs)
list_component_provisioned_resources
List provisioned resources for a component with details.
Type annotations and code completion for boto3.client("proton").list_component_provisioned_resources
method.
boto3 documentation
def list_component_provisioned_resources(
self,
*,
componentName: str,
nextToken: str = ...,
) -> ListComponentProvisionedResourcesOutputTypeDef: # (1)
...
kwargs: ListComponentProvisionedResourcesInputRequestTypeDef = { # (1)
"componentName": ...,
}
parent.list_component_provisioned_resources(**kwargs)
list_components
List components with summary data.
Type annotations and code completion for boto3.client("proton").list_components
method.
boto3 documentation
def list_components(
self,
*,
environmentName: str = ...,
maxResults: int = ...,
nextToken: str = ...,
serviceInstanceName: str = ...,
serviceName: str = ...,
) -> ListComponentsOutputTypeDef: # (1)
...
kwargs: ListComponentsInputRequestTypeDef = { # (1)
"environmentName": ...,
}
parent.list_components(**kwargs)
list_environment_account_connections
View a list of environment account connections.
Type annotations and code completion for boto3.client("proton").list_environment_account_connections
method.
boto3 documentation
def list_environment_account_connections(
self,
*,
requestedBy: EnvironmentAccountConnectionRequesterAccountTypeType, # (1)
environmentName: str = ...,
maxResults: int = ...,
nextToken: str = ...,
statuses: Sequence[EnvironmentAccountConnectionStatusType] = ..., # (2)
) -> ListEnvironmentAccountConnectionsOutputTypeDef: # (3)
...
- See EnvironmentAccountConnectionRequesterAccountTypeType
- See EnvironmentAccountConnectionStatusType
- See ListEnvironmentAccountConnectionsOutputTypeDef
kwargs: ListEnvironmentAccountConnectionsInputRequestTypeDef = { # (1)
"requestedBy": ...,
}
parent.list_environment_account_connections(**kwargs)
list_environment_outputs
List the infrastructure as code outputs for your environment.
Type annotations and code completion for boto3.client("proton").list_environment_outputs
method.
boto3 documentation
def list_environment_outputs(
self,
*,
environmentName: str,
nextToken: str = ...,
) -> ListEnvironmentOutputsOutputTypeDef: # (1)
...
kwargs: ListEnvironmentOutputsInputRequestTypeDef = { # (1)
"environmentName": ...,
}
parent.list_environment_outputs(**kwargs)
list_environment_provisioned_resources
List the provisioned resources for your environment.
Type annotations and code completion for boto3.client("proton").list_environment_provisioned_resources
method.
boto3 documentation
def list_environment_provisioned_resources(
self,
*,
environmentName: str,
nextToken: str = ...,
) -> ListEnvironmentProvisionedResourcesOutputTypeDef: # (1)
...
kwargs: ListEnvironmentProvisionedResourcesInputRequestTypeDef = { # (1)
"environmentName": ...,
}
parent.list_environment_provisioned_resources(**kwargs)
list_environment_template_versions
List major or minor versions of an environment template with detail data.
Type annotations and code completion for boto3.client("proton").list_environment_template_versions
method.
boto3 documentation
def list_environment_template_versions(
self,
*,
templateName: str,
majorVersion: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListEnvironmentTemplateVersionsOutputTypeDef: # (1)
...
kwargs: ListEnvironmentTemplateVersionsInputRequestTypeDef = { # (1)
"templateName": ...,
}
parent.list_environment_template_versions(**kwargs)
list_environment_templates
List environment templates.
Type annotations and code completion for boto3.client("proton").list_environment_templates
method.
boto3 documentation
def list_environment_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListEnvironmentTemplatesOutputTypeDef: # (1)
...
kwargs: ListEnvironmentTemplatesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_environment_templates(**kwargs)
list_environments
List environments with detail data summaries.
Type annotations and code completion for boto3.client("proton").list_environments
method.
boto3 documentation
def list_environments(
self,
*,
environmentTemplates: Sequence[EnvironmentTemplateFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListEnvironmentsOutputTypeDef: # (2)
...
kwargs: ListEnvironmentsInputRequestTypeDef = { # (1)
"environmentTemplates": ...,
}
parent.list_environments(**kwargs)
list_repositories
List linked repositories with detail data.
Type annotations and code completion for boto3.client("proton").list_repositories
method.
boto3 documentation
def list_repositories(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListRepositoriesOutputTypeDef: # (1)
...
kwargs: ListRepositoriesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_repositories(**kwargs)
list_repository_sync_definitions
List repository sync definitions with detail data.
Type annotations and code completion for boto3.client("proton").list_repository_sync_definitions
method.
boto3 documentation
def list_repository_sync_definitions(
self,
*,
repositoryName: str,
repositoryProvider: RepositoryProviderType, # (1)
syncType: SyncTypeType, # (2)
nextToken: str = ...,
) -> ListRepositorySyncDefinitionsOutputTypeDef: # (3)
...
kwargs: ListRepositorySyncDefinitionsInputRequestTypeDef = { # (1)
"repositoryName": ...,
"repositoryProvider": ...,
"syncType": ...,
}
parent.list_repository_sync_definitions(**kwargs)
list_service_instance_outputs
Get a list service of instance Infrastructure as Code (IaC) outputs.
Type annotations and code completion for boto3.client("proton").list_service_instance_outputs
method.
boto3 documentation
def list_service_instance_outputs(
self,
*,
serviceInstanceName: str,
serviceName: str,
nextToken: str = ...,
) -> ListServiceInstanceOutputsOutputTypeDef: # (1)
...
kwargs: ListServiceInstanceOutputsInputRequestTypeDef = { # (1)
"serviceInstanceName": ...,
"serviceName": ...,
}
parent.list_service_instance_outputs(**kwargs)
list_service_instance_provisioned_resources
List provisioned resources for a service instance with details.
Type annotations and code completion for boto3.client("proton").list_service_instance_provisioned_resources
method.
boto3 documentation
def list_service_instance_provisioned_resources(
self,
*,
serviceInstanceName: str,
serviceName: str,
nextToken: str = ...,
) -> ListServiceInstanceProvisionedResourcesOutputTypeDef: # (1)
...
kwargs: ListServiceInstanceProvisionedResourcesInputRequestTypeDef = { # (1)
"serviceInstanceName": ...,
"serviceName": ...,
}
parent.list_service_instance_provisioned_resources(**kwargs)
list_service_instances
List service instances with summary data.
Type annotations and code completion for boto3.client("proton").list_service_instances
method.
boto3 documentation
def list_service_instances(
self,
*,
filters: Sequence[ListServiceInstancesFilterTypeDef] = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
serviceName: str = ...,
sortBy: ListServiceInstancesSortByType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
) -> ListServiceInstancesOutputTypeDef: # (4)
...
- See ListServiceInstancesFilterTypeDef
- See ListServiceInstancesSortByType
- See SortOrderType
- See ListServiceInstancesOutputTypeDef
kwargs: ListServiceInstancesInputRequestTypeDef = { # (1)
"filters": ...,
}
parent.list_service_instances(**kwargs)
list_service_pipeline_outputs
Get a list of service pipeline Infrastructure as Code (IaC) outputs.
Type annotations and code completion for boto3.client("proton").list_service_pipeline_outputs
method.
boto3 documentation
def list_service_pipeline_outputs(
self,
*,
serviceName: str,
nextToken: str = ...,
) -> ListServicePipelineOutputsOutputTypeDef: # (1)
...
kwargs: ListServicePipelineOutputsInputRequestTypeDef = { # (1)
"serviceName": ...,
}
parent.list_service_pipeline_outputs(**kwargs)
list_service_pipeline_provisioned_resources
List provisioned resources for a service and pipeline with details.
Type annotations and code completion for boto3.client("proton").list_service_pipeline_provisioned_resources
method.
boto3 documentation
def list_service_pipeline_provisioned_resources(
self,
*,
serviceName: str,
nextToken: str = ...,
) -> ListServicePipelineProvisionedResourcesOutputTypeDef: # (1)
...
kwargs: ListServicePipelineProvisionedResourcesInputRequestTypeDef = { # (1)
"serviceName": ...,
}
parent.list_service_pipeline_provisioned_resources(**kwargs)
list_service_template_versions
List major or minor versions of a service template with detail data.
Type annotations and code completion for boto3.client("proton").list_service_template_versions
method.
boto3 documentation
def list_service_template_versions(
self,
*,
templateName: str,
majorVersion: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListServiceTemplateVersionsOutputTypeDef: # (1)
...
kwargs: ListServiceTemplateVersionsInputRequestTypeDef = { # (1)
"templateName": ...,
}
parent.list_service_template_versions(**kwargs)
list_service_templates
List service templates with detail data.
Type annotations and code completion for boto3.client("proton").list_service_templates
method.
boto3 documentation
def list_service_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListServiceTemplatesOutputTypeDef: # (1)
...
kwargs: ListServiceTemplatesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_service_templates(**kwargs)
list_services
List services with summaries of detail data.
Type annotations and code completion for boto3.client("proton").list_services
method.
boto3 documentation
def list_services(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListServicesOutputTypeDef: # (1)
...
kwargs: ListServicesInputRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_services(**kwargs)
list_tags_for_resource
List tags for a resource.
Type annotations and code completion for boto3.client("proton").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
notify_resource_deployment_status_change
Notify Proton of status changes to a provisioned resource when you use self- managed provisioning.
Type annotations and code completion for boto3.client("proton").notify_resource_deployment_status_change
method.
boto3 documentation
def notify_resource_deployment_status_change(
self,
*,
resourceArn: str,
deploymentId: str = ...,
outputs: Sequence[OutputTypeDef] = ..., # (1)
status: ResourceDeploymentStatusType = ..., # (2)
statusMessage: str = ...,
) -> Dict[str, Any]:
...
kwargs: NotifyResourceDeploymentStatusChangeInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.notify_resource_deployment_status_change(**kwargs)
reject_environment_account_connection
In a management account, reject an environment account connection from another environment account.
Type annotations and code completion for boto3.client("proton").reject_environment_account_connection
method.
boto3 documentation
def reject_environment_account_connection(
self,
*,
id: str,
) -> RejectEnvironmentAccountConnectionOutputTypeDef: # (1)
...
kwargs: RejectEnvironmentAccountConnectionInputRequestTypeDef = { # (1)
"id": ...,
}
parent.reject_environment_account_connection(**kwargs)
tag_resource
Tag a resource.
Type annotations and code completion for boto3.client("proton").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Remove a customer tag from a resource.
Type annotations and code completion for boto3.client("proton").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_account_settings
Update Proton settings that are used for multiple services in the Amazon Web Services account.
Type annotations and code completion for boto3.client("proton").update_account_settings
method.
boto3 documentation
def update_account_settings(
self,
*,
deletePipelineProvisioningRepository: bool = ...,
pipelineCodebuildRoleArn: str = ...,
pipelineProvisioningRepository: RepositoryBranchInputTypeDef = ..., # (1)
pipelineServiceRoleArn: str = ...,
) -> UpdateAccountSettingsOutputTypeDef: # (2)
...
kwargs: UpdateAccountSettingsInputRequestTypeDef = { # (1)
"deletePipelineProvisioningRepository": ...,
}
parent.update_account_settings(**kwargs)
update_component
Update a component.
Type annotations and code completion for boto3.client("proton").update_component
method.
boto3 documentation
def update_component(
self,
*,
deploymentType: ComponentDeploymentUpdateTypeType, # (1)
name: str,
description: str = ...,
serviceInstanceName: str = ...,
serviceName: str = ...,
serviceSpec: str = ...,
templateFile: str = ...,
) -> UpdateComponentOutputTypeDef: # (2)
...
kwargs: UpdateComponentInputRequestTypeDef = { # (1)
"deploymentType": ...,
"name": ...,
}
parent.update_component(**kwargs)
update_environment
Update an environment.
Type annotations and code completion for boto3.client("proton").update_environment
method.
boto3 documentation
def update_environment(
self,
*,
deploymentType: DeploymentUpdateTypeType, # (1)
name: str,
codebuildRoleArn: str = ...,
componentRoleArn: str = ...,
description: str = ...,
environmentAccountConnectionId: str = ...,
protonServiceRoleArn: str = ...,
provisioningRepository: RepositoryBranchInputTypeDef = ..., # (2)
spec: str = ...,
templateMajorVersion: str = ...,
templateMinorVersion: str = ...,
) -> UpdateEnvironmentOutputTypeDef: # (3)
...
kwargs: UpdateEnvironmentInputRequestTypeDef = { # (1)
"deploymentType": ...,
"name": ...,
}
parent.update_environment(**kwargs)
update_environment_account_connection
In an environment account, update an environment account connection to use a new IAM role.
Type annotations and code completion for boto3.client("proton").update_environment_account_connection
method.
boto3 documentation
def update_environment_account_connection(
self,
*,
id: str,
codebuildRoleArn: str = ...,
componentRoleArn: str = ...,
roleArn: str = ...,
) -> UpdateEnvironmentAccountConnectionOutputTypeDef: # (1)
...
kwargs: UpdateEnvironmentAccountConnectionInputRequestTypeDef = { # (1)
"id": ...,
}
parent.update_environment_account_connection(**kwargs)
update_environment_template
Update an environment template.
Type annotations and code completion for boto3.client("proton").update_environment_template
method.
boto3 documentation
def update_environment_template(
self,
*,
name: str,
description: str = ...,
displayName: str = ...,
) -> UpdateEnvironmentTemplateOutputTypeDef: # (1)
...
kwargs: UpdateEnvironmentTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.update_environment_template(**kwargs)
update_environment_template_version
Update a major or minor version of an environment template.
Type annotations and code completion for boto3.client("proton").update_environment_template_version
method.
boto3 documentation
def update_environment_template_version(
self,
*,
majorVersion: str,
minorVersion: str,
templateName: str,
description: str = ...,
status: TemplateVersionStatusType = ..., # (1)
) -> UpdateEnvironmentTemplateVersionOutputTypeDef: # (2)
...
kwargs: UpdateEnvironmentTemplateVersionInputRequestTypeDef = { # (1)
"majorVersion": ...,
"minorVersion": ...,
"templateName": ...,
}
parent.update_environment_template_version(**kwargs)
update_service
Edit a service description or use a spec to add and delete service instances.
Type annotations and code completion for boto3.client("proton").update_service
method.
boto3 documentation
def update_service(
self,
*,
name: str,
description: str = ...,
spec: str = ...,
) -> UpdateServiceOutputTypeDef: # (1)
...
kwargs: UpdateServiceInputRequestTypeDef = { # (1)
"name": ...,
}
parent.update_service(**kwargs)
update_service_instance
Update a service instance.
Type annotations and code completion for boto3.client("proton").update_service_instance
method.
boto3 documentation
def update_service_instance(
self,
*,
deploymentType: DeploymentUpdateTypeType, # (1)
name: str,
serviceName: str,
spec: str = ...,
templateMajorVersion: str = ...,
templateMinorVersion: str = ...,
) -> UpdateServiceInstanceOutputTypeDef: # (2)
...
kwargs: UpdateServiceInstanceInputRequestTypeDef = { # (1)
"deploymentType": ...,
"name": ...,
"serviceName": ...,
}
parent.update_service_instance(**kwargs)
update_service_pipeline
Update the service pipeline.
Type annotations and code completion for boto3.client("proton").update_service_pipeline
method.
boto3 documentation
def update_service_pipeline(
self,
*,
deploymentType: DeploymentUpdateTypeType, # (1)
serviceName: str,
spec: str,
templateMajorVersion: str = ...,
templateMinorVersion: str = ...,
) -> UpdateServicePipelineOutputTypeDef: # (2)
...
kwargs: UpdateServicePipelineInputRequestTypeDef = { # (1)
"deploymentType": ...,
"serviceName": ...,
"spec": ...,
}
parent.update_service_pipeline(**kwargs)
update_service_template
Update a service template.
Type annotations and code completion for boto3.client("proton").update_service_template
method.
boto3 documentation
def update_service_template(
self,
*,
name: str,
description: str = ...,
displayName: str = ...,
) -> UpdateServiceTemplateOutputTypeDef: # (1)
...
kwargs: UpdateServiceTemplateInputRequestTypeDef = { # (1)
"name": ...,
}
parent.update_service_template(**kwargs)
update_service_template_version
Update a major or minor version of a service template.
Type annotations and code completion for boto3.client("proton").update_service_template_version
method.
boto3 documentation
def update_service_template_version(
self,
*,
majorVersion: str,
minorVersion: str,
templateName: str,
compatibleEnvironmentTemplates: Sequence[CompatibleEnvironmentTemplateInputTypeDef] = ..., # (1)
description: str = ...,
status: TemplateVersionStatusType = ..., # (2)
supportedComponentSources: Sequence[ServiceTemplateSupportedComponentSourceTypeType] = ..., # (3)
) -> UpdateServiceTemplateVersionOutputTypeDef: # (4)
...
- See CompatibleEnvironmentTemplateInputTypeDef
- See TemplateVersionStatusType
- See ServiceTemplateSupportedComponentSourceTypeType
- See UpdateServiceTemplateVersionOutputTypeDef
kwargs: UpdateServiceTemplateVersionInputRequestTypeDef = { # (1)
"majorVersion": ...,
"minorVersion": ...,
"templateName": ...,
}
parent.update_service_template_version(**kwargs)
update_template_sync_config
Update template sync configuration parameters, except for the templateName
and
templateType
.
Type annotations and code completion for boto3.client("proton").update_template_sync_config
method.
boto3 documentation
def update_template_sync_config(
self,
*,
branch: str,
repositoryName: str,
repositoryProvider: RepositoryProviderType, # (1)
templateName: str,
templateType: TemplateTypeType, # (2)
subdirectory: str = ...,
) -> UpdateTemplateSyncConfigOutputTypeDef: # (3)
...
kwargs: UpdateTemplateSyncConfigInputRequestTypeDef = { # (1)
"branch": ...,
"repositoryName": ...,
"repositoryProvider": ...,
"templateName": ...,
"templateType": ...,
}
parent.update_template_sync_config(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("proton").get_paginator
method with overloads.
client.get_paginator("list_component_outputs")
-> ListComponentOutputsPaginatorclient.get_paginator("list_component_provisioned_resources")
-> ListComponentProvisionedResourcesPaginatorclient.get_paginator("list_components")
-> ListComponentsPaginatorclient.get_paginator("list_environment_account_connections")
-> ListEnvironmentAccountConnectionsPaginatorclient.get_paginator("list_environment_outputs")
-> ListEnvironmentOutputsPaginatorclient.get_paginator("list_environment_provisioned_resources")
-> ListEnvironmentProvisionedResourcesPaginatorclient.get_paginator("list_environment_template_versions")
-> ListEnvironmentTemplateVersionsPaginatorclient.get_paginator("list_environment_templates")
-> ListEnvironmentTemplatesPaginatorclient.get_paginator("list_environments")
-> ListEnvironmentsPaginatorclient.get_paginator("list_repositories")
-> ListRepositoriesPaginatorclient.get_paginator("list_repository_sync_definitions")
-> ListRepositorySyncDefinitionsPaginatorclient.get_paginator("list_service_instance_outputs")
-> ListServiceInstanceOutputsPaginatorclient.get_paginator("list_service_instance_provisioned_resources")
-> ListServiceInstanceProvisionedResourcesPaginatorclient.get_paginator("list_service_instances")
-> ListServiceInstancesPaginatorclient.get_paginator("list_service_pipeline_outputs")
-> ListServicePipelineOutputsPaginatorclient.get_paginator("list_service_pipeline_provisioned_resources")
-> ListServicePipelineProvisionedResourcesPaginatorclient.get_paginator("list_service_template_versions")
-> ListServiceTemplateVersionsPaginatorclient.get_paginator("list_service_templates")
-> ListServiceTemplatesPaginatorclient.get_paginator("list_services")
-> ListServicesPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginator
get_waiter
Type annotations and code completion for boto3.client("proton").get_waiter
method with overloads.
client.get_waiter("component_deleted")
-> ComponentDeletedWaiterclient.get_waiter("component_deployed")
-> ComponentDeployedWaiterclient.get_waiter("environment_deployed")
-> EnvironmentDeployedWaiterclient.get_waiter("environment_template_version_registered")
-> EnvironmentTemplateVersionRegisteredWaiterclient.get_waiter("service_created")
-> ServiceCreatedWaiterclient.get_waiter("service_deleted")
-> ServiceDeletedWaiterclient.get_waiter("service_instance_deployed")
-> ServiceInstanceDeployedWaiterclient.get_waiter("service_pipeline_deployed")
-> ServicePipelineDeployedWaiterclient.get_waiter("service_template_version_registered")
-> ServiceTemplateVersionRegisteredWaiterclient.get_waiter("service_updated")
-> ServiceUpdatedWaiter