Skip to content

ProtonClient#

Index > Proton > ProtonClient

Auto-generated documentation for Proton type annotations stubs module types-boto3-proton.

ProtonClient#

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

# ProtonClient usage example

from boto3.session import Session
from types_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 types_boto3_proton.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

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:
    ...

generate_presigned_url#

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:
    ...

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: AcceptEnvironmentAccountConnectionInputTypeDef = {  # (1)
    "id": ...,
}

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

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: CancelComponentDeploymentInputTypeDef = {  # (1)
    "componentName": ...,
}

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

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: CancelEnvironmentDeploymentInputTypeDef = {  # (1)
    "environmentName": ...,
}

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

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: CancelServiceInstanceDeploymentInputTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

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

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: CancelServicePipelineDeploymentInputTypeDef = {  # (1)
    "serviceName": ...,
}

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

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

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

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

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 Sequence[TagTypeDef]
  3. See CreateEnvironmentOutputTypeDef
# create_environment method usage example with argument unpacking

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

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

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

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

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

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 Sequence[TagTypeDef]
  3. See CreateEnvironmentTemplateOutputTypeDef
# create_environment_template method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  3. See CreateEnvironmentTemplateVersionOutputTypeDef
# create_environment_template_version method usage example with argument unpacking

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

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

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 Sequence[TagTypeDef]
  3. See CreateRepositoryOutputTypeDef
# create_repository method usage example with argument unpacking

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

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

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

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

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

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 Sequence[TagTypeDef]
  2. See CreateServiceInstanceOutputTypeDef
# create_service_instance method usage example with argument unpacking

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

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

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: CreateServiceSyncConfigInputTypeDef = {  # (1)
    "branch": ...,
    "filePath": ...,
    "repositoryName": ...,
    "repositoryProvider": ...,
    "serviceName": ...,
}

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

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 Sequence[TagTypeDef]
  3. See CreateServiceTemplateOutputTypeDef
# create_service_template method usage example with argument unpacking

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

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

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 Sequence[CompatibleEnvironmentTemplateInputTypeDef]
  2. See TemplateVersionSourceInputTypeDef
  3. See Sequence[Literal['DIRECTLY_DEFINED']]
  4. See Sequence[TagTypeDef]
  5. See CreateServiceTemplateVersionOutputTypeDef
# create_service_template_version method usage example with argument unpacking

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

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

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: CreateTemplateSyncConfigInputTypeDef = {  # (1)
    "branch": ...,
    "repositoryName": ...,
    "repositoryProvider": ...,
    "templateName": ...,
    "templateType": ...,
}

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

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: DeleteComponentInputTypeDef = {  # (1)
    "name": ...,
}

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

delete_deployment#

Delete the deployment.

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

# delete_deployment method definition

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

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

parent.delete_deployment(**kwargs)
  1. See DeleteDeploymentInputTypeDef

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: DeleteEnvironmentInputTypeDef = {  # (1)
    "name": ...,
}

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

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: DeleteEnvironmentAccountConnectionInputTypeDef = {  # (1)
    "id": ...,
}

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

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: DeleteEnvironmentTemplateInputTypeDef = {  # (1)
    "name": ...,
}

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

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: DeleteEnvironmentTemplateVersionInputTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

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

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: DeleteRepositoryInputTypeDef = {  # (1)
    "name": ...,
    "provider": ...,
}

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

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: DeleteServiceInputTypeDef = {  # (1)
    "name": ...,
}

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

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: DeleteServiceSyncConfigInputTypeDef = {  # (1)
    "serviceName": ...,
}

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

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: DeleteServiceTemplateInputTypeDef = {  # (1)
    "name": ...,
}

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

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: DeleteServiceTemplateVersionInputTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

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

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: DeleteTemplateSyncConfigInputTypeDef = {  # (1)
    "templateName": ...,
    "templateType": ...,
}

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

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: GetComponentInputTypeDef = {  # (1)
    "name": ...,
}

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

get_deployment#

Get detailed data for a deployment.

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

# get_deployment method definition

def get_deployment(
    self,
    *,
    id: str,
    componentName: str = ...,
    environmentName: str = ...,
    serviceInstanceName: str = ...,
    serviceName: str = ...,
) -> GetDeploymentOutputTypeDef:  # (1)
    ...
  1. See GetDeploymentOutputTypeDef
# get_deployment method usage example with argument unpacking

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

parent.get_deployment(**kwargs)
  1. See GetDeploymentInputTypeDef

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: GetEnvironmentInputTypeDef = {  # (1)
    "name": ...,
}

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

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: GetEnvironmentAccountConnectionInputTypeDef = {  # (1)
    "id": ...,
}

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

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: GetEnvironmentTemplateInputTypeDef = {  # (1)
    "name": ...,
}

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

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: GetEnvironmentTemplateVersionInputTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

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

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: GetRepositoryInputTypeDef = {  # (1)
    "name": ...,
    "provider": ...,
}

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

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: GetRepositorySyncStatusInputTypeDef = {  # (1)
    "branch": ...,
    "repositoryName": ...,
    "repositoryProvider": ...,
    "syncType": ...,
}

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

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: GetServiceInputTypeDef = {  # (1)
    "name": ...,
}

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

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: GetServiceInstanceInputTypeDef = {  # (1)
    "name": ...,
    "serviceName": ...,
}

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

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: GetServiceInstanceSyncStatusInputTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

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

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: GetServiceSyncBlockerSummaryInputTypeDef = {  # (1)
    "serviceName": ...,
}

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

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: GetServiceSyncConfigInputTypeDef = {  # (1)
    "serviceName": ...,
}

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

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: GetServiceTemplateInputTypeDef = {  # (1)
    "name": ...,
}

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

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: GetServiceTemplateVersionInputTypeDef = {  # (1)
    "majorVersion": ...,
    "minorVersion": ...,
    "templateName": ...,
}

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

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: GetTemplateSyncConfigInputTypeDef = {  # (1)
    "templateName": ...,
    "templateType": ...,
}

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

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: GetTemplateSyncStatusInputTypeDef = {  # (1)
    "templateName": ...,
    "templateType": ...,
    "templateVersion": ...,
}

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

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,
    deploymentId: str = ...,
    nextToken: str = ...,
) -> ListComponentOutputsOutputTypeDef:  # (1)
    ...
  1. See ListComponentOutputsOutputTypeDef
# list_component_outputs method usage example with argument unpacking

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

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

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: ListComponentProvisionedResourcesInputTypeDef = {  # (1)
    "componentName": ...,
}

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

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: ListComponentsInputTypeDef = {  # (1)
    "environmentName": ...,
}

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

list_deployments#

List deployments.

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

# list_deployments method definition

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

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

parent.list_deployments(**kwargs)
  1. See ListDeploymentsInputTypeDef

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 Sequence[EnvironmentAccountConnectionStatusType]
  3. See ListEnvironmentAccountConnectionsOutputTypeDef
# list_environment_account_connections method usage example with argument unpacking

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

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

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,
    deploymentId: str = ...,
    nextToken: str = ...,
) -> ListEnvironmentOutputsOutputTypeDef:  # (1)
    ...
  1. See ListEnvironmentOutputsOutputTypeDef
# list_environment_outputs method usage example with argument unpacking

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

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

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: ListEnvironmentProvisionedResourcesInputTypeDef = {  # (1)
    "environmentName": ...,
}

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

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: ListEnvironmentTemplateVersionsInputTypeDef = {  # (1)
    "templateName": ...,
}

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

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: ListEnvironmentTemplatesInputTypeDef = {  # (1)
    "maxResults": ...,
}

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

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 Sequence[EnvironmentTemplateFilterTypeDef]
  2. See ListEnvironmentsOutputTypeDef
# list_environments method usage example with argument unpacking

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

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

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: ListRepositoriesInputTypeDef = {  # (1)
    "maxResults": ...,
}

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

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: ListRepositorySyncDefinitionsInputTypeDef = {  # (1)
    "repositoryName": ...,
    "repositoryProvider": ...,
    "syncType": ...,
}

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

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,
    deploymentId: str = ...,
    nextToken: str = ...,
) -> ListServiceInstanceOutputsOutputTypeDef:  # (1)
    ...
  1. See ListServiceInstanceOutputsOutputTypeDef
# list_service_instance_outputs method usage example with argument unpacking

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

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

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: ListServiceInstanceProvisionedResourcesInputTypeDef = {  # (1)
    "serviceInstanceName": ...,
    "serviceName": ...,
}

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

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 Sequence[ListServiceInstancesFilterTypeDef]
  2. See ListServiceInstancesSortByType
  3. See SortOrderType
  4. See ListServiceInstancesOutputTypeDef
# list_service_instances method usage example with argument unpacking

kwargs: ListServiceInstancesInputTypeDef = {  # (1)
    "filters": ...,
}

parent.list_service_instances(**kwargs)
  1. See ListServiceInstancesInputTypeDef

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

# list_service_pipeline_outputs method definition

def list_service_pipeline_outputs(
    self,
    *,
    serviceName: str,
    deploymentId: str = ...,
    nextToken: str = ...,
) -> ListServicePipelineOutputsOutputTypeDef:  # (1)
    ...
  1. See ListServicePipelineOutputsOutputTypeDef
# list_service_pipeline_outputs method usage example with argument unpacking

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

parent.list_service_pipeline_outputs(**kwargs)
  1. See ListServicePipelineOutputsInputTypeDef

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

# list_service_pipeline_provisioned_resources method definition

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

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

parent.list_service_pipeline_provisioned_resources(**kwargs)
  1. See ListServicePipelineProvisionedResourcesInputTypeDef

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

# list_service_template_versions method definition

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

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

parent.list_service_template_versions(**kwargs)
  1. See ListServiceTemplateVersionsInputTypeDef

list_service_templates#

List service templates with detail data.

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

# list_service_templates method definition

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

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

parent.list_service_templates(**kwargs)
  1. See ListServiceTemplatesInputTypeDef

list_services#

List services with summaries of detail data.

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

# list_services method definition

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

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

parent.list_services(**kwargs)
  1. See ListServicesInputTypeDef

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

# list_tags_for_resource method definition

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

kwargs: ListTagsForResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputTypeDef

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

# notify_resource_deployment_status_change method definition

def notify_resource_deployment_status_change(
    self,
    *,
    resourceArn: str,
    deploymentId: str = ...,
    outputs: Sequence[OutputTypeDef] = ...,  # (1)
    status: ResourceDeploymentStatusType = ...,  # (2)
    statusMessage: str = ...,
) -> Dict[str, Any]:
    ...
  1. See Sequence[OutputTypeDef]
  2. See ResourceDeploymentStatusType
# notify_resource_deployment_status_change method usage example with argument unpacking

kwargs: NotifyResourceDeploymentStatusChangeInputTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.notify_resource_deployment_status_change(**kwargs)
  1. See NotifyResourceDeploymentStatusChangeInputTypeDef

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

# reject_environment_account_connection method definition

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

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

parent.reject_environment_account_connection(**kwargs)
  1. See RejectEnvironmentAccountConnectionInputTypeDef

tag_resource#

Tag a resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputTypeDef

untag_resource#

Remove a customer tag from a resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputTypeDef

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

# update_account_settings method definition

def update_account_settings(
    self,
    *,
    deletePipelineProvisioningRepository: bool = ...,
    pipelineCodebuildRoleArn: str = ...,
    pipelineProvisioningRepository: RepositoryBranchInputTypeDef = ...,  # (1)
    pipelineServiceRoleArn: str = ...,
) -> UpdateAccountSettingsOutputTypeDef:  # (2)
    ...
  1. See RepositoryBranchInputTypeDef
  2. See UpdateAccountSettingsOutputTypeDef
# update_account_settings method usage example with argument unpacking

kwargs: UpdateAccountSettingsInputTypeDef = {  # (1)
    "deletePipelineProvisioningRepository": ...,
}

parent.update_account_settings(**kwargs)
  1. See UpdateAccountSettingsInputTypeDef

update_component#

Update a component.

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

# update_component method definition

def update_component(
    self,
    *,
    deploymentType: ComponentDeploymentUpdateTypeType,  # (1)
    name: str,
    clientToken: str = ...,
    description: str = ...,
    serviceInstanceName: str = ...,
    serviceName: str = ...,
    serviceSpec: str = ...,
    templateFile: str = ...,
) -> UpdateComponentOutputTypeDef:  # (2)
    ...
  1. See ComponentDeploymentUpdateTypeType
  2. See UpdateComponentOutputTypeDef
# update_component method usage example with argument unpacking

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

parent.update_component(**kwargs)
  1. See UpdateComponentInputTypeDef

update_environment#

Update an environment.

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

# update_environment method definition

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)
    ...
  1. See DeploymentUpdateTypeType
  2. See RepositoryBranchInputTypeDef
  3. See UpdateEnvironmentOutputTypeDef
# update_environment method usage example with argument unpacking

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

parent.update_environment(**kwargs)
  1. See UpdateEnvironmentInputTypeDef

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

# update_environment_account_connection method definition

def update_environment_account_connection(
    self,
    *,
    id: str,
    codebuildRoleArn: str = ...,
    componentRoleArn: str = ...,
    roleArn: str = ...,
) -> UpdateEnvironmentAccountConnectionOutputTypeDef:  # (1)
    ...
  1. See UpdateEnvironmentAccountConnectionOutputTypeDef
# update_environment_account_connection method usage example with argument unpacking

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

parent.update_environment_account_connection(**kwargs)
  1. See UpdateEnvironmentAccountConnectionInputTypeDef

update_environment_template#

Update an environment template.

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

# update_environment_template method definition

def update_environment_template(
    self,
    *,
    name: str,
    description: str = ...,
    displayName: str = ...,
) -> UpdateEnvironmentTemplateOutputTypeDef:  # (1)
    ...
  1. See UpdateEnvironmentTemplateOutputTypeDef
# update_environment_template method usage example with argument unpacking

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

parent.update_environment_template(**kwargs)
  1. See UpdateEnvironmentTemplateInputTypeDef

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

# update_environment_template_version method definition

def update_environment_template_version(
    self,
    *,
    majorVersion: str,
    minorVersion: str,
    templateName: str,
    description: str = ...,
    status: TemplateVersionStatusType = ...,  # (1)
) -> UpdateEnvironmentTemplateVersionOutputTypeDef:  # (2)
    ...
  1. See TemplateVersionStatusType
  2. See UpdateEnvironmentTemplateVersionOutputTypeDef
# update_environment_template_version method usage example with argument unpacking

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

parent.update_environment_template_version(**kwargs)
  1. See UpdateEnvironmentTemplateVersionInputTypeDef

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

# update_service method definition

def update_service(
    self,
    *,
    name: str,
    description: str = ...,
    spec: str = ...,
) -> UpdateServiceOutputTypeDef:  # (1)
    ...
  1. See UpdateServiceOutputTypeDef
# update_service method usage example with argument unpacking

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

parent.update_service(**kwargs)
  1. See UpdateServiceInputTypeDef

update_service_instance#

Update a service instance.

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

# update_service_instance method definition

def update_service_instance(
    self,
    *,
    deploymentType: DeploymentUpdateTypeType,  # (1)
    name: str,
    serviceName: str,
    clientToken: str = ...,
    spec: str = ...,
    templateMajorVersion: str = ...,
    templateMinorVersion: str = ...,
) -> UpdateServiceInstanceOutputTypeDef:  # (2)
    ...
  1. See DeploymentUpdateTypeType
  2. See UpdateServiceInstanceOutputTypeDef
# update_service_instance method usage example with argument unpacking

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

parent.update_service_instance(**kwargs)
  1. See UpdateServiceInstanceInputTypeDef

update_service_pipeline#

Update the service pipeline.

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

# update_service_pipeline method definition

def update_service_pipeline(
    self,
    *,
    deploymentType: DeploymentUpdateTypeType,  # (1)
    serviceName: str,
    spec: str,
    templateMajorVersion: str = ...,
    templateMinorVersion: str = ...,
) -> UpdateServicePipelineOutputTypeDef:  # (2)
    ...
  1. See DeploymentUpdateTypeType
  2. See UpdateServicePipelineOutputTypeDef
# update_service_pipeline method usage example with argument unpacking

kwargs: UpdateServicePipelineInputTypeDef = {  # (1)
    "deploymentType": ...,
    "serviceName": ...,
    "spec": ...,
}

parent.update_service_pipeline(**kwargs)
  1. See UpdateServicePipelineInputTypeDef

update_service_sync_blocker#

Update the service sync blocker by resolving it.

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

# update_service_sync_blocker method definition

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

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

parent.update_service_sync_blocker(**kwargs)
  1. See UpdateServiceSyncBlockerInputTypeDef

update_service_sync_config#

Update the Proton Ops config file.

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

# update_service_sync_config method definition

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

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

parent.update_service_sync_config(**kwargs)
  1. See UpdateServiceSyncConfigInputTypeDef

update_service_template#

Update a service template.

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

# update_service_template method definition

def update_service_template(
    self,
    *,
    name: str,
    description: str = ...,
    displayName: str = ...,
) -> UpdateServiceTemplateOutputTypeDef:  # (1)
    ...
  1. See UpdateServiceTemplateOutputTypeDef
# update_service_template method usage example with argument unpacking

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

parent.update_service_template(**kwargs)
  1. See UpdateServiceTemplateInputTypeDef

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

# update_service_template_version method definition

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)
    ...
  1. See Sequence[CompatibleEnvironmentTemplateInputTypeDef]
  2. See TemplateVersionStatusType
  3. See Sequence[Literal['DIRECTLY_DEFINED']]
  4. See UpdateServiceTemplateVersionOutputTypeDef
# update_service_template_version method usage example with argument unpacking

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

parent.update_service_template_version(**kwargs)
  1. See UpdateServiceTemplateVersionInputTypeDef

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

# update_template_sync_config method definition

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

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

parent.update_template_sync_config(**kwargs)
  1. See UpdateTemplateSyncConfigInputTypeDef

get_paginator#

Type annotations and code completion for boto3.client("proton").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("proton").get_waiter method with overloads.