Skip to content

ProtonClient#

Index > Proton > 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)
    ...
  1. See AcceptEnvironmentAccountConnectionOutputTypeDef 
# accept_environment_account_connection method usage example with argument unpacking

kwargs: AcceptEnvironmentAccountConnectionInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.accept_environment_account_connection(**kwargs)
  1. See AcceptEnvironmentAccountConnectionInputRequestTypeDef

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)
    ...
  1. See CancelComponentDeploymentOutputTypeDef 
# cancel_component_deployment method usage example with argument unpacking

kwargs: CancelComponentDeploymentInputRequestTypeDef = {  # (1)
    "componentName": ...,
}

parent.cancel_component_deployment(**kwargs)
  1. See CancelComponentDeploymentInputRequestTypeDef

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)
    ...
  1. See CancelEnvironmentDeploymentOutputTypeDef 
# cancel_environment_deployment method usage example with argument unpacking

kwargs: CancelEnvironmentDeploymentInputRequestTypeDef = {  # (1)
    "environmentName": ...,
}

parent.cancel_environment_deployment(**kwargs)
  1. See CancelEnvironmentDeploymentInputRequestTypeDef

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)
    ...
  1. See CancelServiceInstanceDeploymentOutputTypeDef 
# cancel_service_instance_deployment method usage example with argument unpacking

kwargs: CancelServiceInstanceDeploymentInputRequestTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

parent.cancel_service_instance_deployment(**kwargs)
  1. See CancelServiceInstanceDeploymentInputRequestTypeDef

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)
    ...
  1. See CancelServicePipelineDeploymentOutputTypeDef 
# cancel_service_pipeline_deployment method usage example with argument unpacking

kwargs: CancelServicePipelineDeploymentInputRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.cancel_service_pipeline_deployment(**kwargs)
  1. See CancelServicePipelineDeploymentInputRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateComponentOutputTypeDef 
# create_component method usage example with argument unpacking

kwargs: CreateComponentInputRequestTypeDef = {  # (1)
    "manifest": ...,
    "name": ...,
    "templateFile": ...,
}

parent.create_component(**kwargs)
  1. See CreateComponentInputRequestTypeDef

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)
    ...
  1. See RepositoryBranchInputTypeDef
  2. See TagTypeDef
  3. See CreateEnvironmentOutputTypeDef 
# create_environment method usage example with argument unpacking

kwargs: CreateEnvironmentInputRequestTypeDef = {  # (1)
    "name": ...,
    "spec": ...,
    "templateMajorVersion": ...,
    "templateName": ...,
}

parent.create_environment(**kwargs)
  1. See CreateEnvironmentInputRequestTypeDef

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)
    ...
  1. See TagTypeDef
  2. See CreateEnvironmentAccountConnectionOutputTypeDef 
# create_environment_account_connection method usage example with argument unpacking

kwargs: CreateEnvironmentAccountConnectionInputRequestTypeDef = {  # (1)
    "environmentName": ...,
    "managementAccountId": ...,
}

parent.create_environment_account_connection(**kwargs)
  1. See CreateEnvironmentAccountConnectionInputRequestTypeDef

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)
    ...
  1. See ProvisioningType
  2. See TagTypeDef
  3. See CreateEnvironmentTemplateOutputTypeDef 
# create_environment_template method usage example with argument unpacking

kwargs: CreateEnvironmentTemplateInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_environment_template(**kwargs)
  1. See CreateEnvironmentTemplateInputRequestTypeDef

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

# create_environment_template_version method definition

def create_environment_template_version(
    self,
    *,
    source: TemplateVersionSourceInputTypeDef,  # (1)
    templateName: str,
    clientToken: str = ...,
    description: str = ...,
    majorVersion: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateEnvironmentTemplateVersionOutputTypeDef:  # (3)
    ...
  1. See TemplateVersionSourceInputTypeDef
  2. See TagTypeDef
  3. See CreateEnvironmentTemplateVersionOutputTypeDef 
# create_environment_template_version method usage example with argument unpacking

kwargs: CreateEnvironmentTemplateVersionInputRequestTypeDef = {  # (1)
    "source": ...,
    "templateName": ...,
}

parent.create_environment_template_version(**kwargs)
  1. See CreateEnvironmentTemplateVersionInputRequestTypeDef

create_repository#

Create and register a link to a repository.

Type annotations and code completion for boto3.client("proton").create_repository method. boto3 documentation

# create_repository method definition

def create_repository(
    self,
    *,
    connectionArn: str,
    name: str,
    provider: RepositoryProviderType,  # (1)
    encryptionKey: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRepositoryOutputTypeDef:  # (3)
    ...
  1. See RepositoryProviderType
  2. See TagTypeDef
  3. See CreateRepositoryOutputTypeDef 
# create_repository method usage example with argument unpacking

kwargs: CreateRepositoryInputRequestTypeDef = {  # (1)
    "connectionArn": ...,
    "name": ...,
    "provider": ...,
}

parent.create_repository(**kwargs)
  1. See CreateRepositoryInputRequestTypeDef

create_service#

Create an Proton service.

Type annotations and code completion for boto3.client("proton").create_service method. boto3 documentation

# create_service method definition

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)
    ...
  1. See TagTypeDef
  2. See CreateServiceOutputTypeDef 
# create_service method usage example with argument unpacking

kwargs: CreateServiceInputRequestTypeDef = {  # (1)
    "name": ...,
    "spec": ...,
    "templateMajorVersion": ...,
    "templateName": ...,
}

parent.create_service(**kwargs)
  1. See CreateServiceInputRequestTypeDef

create_service_instance#

Create a service instance.

Type annotations and code completion for boto3.client("proton").create_service_instance method. boto3 documentation

# create_service_instance method definition

def create_service_instance(
    self,
    *,
    name: str,
    serviceName: str,
    spec: str,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    templateMajorVersion: str = ...,
    templateMinorVersion: str = ...,
) -> CreateServiceInstanceOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateServiceInstanceOutputTypeDef 
# create_service_instance method usage example with argument unpacking

kwargs: CreateServiceInstanceInputRequestTypeDef = {  # (1)
    "name": ...,
    "serviceName": ...,
    "spec": ...,
}

parent.create_service_instance(**kwargs)
  1. See CreateServiceInstanceInputRequestTypeDef

create_service_sync_config#

Create the Proton Ops configuration file.

Type annotations and code completion for boto3.client("proton").create_service_sync_config method. boto3 documentation

# create_service_sync_config method definition

def create_service_sync_config(
    self,
    *,
    branch: str,
    filePath: str,
    repositoryName: str,
    repositoryProvider: RepositoryProviderType,  # (1)
    serviceName: str,
) -> CreateServiceSyncConfigOutputTypeDef:  # (2)
    ...
  1. See RepositoryProviderType
  2. See CreateServiceSyncConfigOutputTypeDef 
# create_service_sync_config method usage example with argument unpacking

kwargs: CreateServiceSyncConfigInputRequestTypeDef = {  # (1)
    "branch": ...,
    "filePath": ...,
    "repositoryName": ...,
    "repositoryProvider": ...,
    "serviceName": ...,
}

parent.create_service_sync_config(**kwargs)
  1. See CreateServiceSyncConfigInputRequestTypeDef

create_service_template#

Create a service template.

Type annotations and code completion for boto3.client("proton").create_service_template method. boto3 documentation

# create_service_template method definition

def create_service_template(
    self,
    *,
    name: str,
    description: str = ...,
    displayName: str = ...,
    encryptionKey: str = ...,
    pipelineProvisioning: ProvisioningType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateServiceTemplateOutputTypeDef:  # (3)
    ...
  1. See ProvisioningType
  2. See TagTypeDef
  3. See CreateServiceTemplateOutputTypeDef 
# create_service_template method usage example with argument unpacking

kwargs: CreateServiceTemplateInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_service_template(**kwargs)
  1. See CreateServiceTemplateInputRequestTypeDef

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

# create_service_template_version method definition

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)
    ...
  1. See CompatibleEnvironmentTemplateInputTypeDef
  2. See TemplateVersionSourceInputTypeDef
  3. See ServiceTemplateSupportedComponentSourceTypeType
  4. See TagTypeDef
  5. See CreateServiceTemplateVersionOutputTypeDef 
# create_service_template_version method usage example with argument unpacking

kwargs: CreateServiceTemplateVersionInputRequestTypeDef = {  # (1)
    "compatibleEnvironmentTemplates": ...,
    "source": ...,
    "templateName": ...,
}

parent.create_service_template_version(**kwargs)
  1. See CreateServiceTemplateVersionInputRequestTypeDef

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

# create_template_sync_config method definition

def create_template_sync_config(
    self,
    *,
    branch: str,
    repositoryName: str,
    repositoryProvider: RepositoryProviderType,  # (1)
    templateName: str,
    templateType: TemplateTypeType,  # (2)
    subdirectory: str = ...,
) -> CreateTemplateSyncConfigOutputTypeDef:  # (3)
    ...
  1. See RepositoryProviderType
  2. See TemplateTypeType
  3. See CreateTemplateSyncConfigOutputTypeDef 
# create_template_sync_config method usage example with argument unpacking

kwargs: CreateTemplateSyncConfigInputRequestTypeDef = {  # (1)
    "branch": ...,
    "repositoryName": ...,
    "repositoryProvider": ...,
    "templateName": ...,
    "templateType": ...,
}

parent.create_template_sync_config(**kwargs)
  1. See CreateTemplateSyncConfigInputRequestTypeDef

delete_component#

Delete an Proton component resource.

Type annotations and code completion for boto3.client("proton").delete_component method. boto3 documentation

# delete_component method definition

def delete_component(
    self,
    *,
    name: str,
) -> DeleteComponentOutputTypeDef:  # (1)
    ...
  1. See DeleteComponentOutputTypeDef 
# delete_component method usage example with argument unpacking

kwargs: DeleteComponentInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_component(**kwargs)
  1. See DeleteComponentInputRequestTypeDef

delete_environment#

Delete an environment.

Type annotations and code completion for boto3.client("proton").delete_environment method. boto3 documentation

# delete_environment method definition

def delete_environment(
    self,
    *,
    name: str,
) -> DeleteEnvironmentOutputTypeDef:  # (1)
    ...
  1. See DeleteEnvironmentOutputTypeDef 
# delete_environment method usage example with argument unpacking

kwargs: DeleteEnvironmentInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_environment(**kwargs)
  1. See DeleteEnvironmentInputRequestTypeDef

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

# delete_environment_account_connection method definition

def delete_environment_account_connection(
    self,
    *,
    id: str,
) -> DeleteEnvironmentAccountConnectionOutputTypeDef:  # (1)
    ...
  1. See DeleteEnvironmentAccountConnectionOutputTypeDef 
# delete_environment_account_connection method usage example with argument unpacking

kwargs: DeleteEnvironmentAccountConnectionInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.delete_environment_account_connection(**kwargs)
  1. See DeleteEnvironmentAccountConnectionInputRequestTypeDef

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

# delete_environment_template method definition

def delete_environment_template(
    self,
    *,
    name: str,
) -> DeleteEnvironmentTemplateOutputTypeDef:  # (1)
    ...
  1. See DeleteEnvironmentTemplateOutputTypeDef 
# delete_environment_template method usage example with argument unpacking

kwargs: DeleteEnvironmentTemplateInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_environment_template(**kwargs)
  1. See DeleteEnvironmentTemplateInputRequestTypeDef

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

# delete_environment_template_version method definition

def delete_environment_template_version(
    self,
    *,
    majorVersion: str,
    minorVersion: str,
    templateName: str,
) -> DeleteEnvironmentTemplateVersionOutputTypeDef:  # (1)
    ...
  1. See DeleteEnvironmentTemplateVersionOutputTypeDef 
# delete_environment_template_version method usage example with argument unpacking

kwargs: DeleteEnvironmentTemplateVersionInputRequestTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

parent.delete_environment_template_version(**kwargs)
  1. See DeleteEnvironmentTemplateVersionInputRequestTypeDef

delete_repository#

De-register and unlink your repository.

Type annotations and code completion for boto3.client("proton").delete_repository method. boto3 documentation

# delete_repository method definition

def delete_repository(
    self,
    *,
    name: str,
    provider: RepositoryProviderType,  # (1)
) -> DeleteRepositoryOutputTypeDef:  # (2)
    ...
  1. See RepositoryProviderType
  2. See DeleteRepositoryOutputTypeDef 
# delete_repository method usage example with argument unpacking

kwargs: DeleteRepositoryInputRequestTypeDef = {  # (1)
    "name": ...,
    "provider": ...,
}

parent.delete_repository(**kwargs)
  1. See DeleteRepositoryInputRequestTypeDef

delete_service#

Delete a service, with its instances and pipeline.

Type annotations and code completion for boto3.client("proton").delete_service method. boto3 documentation

# delete_service method definition

def delete_service(
    self,
    *,
    name: str,
) -> DeleteServiceOutputTypeDef:  # (1)
    ...
  1. See DeleteServiceOutputTypeDef 
# delete_service method usage example with argument unpacking

kwargs: DeleteServiceInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_service(**kwargs)
  1. See DeleteServiceInputRequestTypeDef

delete_service_sync_config#

Delete the Proton Ops file.

Type annotations and code completion for boto3.client("proton").delete_service_sync_config method. boto3 documentation

# delete_service_sync_config method definition

def delete_service_sync_config(
    self,
    *,
    serviceName: str,
) -> DeleteServiceSyncConfigOutputTypeDef:  # (1)
    ...
  1. See DeleteServiceSyncConfigOutputTypeDef 
# delete_service_sync_config method usage example with argument unpacking

kwargs: DeleteServiceSyncConfigInputRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.delete_service_sync_config(**kwargs)
  1. See DeleteServiceSyncConfigInputRequestTypeDef

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

# delete_service_template method definition

def delete_service_template(
    self,
    *,
    name: str,
) -> DeleteServiceTemplateOutputTypeDef:  # (1)
    ...
  1. See DeleteServiceTemplateOutputTypeDef 
# delete_service_template method usage example with argument unpacking

kwargs: DeleteServiceTemplateInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_service_template(**kwargs)
  1. See DeleteServiceTemplateInputRequestTypeDef

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

# delete_service_template_version method definition

def delete_service_template_version(
    self,
    *,
    majorVersion: str,
    minorVersion: str,
    templateName: str,
) -> DeleteServiceTemplateVersionOutputTypeDef:  # (1)
    ...
  1. See DeleteServiceTemplateVersionOutputTypeDef 
# delete_service_template_version method usage example with argument unpacking

kwargs: DeleteServiceTemplateVersionInputRequestTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

parent.delete_service_template_version(**kwargs)
  1. See DeleteServiceTemplateVersionInputRequestTypeDef

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

# delete_template_sync_config method definition

def delete_template_sync_config(
    self,
    *,
    templateName: str,
    templateType: TemplateTypeType,  # (1)
) -> DeleteTemplateSyncConfigOutputTypeDef:  # (2)
    ...
  1. See TemplateTypeType
  2. See DeleteTemplateSyncConfigOutputTypeDef 
# delete_template_sync_config method usage example with argument unpacking

kwargs: DeleteTemplateSyncConfigInputRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateType": ...,
}

parent.delete_template_sync_config(**kwargs)
  1. See DeleteTemplateSyncConfigInputRequestTypeDef

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

# generate_presigned_url method definition

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_account_settings method definition

def get_account_settings(
    self,
) -> GetAccountSettingsOutputTypeDef:  # (1)
    ...
  1. See GetAccountSettingsOutputTypeDef

get_component#

Get detailed data for a component.

Type annotations and code completion for boto3.client("proton").get_component method. boto3 documentation

# get_component method definition

def get_component(
    self,
    *,
    name: str,
) -> GetComponentOutputTypeDef:  # (1)
    ...
  1. See GetComponentOutputTypeDef 
# get_component method usage example with argument unpacking

kwargs: GetComponentInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_component(**kwargs)
  1. See GetComponentInputRequestTypeDef

get_environment#

Get detailed data for an environment.

Type annotations and code completion for boto3.client("proton").get_environment method. boto3 documentation

# get_environment method definition

def get_environment(
    self,
    *,
    name: str,
) -> GetEnvironmentOutputTypeDef:  # (1)
    ...
  1. See GetEnvironmentOutputTypeDef 
# get_environment method usage example with argument unpacking

kwargs: GetEnvironmentInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_environment(**kwargs)
  1. See GetEnvironmentInputRequestTypeDef

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

# get_environment_account_connection method definition

def get_environment_account_connection(
    self,
    *,
    id: str,
) -> GetEnvironmentAccountConnectionOutputTypeDef:  # (1)
    ...
  1. See GetEnvironmentAccountConnectionOutputTypeDef 
# get_environment_account_connection method usage example with argument unpacking

kwargs: GetEnvironmentAccountConnectionInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_environment_account_connection(**kwargs)
  1. See GetEnvironmentAccountConnectionInputRequestTypeDef

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

# get_environment_template method definition

def get_environment_template(
    self,
    *,
    name: str,
) -> GetEnvironmentTemplateOutputTypeDef:  # (1)
    ...
  1. See GetEnvironmentTemplateOutputTypeDef 
# get_environment_template method usage example with argument unpacking

kwargs: GetEnvironmentTemplateInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_environment_template(**kwargs)
  1. See GetEnvironmentTemplateInputRequestTypeDef

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

# get_environment_template_version method definition

def get_environment_template_version(
    self,
    *,
    majorVersion: str,
    minorVersion: str,
    templateName: str,
) -> GetEnvironmentTemplateVersionOutputTypeDef:  # (1)
    ...
  1. See GetEnvironmentTemplateVersionOutputTypeDef 
# get_environment_template_version method usage example with argument unpacking

kwargs: GetEnvironmentTemplateVersionInputRequestTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

parent.get_environment_template_version(**kwargs)
  1. See GetEnvironmentTemplateVersionInputRequestTypeDef

get_repository#

Get detail data for a linked repository.

Type annotations and code completion for boto3.client("proton").get_repository method. boto3 documentation

# get_repository method definition

def get_repository(
    self,
    *,
    name: str,
    provider: RepositoryProviderType,  # (1)
) -> GetRepositoryOutputTypeDef:  # (2)
    ...
  1. See RepositoryProviderType
  2. See GetRepositoryOutputTypeDef 
# get_repository method usage example with argument unpacking

kwargs: GetRepositoryInputRequestTypeDef = {  # (1)
    "name": ...,
    "provider": ...,
}

parent.get_repository(**kwargs)
  1. See GetRepositoryInputRequestTypeDef

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

# get_repository_sync_status method definition

def get_repository_sync_status(
    self,
    *,
    branch: str,
    repositoryName: str,
    repositoryProvider: RepositoryProviderType,  # (1)
    syncType: SyncTypeType,  # (2)
) -> GetRepositorySyncStatusOutputTypeDef:  # (3)
    ...
  1. See RepositoryProviderType
  2. See SyncTypeType
  3. See GetRepositorySyncStatusOutputTypeDef 
# get_repository_sync_status method usage example with argument unpacking

kwargs: GetRepositorySyncStatusInputRequestTypeDef = {  # (1)
    "branch": ...,
    "repositoryName": ...,
    "repositoryProvider": ...,
    "syncType": ...,
}

parent.get_repository_sync_status(**kwargs)
  1. See GetRepositorySyncStatusInputRequestTypeDef

get_resources_summary#

Get counts of Proton resources.

Type annotations and code completion for boto3.client("proton").get_resources_summary method. boto3 documentation

# get_resources_summary method definition

def get_resources_summary(
    self,
) -> GetResourcesSummaryOutputTypeDef:  # (1)
    ...
  1. See GetResourcesSummaryOutputTypeDef

get_service#

Get detailed data for a service.

Type annotations and code completion for boto3.client("proton").get_service method. boto3 documentation

# get_service method definition

def get_service(
    self,
    *,
    name: str,
) -> GetServiceOutputTypeDef:  # (1)
    ...
  1. See GetServiceOutputTypeDef 
# get_service method usage example with argument unpacking

kwargs: GetServiceInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_service(**kwargs)
  1. See GetServiceInputRequestTypeDef

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

# get_service_instance method definition

def get_service_instance(
    self,
    *,
    name: str,
    serviceName: str,
) -> GetServiceInstanceOutputTypeDef:  # (1)
    ...
  1. See GetServiceInstanceOutputTypeDef 
# get_service_instance method usage example with argument unpacking

kwargs: GetServiceInstanceInputRequestTypeDef = {  # (1)
    "name": ...,
    "serviceName": ...,
}

parent.get_service_instance(**kwargs)
  1. See GetServiceInstanceInputRequestTypeDef

get_service_instance_sync_status#

Get the status of the synced service instance.

Type annotations and code completion for boto3.client("proton").get_service_instance_sync_status method. boto3 documentation

# get_service_instance_sync_status method definition

def get_service_instance_sync_status(
    self,
    *,
    serviceInstanceName: str,
    serviceName: str,
) -> GetServiceInstanceSyncStatusOutputTypeDef:  # (1)
    ...
  1. See GetServiceInstanceSyncStatusOutputTypeDef 
# get_service_instance_sync_status method usage example with argument unpacking

kwargs: GetServiceInstanceSyncStatusInputRequestTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

parent.get_service_instance_sync_status(**kwargs)
  1. See GetServiceInstanceSyncStatusInputRequestTypeDef

get_service_sync_blocker_summary#

Get detailed data for the service sync blocker summary.

Type annotations and code completion for boto3.client("proton").get_service_sync_blocker_summary method. boto3 documentation

# get_service_sync_blocker_summary method definition

def get_service_sync_blocker_summary(
    self,
    *,
    serviceName: str,
    serviceInstanceName: str = ...,
) -> GetServiceSyncBlockerSummaryOutputTypeDef:  # (1)
    ...
  1. See GetServiceSyncBlockerSummaryOutputTypeDef 
# get_service_sync_blocker_summary method usage example with argument unpacking

kwargs: GetServiceSyncBlockerSummaryInputRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.get_service_sync_blocker_summary(**kwargs)
  1. See GetServiceSyncBlockerSummaryInputRequestTypeDef

get_service_sync_config#

Get detailed information for the service sync configuration.

Type annotations and code completion for boto3.client("proton").get_service_sync_config method. boto3 documentation

# get_service_sync_config method definition

def get_service_sync_config(
    self,
    *,
    serviceName: str,
) -> GetServiceSyncConfigOutputTypeDef:  # (1)
    ...
  1. See GetServiceSyncConfigOutputTypeDef 
# get_service_sync_config method usage example with argument unpacking

kwargs: GetServiceSyncConfigInputRequestTypeDef = {  # (1)
    "serviceName": ...,
}

parent.get_service_sync_config(**kwargs)
  1. See GetServiceSyncConfigInputRequestTypeDef

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

# get_service_template method definition

def get_service_template(
    self,
    *,
    name: str,
) -> GetServiceTemplateOutputTypeDef:  # (1)
    ...
  1. See GetServiceTemplateOutputTypeDef 
# get_service_template method usage example with argument unpacking

kwargs: GetServiceTemplateInputRequestTypeDef = {  # (1)
    "name": ...,
}

parent.get_service_template(**kwargs)
  1. See GetServiceTemplateInputRequestTypeDef

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

# get_service_template_version method definition

def get_service_template_version(
    self,
    *,
    majorVersion: str,
    minorVersion: str,
    templateName: str,
) -> GetServiceTemplateVersionOutputTypeDef:  # (1)
    ...
  1. See GetServiceTemplateVersionOutputTypeDef 
# get_service_template_version method usage example with argument unpacking

kwargs: GetServiceTemplateVersionInputRequestTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

parent.get_service_template_version(**kwargs)
  1. See GetServiceTemplateVersionInputRequestTypeDef

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

# get_template_sync_config method definition

def get_template_sync_config(
    self,
    *,
    templateName: str,
    templateType: TemplateTypeType,  # (1)
) -> GetTemplateSyncConfigOutputTypeDef:  # (2)
    ...
  1. See TemplateTypeType
  2. See GetTemplateSyncConfigOutputTypeDef 
# get_template_sync_config method usage example with argument unpacking

kwargs: GetTemplateSyncConfigInputRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateType": ...,
}

parent.get_template_sync_config(**kwargs)
  1. See GetTemplateSyncConfigInputRequestTypeDef

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

# get_template_sync_status method definition

def get_template_sync_status(
    self,
    *,
    templateName: str,
    templateType: TemplateTypeType,  # (1)
    templateVersion: str,
) -> GetTemplateSyncStatusOutputTypeDef:  # (2)
    ...
  1. See TemplateTypeType
  2. See GetTemplateSyncStatusOutputTypeDef 
# get_template_sync_status method usage example with argument unpacking

kwargs: GetTemplateSyncStatusInputRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateType": ...,
    "templateVersion": ...,
}

parent.get_template_sync_status(**kwargs)
  1. See GetTemplateSyncStatusInputRequestTypeDef

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

# list_component_outputs method definition

def list_component_outputs(
    self,
    *,
    componentName: str,
    nextToken: str = ...,
) -> ListComponentOutputsOutputTypeDef:  # (1)
    ...
  1. See ListComponentOutputsOutputTypeDef 
# list_component_outputs method usage example with argument unpacking

kwargs: ListComponentOutputsInputRequestTypeDef = {  # (1)
    "componentName": ...,
}

parent.list_component_outputs(**kwargs)
  1. See ListComponentOutputsInputRequestTypeDef

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

# list_component_provisioned_resources method definition

def list_component_provisioned_resources(
    self,
    *,
    componentName: str,
    nextToken: str = ...,
) -> ListComponentProvisionedResourcesOutputTypeDef:  # (1)
    ...
  1. See ListComponentProvisionedResourcesOutputTypeDef 
# list_component_provisioned_resources method usage example with argument unpacking

kwargs: ListComponentProvisionedResourcesInputRequestTypeDef = {  # (1)
    "componentName": ...,
}

parent.list_component_provisioned_resources(**kwargs)
  1. See ListComponentProvisionedResourcesInputRequestTypeDef

list_components#

List components with summary data.

Type annotations and code completion for boto3.client("proton").list_components method. boto3 documentation

# list_components method definition

def list_components(
    self,
    *,
    environmentName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    serviceInstanceName: str = ...,
    serviceName: str = ...,
) -> ListComponentsOutputTypeDef:  # (1)
    ...
  1. See ListComponentsOutputTypeDef 
# list_components method usage example with argument unpacking

kwargs: ListComponentsInputRequestTypeDef = {  # (1)
    "environmentName": ...,
}

parent.list_components(**kwargs)
  1. See ListComponentsInputRequestTypeDef

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

# list_environment_account_connections method definition

def list_environment_account_connections(
    self,
    *,
    requestedBy: EnvironmentAccountConnectionRequesterAccountTypeType,  # (1)
    environmentName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    statuses: Sequence[EnvironmentAccountConnectionStatusType] = ...,  # (2)
) -> ListEnvironmentAccountConnectionsOutputTypeDef:  # (3)
    ...
  1. See EnvironmentAccountConnectionRequesterAccountTypeType
  2. See EnvironmentAccountConnectionStatusType
  3. See ListEnvironmentAccountConnectionsOutputTypeDef 
# list_environment_account_connections method usage example with argument unpacking

kwargs: ListEnvironmentAccountConnectionsInputRequestTypeDef = {  # (1)
    "requestedBy": ...,
}

parent.list_environment_account_connections(**kwargs)
  1. See ListEnvironmentAccountConnectionsInputRequestTypeDef

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

# list_environment_outputs method definition

def list_environment_outputs(
    self,
    *,
    environmentName: str,
    nextToken: str = ...,
) -> ListEnvironmentOutputsOutputTypeDef:  # (1)
    ...
  1. See ListEnvironmentOutputsOutputTypeDef 
# list_environment_outputs method usage example with argument unpacking

kwargs: ListEnvironmentOutputsInputRequestTypeDef = {  # (1)
    "environmentName": ...,
}

parent.list_environment_outputs(**kwargs)
  1. See ListEnvironmentOutputsInputRequestTypeDef

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

# list_environment_provisioned_resources method definition

def list_environment_provisioned_resources(
    self,
    *,
    environmentName: str,
    nextToken: str = ...,
) -> ListEnvironmentProvisionedResourcesOutputTypeDef:  # (1)
    ...
  1. See ListEnvironmentProvisionedResourcesOutputTypeDef 
# list_environment_provisioned_resources method usage example with argument unpacking

kwargs: ListEnvironmentProvisionedResourcesInputRequestTypeDef = {  # (1)
    "environmentName": ...,
}

parent.list_environment_provisioned_resources(**kwargs)
  1. See ListEnvironmentProvisionedResourcesInputRequestTypeDef

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

# list_environment_template_versions method definition

def list_environment_template_versions(
    self,
    *,
    templateName: str,
    majorVersion: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEnvironmentTemplateVersionsOutputTypeDef:  # (1)
    ...
  1. See ListEnvironmentTemplateVersionsOutputTypeDef 
# list_environment_template_versions method usage example with argument unpacking

kwargs: ListEnvironmentTemplateVersionsInputRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.list_environment_template_versions(**kwargs)
  1. See ListEnvironmentTemplateVersionsInputRequestTypeDef

list_environment_templates#

List environment templates.

Type annotations and code completion for boto3.client("proton").list_environment_templates method. boto3 documentation

# list_environment_templates method definition

def list_environment_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEnvironmentTemplatesOutputTypeDef:  # (1)
    ...
  1. See ListEnvironmentTemplatesOutputTypeDef 
# list_environment_templates method usage example with argument unpacking

kwargs: ListEnvironmentTemplatesInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_environment_templates(**kwargs)
  1. See ListEnvironmentTemplatesInputRequestTypeDef

list_environments#

List environments with detail data summaries.

Type annotations and code completion for boto3.client("proton").list_environments method. boto3 documentation

# list_environments method definition

def list_environments(
    self,
    *,
    environmentTemplates: Sequence[EnvironmentTemplateFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEnvironmentsOutputTypeDef:  # (2)
    ...
  1. See EnvironmentTemplateFilterTypeDef
  2. See ListEnvironmentsOutputTypeDef 
# list_environments method usage example with argument unpacking

kwargs: ListEnvironmentsInputRequestTypeDef = {  # (1)
    "environmentTemplates": ...,
}

parent.list_environments(**kwargs)
  1. See ListEnvironmentsInputRequestTypeDef

list_repositories#

List linked repositories with detail data.

Type annotations and code completion for boto3.client("proton").list_repositories method. boto3 documentation

# list_repositories method definition

def list_repositories(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListRepositoriesOutputTypeDef:  # (1)
    ...
  1. See ListRepositoriesOutputTypeDef 
# list_repositories method usage example with argument unpacking

kwargs: ListRepositoriesInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_repositories(**kwargs)
  1. See ListRepositoriesInputRequestTypeDef

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

# list_repository_sync_definitions method definition

def list_repository_sync_definitions(
    self,
    *,
    repositoryName: str,
    repositoryProvider: RepositoryProviderType,  # (1)
    syncType: SyncTypeType,  # (2)
    nextToken: str = ...,
) -> ListRepositorySyncDefinitionsOutputTypeDef:  # (3)
    ...
  1. See RepositoryProviderType
  2. See SyncTypeType
  3. See ListRepositorySyncDefinitionsOutputTypeDef 
# list_repository_sync_definitions method usage example with argument unpacking

kwargs: ListRepositorySyncDefinitionsInputRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "repositoryProvider": ...,
    "syncType": ...,
}

parent.list_repository_sync_definitions(**kwargs)
  1. See ListRepositorySyncDefinitionsInputRequestTypeDef

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

# list_service_instance_outputs method definition

def list_service_instance_outputs(
    self,
    *,
    serviceInstanceName: str,
    serviceName: str,
    nextToken: str = ...,
) -> ListServiceInstanceOutputsOutputTypeDef:  # (1)
    ...
  1. See ListServiceInstanceOutputsOutputTypeDef 
# list_service_instance_outputs method usage example with argument unpacking

kwargs: ListServiceInstanceOutputsInputRequestTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

parent.list_service_instance_outputs(**kwargs)
  1. See ListServiceInstanceOutputsInputRequestTypeDef

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

# list_service_instance_provisioned_resources method definition

def list_service_instance_provisioned_resources(
    self,
    *,
    serviceInstanceName: str,
    serviceName: str,
    nextToken: str = ...,
) -> ListServiceInstanceProvisionedResourcesOutputTypeDef:  # (1)
    ...
  1. See ListServiceInstanceProvisionedResourcesOutputTypeDef 
# list_service_instance_provisioned_resources method usage example with argument unpacking

kwargs: ListServiceInstanceProvisionedResourcesInputRequestTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

parent.list_service_instance_provisioned_resources(**kwargs)
  1. See ListServiceInstanceProvisionedResourcesInputRequestTypeDef

list_service_instances#

List service instances with summary data.

Type annotations and code completion for boto3.client("proton").list_service_instances method. boto3 documentation

# list_service_instances method definition

def list_service_instances(
    self,
    *,
    filters: Sequence[ListServiceInstancesFilterTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    serviceName: str = ...,
    sortBy: ListServiceInstancesSortByType = ...,  # (2)
    sortOrder: SortOrderType = ...,  # (3)
) -> ListServiceInstancesOutputTypeDef:  # (4)
    ...
  1. See