Proton ¶

Table of Contents

Proton

Client ¶

class Proton.Client¶

A low-level client representing AWS Proton

This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.

The documentation for each action shows the Query API request parameters and the XML response.

Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide .

The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.

Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.

When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are running on Proton, developers need permissions to the service create , list , update and delete API operations and the service instance list and update API operations.

To learn more about Proton administration, see the Proton Administrator Guide .

To learn more about deploying serverless and containerized applications on Proton, see the Proton User Guide .

Ensuring Idempotency

When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.

Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.

The following lists of APIs are grouped according to methods that ensure idempotency.

Idempotent create APIs with a client token

The API actions in this list support idempotency with the use of a client token . The corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.

Given a request action that has succeeded:

If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.

If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a ValidationException with an IdempotentParameterMismatch error.

Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.

If the original resource is deleted and you retry the request, a new resource is created.

Idempotent create APIs with a client token:

CreateEnvironmentTemplateVersion
CreateServiceTemplateVersion
CreateEnvironmentAccountConnection

Idempotent create APIs

Given a request action that has succeeded:

If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.

If the original resource has been modified, the retry throws a ConflictException .

If you retry with different input parameters, the retry throws a ValidationException with an IdempotentParameterMismatch error.

Idempotent create APIs:

CreateEnvironmentTemplate
CreateServiceTemplate
CreateEnvironment
CreateService

Idempotent delete APIs

Given a request action that has succeeded:

When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.

If you retry and the resource doesn't exist, the response is empty.

In both cases, the retry succeeds.

Idempotent delete APIs:

DeleteEnvironmentTemplate
DeleteEnvironmentTemplateVersion
DeleteServiceTemplate
DeleteServiceTemplateVersion
DeleteEnvironmentAccountConnection

Asynchronous idempotent delete APIs

Given a request action that has succeeded:

If you retry the request with an API from this group, if the original request delete operation status is DELETE_IN_PROGRESS , the retry returns the resource detail data in the response without performing any further actions.

If the original request delete operation is complete, a retry returns an empty response.

Asynchronous idempotent delete APIs:

DeleteEnvironment
DeleteService

import boto3

client = boto3.client('proton')

These are the available methods:

accept_environment_account_connection()
can_paginate()
cancel_environment_deployment()
cancel_service_instance_deployment()
cancel_service_pipeline_deployment()
create_environment()
create_environment_account_connection()
create_environment_template()
create_environment_template_version()
create_repository()
create_service()
create_service_template()
create_service_template_version()
create_template_sync_config()
delete_environment()
delete_environment_account_connection()
delete_environment_template()
delete_environment_template_version()
delete_repository()
delete_service()
delete_service_template()
delete_service_template_version()
delete_template_sync_config()
get_account_settings()
get_environment()
get_environment_account_connection()
get_environment_template()
get_environment_template_version()
get_paginator()
get_repository()
get_repository_sync_status()
get_service()
get_service_instance()
get_service_template()
get_service_template_version()
get_template_sync_config()
get_template_sync_status()
get_waiter()
list_environment_account_connections()
list_environment_outputs()
list_environment_provisioned_resources()
list_environment_template_versions()
list_environment_templates()
list_environments()
list_repositories()
list_repository_sync_definitions()
list_service_instance_outputs()
list_service_instance_provisioned_resources()
list_service_instances()
list_service_pipeline_outputs()
list_service_pipeline_provisioned_resources()
list_service_template_versions()
list_service_templates()
list_services()
list_tags_for_resource()
notify_resource_deployment_status_change()
reject_environment_account_connection()
tag_resource()
untag_resource()
update_account_settings()
update_environment()
update_environment_account_connection()
update_environment_template()
update_environment_template_version()
update_service()
update_service_instance()
update_service_pipeline()
update_service_template()
update_service_template_version()
update_template_sync_config()

accept_environment_account_connection(**kwargs)¶

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.accept_environment_account_connection(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the environment account connection.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

(dict) --
- environmentAccountConnection (dict) --
  The environment account connection data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment account connection.
  - environmentAccountId (string) --
    The environment account that's connected to the environment account connection.
  - environmentName (string) --
    The name of the environment that's associated with the environment account connection.
  - id (string) --
    The ID of the environment account connection.
  - lastModifiedAt (datetime) --
    The time when the environment account connection was last modified.
  - managementAccountId (string) --
    The ID of the management account that's connected to the environment account connection.
  - requestedAt (datetime) --
    The time when the environment account connection request was made.
  - roleArn (string) --
    The IAM service role that's associated with the environment account connection.
  - status (string) --
    The status of the environment account connection.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

cancel_environment_deployment(**kwargs)¶

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS . For more information, see Update an environment in the Proton Administrator guide .

The following list includes potential cancellation scenarios.

If the cancellation attempt succeeds, the resulting deployment state is CANCELLED .
If the cancellation attempt fails, the resulting deployment state is FAILED .
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

See also: AWS API Documentation

Request Syntax

response = client.cancel_environment_deployment(
    environmentName='string'
)

Parameters

environmentName (string) --

[REQUIRED]

The name of the environment with the deployment to cancel.

Return type

dict

Returns

Response Syntax

{
    'environment': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentAccountConnectionId': 'string',
        'environmentAccountId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'protonServiceRoleArn': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'provisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  The environment summary data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment.
  - createdAt (datetime) --
    The time when the environment was created.
  - deploymentStatus (string) --
    The environment deployment status.
  - deploymentStatusMessage (string) --
    An environment deployment status message.
  - description (string) --
    The description of the environment.
  - environmentAccountConnectionId (string) --
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - environmentAccountId (string) --
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - lastDeploymentAttemptedAt (datetime) --
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    The time when the environment was last deployed successfully.
  - name (string) --
    The name of the environment.
  - protonServiceRoleArn (string) --
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning (string) --
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - provisioningRepository (dict) --
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      The repository branch.
    - name (string) --
      The repository name.
    - provider (string) --
      The repository provider.
  - spec (string) --
    The environment spec.
  - templateMajorVersion (string) --
    The ID of the major version of the environment template.
  - templateMinorVersion (string) --
    The ID of the minor version of the environment template.
  - templateName (string) --
    The Amazon Resource Name (ARN) of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

cancel_service_instance_deployment(**kwargs)¶

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS . For more information, see Update a service instance in the Proton Administrator guide or the Proton User guide .

The following list includes potential cancellation scenarios.

If the cancellation attempt succeeds, the resulting deployment state is CANCELLED .
If the cancellation attempt fails, the resulting deployment state is FAILED .
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

See also: AWS API Documentation

Request Syntax

response = client.cancel_service_instance_deployment(
    serviceInstanceName='string',
    serviceName='string'
)

Parameters

serviceInstanceName (string) --
[REQUIRED]

The name of the service instance with the deployment to cancel.
serviceName (string) --
[REQUIRED]

The name of the service with the service instance deployment to cancel.

Return type

dict

Returns

Response Syntax

{
    'serviceInstance': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'environmentName': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'serviceName': 'string',
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceInstance (dict) --
  
  The service instance summary data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service instance.
  - createdAt (datetime) --
    
    The time when the service instance was created.
  - deploymentStatus (string) --
    
    The service instance deployment status.
  - deploymentStatusMessage (string) --
    
    A service instance deployment status message.
  - environmentName (string) --
    
    The name of the environment that the service instance was deployed into.
  - lastDeploymentAttemptedAt (datetime) --
    
    The time when a deployment of the service instance was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    
    The time when the service instance was last deployed successfully.
  - name (string) --
    
    The name of the service instance.
  - serviceName (string) --
    
    The name of the service that the service instance belongs to.
  - spec (string) --
    
    The service spec that was used to create the service instance.
  - templateMajorVersion (string) --
    
    The major version of the service template that was used to create the service instance.
  - templateMinorVersion (string) --
    
    The minor version of the service template that was used to create the service instance.
  - templateName (string) --
    
    The name of the service template that was used to create the service instance.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

cancel_service_pipeline_deployment(**kwargs)¶

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS . For more information, see Update a service pipeline in the Proton Administrator guide or the Proton User guide .

The following list includes potential cancellation scenarios.

If the cancellation attempt succeeds, the resulting deployment state is CANCELLED .
If the cancellation attempt fails, the resulting deployment state is FAILED .
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.

See also: AWS API Documentation

Request Syntax

response = client.cancel_service_pipeline_deployment(
    serviceName='string'
)

Parameters

serviceName (string) --

[REQUIRED]

The name of the service with the service pipeline deployment to cancel.

Return type

dict

Returns

Response Syntax

{
    'pipeline': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- pipeline (dict) --
  The service pipeline detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the service pipeline.
  - createdAt (datetime) --
    The time when the service pipeline was created.
  - deploymentStatus (string) --
    The deployment status of the service pipeline.
  - deploymentStatusMessage (string) --
    A service pipeline deployment status message.
  - lastDeploymentAttemptedAt (datetime) --
    The time when a deployment of the service pipeline was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    The time when the service pipeline was last deployed successfully.
  - spec (string) --
    The service spec that was used to create the service pipeline.
  - templateMajorVersion (string) --
    The major version of the service template that was used to create the service pipeline.
  - templateMinorVersion (string) --
    The minor version of the service template that was used to create the service pipeline.
  - templateName (string) --
    The name of the service template that was used to create the service pipeline.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

create_environment(**kwargs)¶

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

Standard provisioning: Proton makes direct calls to provision your resources.
Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see the Environments in the Proton Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_environment(
    description='string',
    environmentAccountConnectionId='string',
    name='string',
    protonServiceRoleArn='string',
    provisioningRepository={
        'branch': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    },
    spec='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateMajorVersion='string',
    templateMinorVersion='string',
    templateName='string'
)

Parameters

description (string) -- A description of the environment that's being created and deployed.
environmentAccountConnectionId (string) -- The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter and values. For more information, see Environment account connections in the Proton Administrator guide .
name (string) --
[REQUIRED]

The name of the environment.
protonServiceRoleArn (string) -- The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value and omit the provisioningRepository parameter when you use standard provisioning.
provisioningRepository (dict) --
The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

Warning

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
- branch (string) -- [REQUIRED]
  The repository branch.
- name (string) -- [REQUIRED]
  The repository name.
- provider (string) -- [REQUIRED]
  The repository provider.
spec (string) --
[REQUIRED]

A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide .
tags (list) --
Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.
templateMajorVersion (string) --
[REQUIRED]

The major version of the environment template.
templateMinorVersion (string) -- The minor version of the environment template.
templateName (string) --
[REQUIRED]

The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide .

Return type

dict

Returns

Response Syntax

{
    'environment': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentAccountConnectionId': 'string',
        'environmentAccountId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'protonServiceRoleArn': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'provisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  
  The environment detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment.
  - createdAt (datetime) --
    
    The time when the environment was created.
  - deploymentStatus (string) --
    
    The environment deployment status.
  - deploymentStatusMessage (string) --
    
    An environment deployment status message.
  - description (string) --
    
    The description of the environment.
  - environmentAccountConnectionId (string) --
    
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - environmentAccountId (string) --
    
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - lastDeploymentAttemptedAt (datetime) --
    
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    
    The time when the environment was last deployed successfully.
  - name (string) --
    
    The name of the environment.
  - protonServiceRoleArn (string) --
    
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning (string) --
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - provisioningRepository (dict) --
    
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      
      The repository branch.
    - name (string) --
      
      The repository name.
    - provider (string) --
      
      The repository provider.
  - spec (string) --
    
    The environment spec.
  - templateMajorVersion (string) --
    
    The ID of the major version of the environment template.
  - templateMinorVersion (string) --
    
    The ID of the minor version of the environment template.
  - templateName (string) --
    
    The Amazon Resource Name (ARN) of the environment template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

create_environment_account_connection(**kwargs)¶

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.

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.create_environment_account_connection(
    clientToken='string',
    environmentName='string',
    managementAccountId='string',
    roleArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters

clientToken (string) --
When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.

This field is autopopulated if not provided.
environmentName (string) --
[REQUIRED]

The name of the Proton environment that's created in the associated management account.
managementAccountId (string) --
[REQUIRED]

The ID of the management account that accepts or rejects the environment account connection. You create an manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
roleArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.
tags (list) --
Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide .
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

(dict) --
- environmentAccountConnection (dict) --
  
  The environment account connection detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment account connection.
  - environmentAccountId (string) --
    
    The environment account that's connected to the environment account connection.
  - environmentName (string) --
    
    The name of the environment that's associated with the environment account connection.
  - id (string) --
    
    The ID of the environment account connection.
  - lastModifiedAt (datetime) --
    
    The time when the environment account connection was last modified.
  - managementAccountId (string) --
    
    The ID of the management account that's connected to the environment account connection.
  - requestedAt (datetime) --
    
    The time when the environment account connection request was made.
  - roleArn (string) --
    
    The IAM service role that's associated with the environment account connection.
  - status (string) --
    
    The status of the environment account connection.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.InternalServerException

create_environment_template(**kwargs)¶

Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide .

You can create an environment template in one of the two following ways:

Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.
Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED . For more information, see Register and publish an environment template in the Proton Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_environment_template(
    description='string',
    displayName='string',
    encryptionKey='string',
    name='string',
    provisioning='CUSTOMER_MANAGED',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters

description (string) -- A description of the environment template.
displayName (string) -- The environment template name as displayed in the developer interface.
encryptionKey (string) -- A customer provided encryption key that Proton uses to encrypt data.
name (string) --
[REQUIRED]

The name of the environment template.
provisioning (string) -- When included, indicates that the environment template is for customer provisioned and managed infrastructure.
tags (list) --
Create tags for your environment template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplate (dict) --
  
  The environment template detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment template.
  - createdAt (datetime) --
    
    The time when the environment template was created.
  - description (string) --
    
    A description of the environment template.
  - displayName (string) --
    
    The name of the environment template as displayed in the developer interface.
  - encryptionKey (string) --
    
    The customer provided encryption key for the environment template.
  - lastModifiedAt (datetime) --
    
    The time when the environment template was last modified.
  - name (string) --
    
    The name of the environment template.
  - provisioning (string) --
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - recommendedVersion (string) --
    
    The ID of the recommended version of the environment template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.InternalServerException

create_environment_template_version(**kwargs)¶

Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.

See also: AWS API Documentation

Request Syntax

response = client.create_environment_template_version(
    clientToken='string',
    description='string',
    majorVersion='string',
    source={
        's3': {
            'bucket': 'string',
            'key': 'string'
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateName='string'
)

Parameters

clientToken (string) --
When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.

This field is autopopulated if not provided.
description (string) -- A description of the new version of an environment template.
majorVersion (string) --
To create a new minor version of the environment template, include a major Version .

To create a new major and minor version of the environment template, exclude major Version .
source (dict) --
[REQUIRED]

An object that includes the template bundle S3 bucket path and name for the new version of an template.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- s3 (dict) --
  An S3 source object that includes the template bundle S3 path and name for a template minor version.
  - bucket (string) -- [REQUIRED]
    The name of the S3 bucket that contains a template bundle.
  - key (string) -- [REQUIRED]
    The path to the S3 bucket that contains a template bundle.
tags (list) --
Create tags for a new version of an environment template.
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.
templateName (string) --
[REQUIRED]

The name of the environment template.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplateVersion': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplateVersion (dict) --
  
  The environment template detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of an environment template.
  - createdAt (datetime) --
    
    The time when the version of an environment template was created.
  - description (string) --
    
    A description of the minor version of an environment template.
  - lastModifiedAt (datetime) --
    
    The time when the version of an environment template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of an environment template.
  - minorVersion (string) --
    
    The minor version of an environment template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the environment template.
  - schema (string) --
    
    The schema of the version of an environment template.
  - status (string) --
    
    The status of the version of an environment template.
  - statusMessage (string) --
    
    The status message of the version of an environment template.
  - templateName (string) --
    
    The name of the version of an environment template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

create_repository(**kwargs)¶

Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the Proton Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_repository(
    connectionArn='string',
    encryptionKey='string',
    name='string',
    provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)

Parameters

connectionArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide .
encryptionKey (string) -- The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
name (string) --
[REQUIRED]

The repository name, for example myrepos/myrepo .
provider (string) --
[REQUIRED]

The repository provider.

Return type

dict

Returns

Response Syntax

{
    'repository': {
        'arn': 'string',
        'connectionArn': 'string',
        'encryptionKey': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    }
}

Response Structure

(dict) --
- repository (dict) --
  
  The repository detail data that's returned by Proton.
  - arn (string) --
    
    The repository Amazon Resource Name (ARN).
  - connectionArn (string) --
    
    The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
  - encryptionKey (string) --
    
    Your customer Amazon Web Services KMS encryption key.
  - name (string) --
    
    The repository name.
  - provider (string) --
    
    The repository provider.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.InternalServerException

create_service(**kwargs)¶

Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton Administrator Guide and Services in the Proton User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_service(
    branchName='string',
    description='string',
    name='string',
    repositoryConnectionArn='string',
    repositoryId='string',
    spec='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateMajorVersion='string',
    templateMinorVersion='string',
    templateName='string'
)

Parameters

branchName (string) -- The name of the code repository branch that holds the code that's deployed in Proton. Don't include this parameter if your service template doesn't include a service pipeline.
description (string) -- A description of the Proton service.
name (string) --
[REQUIRED]

The service name.
repositoryConnectionArn (string) -- The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide . Don't include this parameter if your service template doesn't include a service pipeline.
repositoryId (string) -- The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.
spec (string) --
[REQUIRED]

A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton Administrator Guide and Create a service in the Proton User Guide .
tags (list) --
Create tags for your service. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.
templateMajorVersion (string) --
[REQUIRED]

The major version of the service template that was used to create the service.
templateMinorVersion (string) -- The minor version of the service template that was used to create the service.
templateName (string) --
[REQUIRED]

The name of the service template that's used to create the service.

Return type

dict

Returns

Response Syntax

{
    'service': {
        'arn': 'string',
        'branchName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipeline': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'spec': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
        'repositoryConnectionArn': 'string',
        'repositoryId': 'string',
        'spec': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- service (dict) --
  
  The service detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service.
  - branchName (string) --
    
    The name of the code repository branch that holds the code that's deployed in Proton.
  - createdAt (datetime) --
    
    The time when the service was created.
  - description (string) --
    
    A description of a service.
  - lastModifiedAt (datetime) --
    
    The time when the service was last modified.
  - name (string) --
    
    The name of the service.
  - pipeline (dict) --
    
    The service pipeline detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the service pipeline.
    - createdAt (datetime) --
      
      The time when the service pipeline was created.
    - deploymentStatus (string) --
      
      The deployment status of the service pipeline.
    - deploymentStatusMessage (string) --
      
      A service pipeline deployment status message.
    - lastDeploymentAttemptedAt (datetime) --
      
      The time when a deployment of the service pipeline was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      
      The time when the service pipeline was last deployed successfully.
    - spec (string) --
      
      The service spec that was used to create the service pipeline.
    - templateMajorVersion (string) --
      
      The major version of the service template that was used to create the service pipeline.
    - templateMinorVersion (string) --
      
      The minor version of the service template that was used to create the service pipeline.
    - templateName (string) --
      
      The name of the service template that was used to create the service pipeline.
  - repositoryConnectionArn (string) --
    
    The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide .
  - repositoryId (string) --
    
    The ID of the source code repository.
  - spec (string) --
    
    The formatted specification that defines the service.
  - status (string) --
    
    The status of the service.
  - statusMessage (string) --
    
    A service status message.
  - templateName (string) --
    
    The name of the service template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

create_service_template(**kwargs)¶

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the Proton Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_service_template(
    description='string',
    displayName='string',
    encryptionKey='string',
    name='string',
    pipelineProvisioning='CUSTOMER_MANAGED',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters

description (string) -- A description of the service template.
displayName (string) -- The name of the service template as displayed in the developer interface.
encryptionKey (string) -- A customer provided encryption key that's used to encrypt data.
name (string) --
[REQUIRED]

The name of the service template.
pipelineProvisioning (string) -- Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline won't be included for your service. Once specified, this parameter can't be changed. For more information, see Service template bundles in the Proton Administrator Guide .
tags (list) --
Create tags for your service template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipelineProvisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplate (dict) --
  
  The service template detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service template.
  - createdAt (datetime) --
    
    The time when the service template was created.
  - description (string) --
    
    A description of the service template.
  - displayName (string) --
    
    The service template name as displayed in the developer interface.
  - encryptionKey (string) --
    
    The customer provided service template encryption key that's used to encrypt data.
  - lastModifiedAt (datetime) --
    
    The time when the service template was last modified.
  - name (string) --
    
    The name of the service template.
  - pipelineProvisioning (string) --
    
    If pipelineProvisioning is true , a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
  - recommendedVersion (string) --
    
    The recommended version of the service template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.InternalServerException

create_service_template_version(**kwargs)¶

Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.

See also: AWS API Documentation

Request Syntax

response = client.create_service_template_version(
    clientToken='string',
    compatibleEnvironmentTemplates=[
        {
            'majorVersion': 'string',
            'templateName': 'string'
        },
    ],
    description='string',
    majorVersion='string',
    source={
        's3': {
            'bucket': 'string',
            'key': 'string'
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    templateName='string'
)

Parameters

clientToken (string) --
When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.

This field is autopopulated if not provided.
compatibleEnvironmentTemplates (list) --
[REQUIRED]

An array of compatible environment template objects for the new version of a service template.
- (dict) --
  Compatible environment template data.
  - majorVersion (string) -- [REQUIRED]
    The major version of the compatible environment template.
  - templateName (string) -- [REQUIRED]
    The compatible environment template name.
description (string) -- A description of the new version of a service template.
majorVersion (string) --
To create a new minor version of the service template, include a major Version .

To create a new major and minor version of the service template, exclude major Version .
source (dict) --
[REQUIRED]

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
- s3 (dict) --
  An S3 source object that includes the template bundle S3 path and name for a template minor version.
  - bucket (string) -- [REQUIRED]
    The name of the S3 bucket that contains a template bundle.
  - key (string) -- [REQUIRED]
    The path to the S3 bucket that contains a template bundle.
tags (list) --
Create tags for a new version of a service template.
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.
templateName (string) --
[REQUIRED]

The name of the service template.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplateVersion': {
        'arn': 'string',
        'compatibleEnvironmentTemplates': [
            {
                'majorVersion': 'string',
                'templateName': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplateVersion (dict) --
  
  The service template version summary of detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of a service template.
  - compatibleEnvironmentTemplates (list) --
    
    An array of compatible environment template names for the major version of a service template.
    - (dict) --
      
      Compatible environment template data.
      - majorVersion (string) --
        
        The major version of the compatible environment template.
      - templateName (string) --
        
        The compatible environment template name.
  - createdAt (datetime) --
    
    The time when the version of a service template was created.
  - description (string) --
    
    A description of the version of a service template.
  - lastModifiedAt (datetime) --
    
    The time when the version of a service template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of a service template.
  - minorVersion (string) --
    
    The minor version of a service template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the service template.
  - schema (string) --
    
    The schema of the version of a service template.
  - status (string) --
    
    The service template version status.
  - statusMessage (string) --
    
    A service template version status message.
  - templateName (string) --
    
    The name of the version of a service template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

create_template_sync_config(**kwargs)¶

Set up a template for automated template version creation. When a commit is pushed to your registered repository , Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_template_sync_config(
    branch='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    subdirectory='string',
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)

Parameters

branch (string) --
[REQUIRED]

The branch of the registered repository for your template.
repositoryName (string) --
[REQUIRED]

The name of your repository, for example myrepos/myrepo .
repositoryProvider (string) --
[REQUIRED]

The provider type for your repository.
subdirectory (string) -- A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.
templateName (string) --
[REQUIRED]

The name of your registered template.
templateType (string) --
[REQUIRED]

The type of the registered template.

Return type

dict

Returns

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

(dict) --
- templateSyncConfig (dict) --
  
  The template sync configuration detail data that's returned by Proton.
  - branch (string) --
    
    The repository branch.
  - repositoryName (string) --
    
    The name of the repository, for example myrepos/myrepo .
  - repositoryProvider (string) --
    
    The repository provider.
  - subdirectory (string) --
    
    A subdirectory path to your template bundle version.
  - templateName (string) --
    
    The template name.
  - templateType (string) --
    
    The template type.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.InternalServerException

delete_environment(**kwargs)¶

Delete an environment.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the environment to delete.

Return type

dict

Returns

Response Syntax

{
    'environment': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentAccountConnectionId': 'string',
        'environmentAccountId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'protonServiceRoleArn': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'provisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  The environment detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment.
  - createdAt (datetime) --
    The time when the environment was created.
  - deploymentStatus (string) --
    The environment deployment status.
  - deploymentStatusMessage (string) --
    An environment deployment status message.
  - description (string) --
    The description of the environment.
  - environmentAccountConnectionId (string) --
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - environmentAccountId (string) --
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - lastDeploymentAttemptedAt (datetime) --
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    The time when the environment was last deployed successfully.
  - name (string) --
    The name of the environment.
  - protonServiceRoleArn (string) --
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning (string) --
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - provisioningRepository (dict) --
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      The repository branch.
    - name (string) --
      The repository name.
    - provider (string) --
      The repository provider.
  - spec (string) --
    The environment spec.
  - templateMajorVersion (string) --
    The ID of the major version of the environment template.
  - templateMinorVersion (string) --
    The ID of the minor version of the environment template.
  - templateName (string) --
    The Amazon Resource Name (ARN) of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_environment_account_connection(**kwargs)¶

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_environment_account_connection(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the environment account connection to delete.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

(dict) --
- environmentAccountConnection (dict) --
  The environment account connection detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment account connection.
  - environmentAccountId (string) --
    The environment account that's connected to the environment account connection.
  - environmentName (string) --
    The name of the environment that's associated with the environment account connection.
  - id (string) --
    The ID of the environment account connection.
  - lastModifiedAt (datetime) --
    The time when the environment account connection was last modified.
  - managementAccountId (string) --
    The ID of the management account that's connected to the environment account connection.
  - requestedAt (datetime) --
    The time when the environment account connection request was made.
  - roleArn (string) --
    The IAM service role that's associated with the environment account connection.
  - status (string) --
    The status of the environment account connection.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_environment_template(**kwargs)¶

If no other major or minor versions of an environment template exist, delete the environment template.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment_template(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the environment template to delete.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplate (dict) --
  The environment template detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment template.
  - createdAt (datetime) --
    The time when the environment template was created.
  - description (string) --
    A description of the environment template.
  - displayName (string) --
    The name of the environment template as displayed in the developer interface.
  - encryptionKey (string) --
    The customer provided encryption key for the environment template.
  - lastModifiedAt (datetime) --
    The time when the environment template was last modified.
  - name (string) --
    The name of the environment template.
  - provisioning (string) --
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - recommendedVersion (string) --
    The ID of the recommended version of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_environment_template_version(**kwargs)¶

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. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backward compatible.

Delete a minor version of an environment template if it isn't the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backward compatible.

See also: AWS API Documentation

Request Syntax

response = client.delete_environment_template_version(
    majorVersion='string',
    minorVersion='string',
    templateName='string'
)

Parameters

majorVersion (string) --
[REQUIRED]

The environment template major version to delete.
minorVersion (string) --
[REQUIRED]

The environment template minor version to delete.
templateName (string) --
[REQUIRED]

The name of the environment template.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplateVersion': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplateVersion (dict) --
  
  The environment template version detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of an environment template.
  - createdAt (datetime) --
    
    The time when the version of an environment template was created.
  - description (string) --
    
    A description of the minor version of an environment template.
  - lastModifiedAt (datetime) --
    
    The time when the version of an environment template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of an environment template.
  - minorVersion (string) --
    
    The minor version of an environment template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the environment template.
  - schema (string) --
    
    The schema of the version of an environment template.
  - status (string) --
    
    The status of the version of an environment template.
  - statusMessage (string) --
    
    The status message of the version of an environment template.
  - templateName (string) --
    
    The name of the version of an environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_repository(**kwargs)¶

De-register and unlink your repository.

See also: AWS API Documentation

Request Syntax

response = client.delete_repository(
    name='string',
    provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)

Parameters

name (string) --
[REQUIRED]

The name of the repository.
provider (string) --
[REQUIRED]

The repository provider.

Return type

dict

Returns

Response Syntax

{
    'repository': {
        'arn': 'string',
        'connectionArn': 'string',
        'encryptionKey': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    }
}

Response Structure

(dict) --
- repository (dict) --
  
  The repository detail data that's returned by Proton.
  - arn (string) --
    
    The repository Amazon Resource Name (ARN).
  - connectionArn (string) --
    
    The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
  - encryptionKey (string) --
    
    Your customer Amazon Web Services KMS encryption key.
  - name (string) --
    
    The repository name.
  - provider (string) --
    
    The repository provider.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_service(**kwargs)¶

Delete a service.

See also: AWS API Documentation

Request Syntax

response = client.delete_service(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the service to delete.

Return type

dict

Returns

Response Syntax

{
    'service': {
        'arn': 'string',
        'branchName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipeline': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'spec': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
        'repositoryConnectionArn': 'string',
        'repositoryId': 'string',
        'spec': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- service (dict) --
  The service detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the service.
  - branchName (string) --
    The name of the code repository branch that holds the code that's deployed in Proton.
  - createdAt (datetime) --
    The time when the service was created.
  - description (string) --
    A description of a service.
  - lastModifiedAt (datetime) --
    The time when the service was last modified.
  - name (string) --
    The name of the service.
  - pipeline (dict) --
    The service pipeline detail data.
    - arn (string) --
      The Amazon Resource Name (ARN) of the service pipeline.
    - createdAt (datetime) --
      The time when the service pipeline was created.
    - deploymentStatus (string) --
      The deployment status of the service pipeline.
    - deploymentStatusMessage (string) --
      A service pipeline deployment status message.
    - lastDeploymentAttemptedAt (datetime) --
      The time when a deployment of the service pipeline was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      The time when the service pipeline was last deployed successfully.
    - spec (string) --
      The service spec that was used to create the service pipeline.
    - templateMajorVersion (string) --
      The major version of the service template that was used to create the service pipeline.
    - templateMinorVersion (string) --
      The minor version of the service template that was used to create the service pipeline.
    - templateName (string) --
      The name of the service template that was used to create the service pipeline.
  - repositoryConnectionArn (string) --
    The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide .
  - repositoryId (string) --
    The ID of the source code repository.
  - spec (string) --
    The formatted specification that defines the service.
  - status (string) --
    The status of the service.
  - statusMessage (string) --
    A service status message.
  - templateName (string) --
    The name of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_service_template(**kwargs)¶

If no other major or minor versions of the service template exist, delete the service template.

See also: AWS API Documentation

Request Syntax

response = client.delete_service_template(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the service template to delete.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipelineProvisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplate (dict) --
  The service template detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the service template.
  - createdAt (datetime) --
    The time when the service template was created.
  - description (string) --
    A description of the service template.
  - displayName (string) --
    The service template name as displayed in the developer interface.
  - encryptionKey (string) --
    The customer provided service template encryption key that's used to encrypt data.
  - lastModifiedAt (datetime) --
    The time when the service template was last modified.
  - name (string) --
    The name of the service template.
  - pipelineProvisioning (string) --
    If pipelineProvisioning is true , a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
  - recommendedVersion (string) --
    The recommended version of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_service_template_version(**kwargs)¶

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. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn't backwards compatible.

Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible.

See also: AWS API Documentation

Request Syntax

response = client.delete_service_template_version(
    majorVersion='string',
    minorVersion='string',
    templateName='string'
)

Parameters

majorVersion (string) --
[REQUIRED]

The service template major version to delete.
minorVersion (string) --
[REQUIRED]

The service template minor version to delete.
templateName (string) --
[REQUIRED]

The name of the service template.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplateVersion': {
        'arn': 'string',
        'compatibleEnvironmentTemplates': [
            {
                'majorVersion': 'string',
                'templateName': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplateVersion (dict) --
  
  The service template version detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of a service template.
  - compatibleEnvironmentTemplates (list) --
    
    An array of compatible environment template names for the major version of a service template.
    - (dict) --
      
      Compatible environment template data.
      - majorVersion (string) --
        
        The major version of the compatible environment template.
      - templateName (string) --
        
        The compatible environment template name.
  - createdAt (datetime) --
    
    The time when the version of a service template was created.
  - description (string) --
    
    A description of the version of a service template.
  - lastModifiedAt (datetime) --
    
    The time when the version of a service template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of a service template.
  - minorVersion (string) --
    
    The minor version of a service template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the service template.
  - schema (string) --
    
    The schema of the version of a service template.
  - status (string) --
    
    The service template version status.
  - statusMessage (string) --
    
    A service template version status message.
  - templateName (string) --
    
    The name of the version of a service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

delete_template_sync_config(**kwargs)¶

Delete a template sync configuration.

See also: AWS API Documentation

Request Syntax

response = client.delete_template_sync_config(
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)

Parameters

templateName (string) --
[REQUIRED]

The template name.
templateType (string) --
[REQUIRED]

The template type.

Return type

dict

Returns

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

(dict) --
- templateSyncConfig (dict) --
  
  The template sync configuration detail data that's returned by Proton.
  - branch (string) --
    
    The repository branch.
  - repositoryName (string) --
    
    The name of the repository, for example myrepos/myrepo .
  - repositoryProvider (string) --
    
    The repository provider.
  - subdirectory (string) --
    
    A subdirectory path to your template bundle version.
  - templateName (string) --
    
    The template name.
  - templateType (string) --
    
    The template type.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_account_settings()¶

Get detail data for the Proton pipeline service role.

See also: AWS API Documentation

Request Syntax

response = client.get_account_settings()

Return type

dict

Returns

Response Syntax

{
    'accountSettings': {
        'pipelineProvisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'pipelineServiceRoleArn': 'string'
    }
}

Response Structure

(dict) --
- accountSettings (dict) --
  The Proton pipeline service role detail data that's returned by Proton.
  - pipelineProvisioningRepository (dict) --
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      The repository branch.
    - name (string) --
      The repository name.
    - provider (string) --
      The repository provider.
  - pipelineServiceRoleArn (string) --
    The Amazon Resource Name (ARN) of the Proton pipeline service role.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_environment(**kwargs)¶

Get detail data for an environment.

See also: AWS API Documentation

Request Syntax

response = client.get_environment(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the environment that you want to get the detail data for.

Return type

dict

Returns

Response Syntax

{
    'environment': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentAccountConnectionId': 'string',
        'environmentAccountId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'protonServiceRoleArn': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'provisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  The environment detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment.
  - createdAt (datetime) --
    The time when the environment was created.
  - deploymentStatus (string) --
    The environment deployment status.
  - deploymentStatusMessage (string) --
    An environment deployment status message.
  - description (string) --
    The description of the environment.
  - environmentAccountConnectionId (string) --
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - environmentAccountId (string) --
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - lastDeploymentAttemptedAt (datetime) --
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    The time when the environment was last deployed successfully.
  - name (string) --
    The name of the environment.
  - protonServiceRoleArn (string) --
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning (string) --
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - provisioningRepository (dict) --
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      The repository branch.
    - name (string) --
      The repository name.
    - provider (string) --
      The repository provider.
  - spec (string) --
    The environment spec.
  - templateMajorVersion (string) --
    The ID of the major version of the environment template.
  - templateMinorVersion (string) --
    The ID of the minor version of the environment template.
  - templateName (string) --
    The Amazon Resource Name (ARN) of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_environment_account_connection(**kwargs)¶

In an environment account, view the detail data for an environment account connection.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.get_environment_account_connection(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the environment account connection.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

(dict) --
- environmentAccountConnection (dict) --
  The environment account connection detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment account connection.
  - environmentAccountId (string) --
    The environment account that's connected to the environment account connection.
  - environmentName (string) --
    The name of the environment that's associated with the environment account connection.
  - id (string) --
    The ID of the environment account connection.
  - lastModifiedAt (datetime) --
    The time when the environment account connection was last modified.
  - managementAccountId (string) --
    The ID of the management account that's connected to the environment account connection.
  - requestedAt (datetime) --
    The time when the environment account connection request was made.
  - roleArn (string) --
    The IAM service role that's associated with the environment account connection.
  - status (string) --
    The status of the environment account connection.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_environment_template(**kwargs)¶

Get detail data for an environment template.

See also: AWS API Documentation

Request Syntax

response = client.get_environment_template(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the environment template that you want to get the detail data for.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplate (dict) --
  The environment template detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment template.
  - createdAt (datetime) --
    The time when the environment template was created.
  - description (string) --
    A description of the environment template.
  - displayName (string) --
    The name of the environment template as displayed in the developer interface.
  - encryptionKey (string) --
    The customer provided encryption key for the environment template.
  - lastModifiedAt (datetime) --
    The time when the environment template was last modified.
  - name (string) --
    The name of the environment template.
  - provisioning (string) --
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - recommendedVersion (string) --
    The ID of the recommended version of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_environment_template_version(**kwargs)¶

View detail data for a major or minor version of an environment template.

See also: AWS API Documentation

Request Syntax

response = client.get_environment_template_version(
    majorVersion='string',
    minorVersion='string',
    templateName='string'
)

Parameters

majorVersion (string) --
[REQUIRED]

To view environment template major version detail data, include major Version .
minorVersion (string) --
[REQUIRED]

To view environment template minor version detail data, include minorVersion .
templateName (string) --
[REQUIRED]

The name of the environment template.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplateVersion': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplateVersion (dict) --
  
  The environment template version detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of an environment template.
  - createdAt (datetime) --
    
    The time when the version of an environment template was created.
  - description (string) --
    
    A description of the minor version of an environment template.
  - lastModifiedAt (datetime) --
    
    The time when the version of an environment template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of an environment template.
  - minorVersion (string) --
    
    The minor version of an environment template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the environment template.
  - schema (string) --
    
    The schema of the version of an environment template.
  - status (string) --
    
    The status of the version of an environment template.
  - statusMessage (string) --
    
    The status message of the version of an environment template.
  - templateName (string) --
    
    The name of the version of an environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_repository(**kwargs)¶

Get detail data for a repository.

See also: AWS API Documentation

Request Syntax

response = client.get_repository(
    name='string',
    provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)

Parameters

name (string) --
[REQUIRED]

The repository name, for example myrepos/myrepo .
provider (string) --
[REQUIRED]

The repository provider.

Return type

dict

Returns

Response Syntax

{
    'repository': {
        'arn': 'string',
        'connectionArn': 'string',
        'encryptionKey': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    }
}

Response Structure

(dict) --
- repository (dict) --
  
  The repository detail data that's returned by Proton.
  - arn (string) --
    
    The repository Amazon Resource Name (ARN).
  - connectionArn (string) --
    
    The repository Amazon Web Services CodeStar connection that connects Proton to your repository.
  - encryptionKey (string) --
    
    Your customer Amazon Web Services KMS encryption key.
  - name (string) --
    
    The repository name.
  - provider (string) --
    
    The repository provider.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_repository_sync_status(**kwargs)¶

Get the repository sync status.

See also: AWS API Documentation

Request Syntax

response = client.get_repository_sync_status(
    branch='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    syncType='TEMPLATE_SYNC'
)

Parameters

branch (string) --
[REQUIRED]

The repository branch.
repositoryName (string) --
[REQUIRED]

The repository name.
repositoryProvider (string) --
[REQUIRED]

The repository provider.
syncType (string) --
[REQUIRED]

The repository sync type.

Return type

dict

Returns

Response Syntax

{
    'latestSync': {
        'events': [
            {
                'event': 'string',
                'externalId': 'string',
                'time': datetime(2015, 1, 1),
                'type': 'string'
            },
        ],
        'startedAt': datetime(2015, 1, 1),
        'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'QUEUED'
    }
}

Response Structure

(dict) --
- latestSync (dict) --
  
  The repository sync status detail data that's returned by Proton.
  - events (list) --
    
    Detail data for sync attempt events.
    - (dict) --
      
      Repository sync event detail data for a sync attempt.
      - event (string) --
        
        Event detail for a repository sync attempt.
      - externalId (string) --
        
        The external ID of the sync event.
      - time (datetime) --
        
        The time that the sync event occurred.
      - type (string) --
        
        The type of event.
  - startedAt (datetime) --
    
    The time when the sync attempt started.
  - status (string) --
    
    The sync attempt status.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_service(**kwargs)¶

Get detail data for a service.

See also: AWS API Documentation

Request Syntax

response = client.get_service(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the service that you want to get the detail data for.

Return type

dict

Returns

Response Syntax

{
    'service': {
        'arn': 'string',
        'branchName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipeline': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'spec': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
        'repositoryConnectionArn': 'string',
        'repositoryId': 'string',
        'spec': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- service (dict) --
  The service detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the service.
  - branchName (string) --
    The name of the code repository branch that holds the code that's deployed in Proton.
  - createdAt (datetime) --
    The time when the service was created.
  - description (string) --
    A description of a service.
  - lastModifiedAt (datetime) --
    The time when the service was last modified.
  - name (string) --
    The name of the service.
  - pipeline (dict) --
    The service pipeline detail data.
    - arn (string) --
      The Amazon Resource Name (ARN) of the service pipeline.
    - createdAt (datetime) --
      The time when the service pipeline was created.
    - deploymentStatus (string) --
      The deployment status of the service pipeline.
    - deploymentStatusMessage (string) --
      A service pipeline deployment status message.
    - lastDeploymentAttemptedAt (datetime) --
      The time when a deployment of the service pipeline was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      The time when the service pipeline was last deployed successfully.
    - spec (string) --
      The service spec that was used to create the service pipeline.
    - templateMajorVersion (string) --
      The major version of the service template that was used to create the service pipeline.
    - templateMinorVersion (string) --
      The minor version of the service template that was used to create the service pipeline.
    - templateName (string) --
      The name of the service template that was used to create the service pipeline.
  - repositoryConnectionArn (string) --
    The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide .
  - repositoryId (string) --
    The ID of the source code repository.
  - spec (string) --
    The formatted specification that defines the service.
  - status (string) --
    The status of the service.
  - statusMessage (string) --
    A service status message.
  - templateName (string) --
    The name of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_service_instance(**kwargs)¶

Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.

See also: AWS API Documentation

Request Syntax

response = client.get_service_instance(
    name='string',
    serviceName='string'
)

Parameters

name (string) --
[REQUIRED]

The name of a service instance that you want to get the detail data for.
serviceName (string) --
[REQUIRED]

The name of the service that the service instance belongs to.

Return type

dict

Returns

Response Syntax

{
    'serviceInstance': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'environmentName': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'serviceName': 'string',
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceInstance (dict) --
  
  The service instance detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service instance.
  - createdAt (datetime) --
    
    The time when the service instance was created.
  - deploymentStatus (string) --
    
    The service instance deployment status.
  - deploymentStatusMessage (string) --
    
    A service instance deployment status message.
  - environmentName (string) --
    
    The name of the environment that the service instance was deployed into.
  - lastDeploymentAttemptedAt (datetime) --
    
    The time when a deployment of the service instance was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    
    The time when the service instance was last deployed successfully.
  - name (string) --
    
    The name of the service instance.
  - serviceName (string) --
    
    The name of the service that the service instance belongs to.
  - spec (string) --
    
    The service spec that was used to create the service instance.
  - templateMajorVersion (string) --
    
    The major version of the service template that was used to create the service instance.
  - templateMinorVersion (string) --
    
    The minor version of the service template that was used to create the service instance.
  - templateName (string) --
    
    The name of the service template that was used to create the service instance.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_service_template(**kwargs)¶

Get detail data for a service template.

See also: AWS API Documentation

Request Syntax

response = client.get_service_template(
    name='string'
)

Parameters

name (string) --

[REQUIRED]

The name of the service template that you want to get detail data for.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipelineProvisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplate (dict) --
  The service template detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the service template.
  - createdAt (datetime) --
    The time when the service template was created.
  - description (string) --
    A description of the service template.
  - displayName (string) --
    The service template name as displayed in the developer interface.
  - encryptionKey (string) --
    The customer provided service template encryption key that's used to encrypt data.
  - lastModifiedAt (datetime) --
    The time when the service template was last modified.
  - name (string) --
    The name of the service template.
  - pipelineProvisioning (string) --
    If pipelineProvisioning is true , a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
  - recommendedVersion (string) --
    The recommended version of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_service_template_version(**kwargs)¶

View detail data for a major or minor version of a service template.

See also: AWS API Documentation

Request Syntax

response = client.get_service_template_version(
    majorVersion='string',
    minorVersion='string',
    templateName='string'
)

Parameters

majorVersion (string) --
[REQUIRED]

To view service template major version detail data, include major Version .
minorVersion (string) --
[REQUIRED]

To view service template minor version detail data, include minorVersion .
templateName (string) --
[REQUIRED]

The name of the service template.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplateVersion': {
        'arn': 'string',
        'compatibleEnvironmentTemplates': [
            {
                'majorVersion': 'string',
                'templateName': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplateVersion (dict) --
  
  The service template version detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of a service template.
  - compatibleEnvironmentTemplates (list) --
    
    An array of compatible environment template names for the major version of a service template.
    - (dict) --
      
      Compatible environment template data.
      - majorVersion (string) --
        
        The major version of the compatible environment template.
      - templateName (string) --
        
        The compatible environment template name.
  - createdAt (datetime) --
    
    The time when the version of a service template was created.
  - description (string) --
    
    A description of the version of a service template.
  - lastModifiedAt (datetime) --
    
    The time when the version of a service template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of a service template.
  - minorVersion (string) --
    
    The minor version of a service template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the service template.
  - schema (string) --
    
    The schema of the version of a service template.
  - status (string) --
    
    The service template version status.
  - statusMessage (string) --
    
    A service template version status message.
  - templateName (string) --
    
    The name of the version of a service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_template_sync_config(**kwargs)¶

Get detail data for a template sync configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_template_sync_config(
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)

Parameters

templateName (string) --
[REQUIRED]

The template name.
templateType (string) --
[REQUIRED]

The template type.

Return type

dict

Returns

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

(dict) --
- templateSyncConfig (dict) --
  
  The template sync configuration detail data that's returned by Proton.
  - branch (string) --
    
    The repository branch.
  - repositoryName (string) --
    
    The name of the repository, for example myrepos/myrepo .
  - repositoryProvider (string) --
    
    The repository provider.
  - subdirectory (string) --
    
    A subdirectory path to your template bundle version.
  - templateName (string) --
    
    The template name.
  - templateType (string) --
    
    The template type.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_template_sync_status(**kwargs)¶

Get the status of a template sync.

See also: AWS API Documentation

Request Syntax

response = client.get_template_sync_status(
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE',
    templateVersion='string'
)

Parameters

templateName (string) --
[REQUIRED]

The template name.
templateType (string) --
[REQUIRED]

The template type.
templateVersion (string) --
[REQUIRED]

The template version.

Return type

dict

Returns

Response Syntax

{
    'desiredState': {
        'branch': 'string',
        'directory': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'sha': 'string'
    },
    'latestSuccessfulSync': {
        'events': [
            {
                'event': 'string',
                'externalId': 'string',
                'time': datetime(2015, 1, 1),
                'type': 'string'
            },
        ],
        'initialRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        },
        'startedAt': datetime(2015, 1, 1),
        'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'target': 'string',
        'targetRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        }
    },
    'latestSync': {
        'events': [
            {
                'event': 'string',
                'externalId': 'string',
                'time': datetime(2015, 1, 1),
                'type': 'string'
            },
        ],
        'initialRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        },
        'startedAt': datetime(2015, 1, 1),
        'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
        'target': 'string',
        'targetRevision': {
            'branch': 'string',
            'directory': 'string',
            'repositoryName': 'string',
            'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
            'sha': 'string'
        }
    }
}

Response Structure

(dict) --
- desiredState (dict) --
  
  The template sync desired state that's returned by Proton.
  - branch (string) --
    
    The repository branch.
  - directory (string) --
    
    The repository directory changed by a commit and push that activated the sync attempt.
  - repositoryName (string) --
    
    The repository name.
  - repositoryProvider (string) --
    
    The repository provider.
  - sha (string) --
    
    The secure hash algorithm (SHA) hash for the revision.
- latestSuccessfulSync (dict) --
  
  The details of the last successful sync that's returned by Proton.
  - events (list) --
    
    An array of events with detail data.
    - (dict) --
      
      Detail data for a resource sync event.
      - event (string) --
        
        A resource sync event.
      - externalId (string) --
        
        The external ID for the event.
      - time (datetime) --
        
        The time when the event occurred.
      - type (string) --
        
        The type of event.
  - initialRevision (dict) --
    
    Detail data for the initial repository commit, path and push.
    - branch (string) --
      
      The repository branch.
    - directory (string) --
      
      The repository directory changed by a commit and push that activated the sync attempt.
    - repositoryName (string) --
      
      The repository name.
    - repositoryProvider (string) --
      
      The repository provider.
    - sha (string) --
      
      The secure hash algorithm (SHA) hash for the revision.
  - startedAt (datetime) --
    
    The time when the sync attempt started.
  - status (string) --
    
    The status of the sync attempt.
  - target (string) --
    
    The resource that is synced to.
  - targetRevision (dict) --
    
    Detail data for the target revision.
    - branch (string) --
      
      The repository branch.
    - directory (string) --
      
      The repository directory changed by a commit and push that activated the sync attempt.
    - repositoryName (string) --
      
      The repository name.
    - repositoryProvider (string) --
      
      The repository provider.
    - sha (string) --
      
      The secure hash algorithm (SHA) hash for the revision.
- latestSync (dict) --
  
  The details of the last sync that's returned by Proton.
  - events (list) --
    
    An array of events with detail data.
    - (dict) --
      
      Detail data for a resource sync event.
      - event (string) --
        
        A resource sync event.
      - externalId (string) --
        
        The external ID for the event.
      - time (datetime) --
        
        The time when the event occurred.
      - type (string) --
        
        The type of event.
  - initialRevision (dict) --
    
    Detail data for the initial repository commit, path and push.
    - branch (string) --
      
      The repository branch.
    - directory (string) --
      
      The repository directory changed by a commit and push that activated the sync attempt.
    - repositoryName (string) --
      
      The repository name.
    - repositoryProvider (string) --
      
      The repository provider.
    - sha (string) --
      
      The secure hash algorithm (SHA) hash for the revision.
  - startedAt (datetime) --
    
    The time when the sync attempt started.
  - status (string) --
    
    The status of the sync attempt.
  - target (string) --
    
    The resource that is synced to.
  - targetRevision (dict) --
    
    Detail data for the target revision.
    - branch (string) --
      
      The repository branch.
    - directory (string) --
      
      The repository directory changed by a commit and push that activated the sync attempt.
    - repositoryName (string) --
      
      The repository name.
    - repositoryProvider (string) --
      
      The repository provider.
    - sha (string) --
      
      The secure hash algorithm (SHA) hash for the revision.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_environment_account_connections(**kwargs)¶

View a list of environment account connections.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.list_environment_account_connections(
    environmentName='string',
    maxResults=123,
    nextToken='string',
    requestedBy='MANAGEMENT_ACCOUNT'|'ENVIRONMENT_ACCOUNT',
    statuses=[
        'PENDING'|'CONNECTED'|'REJECTED',
    ]
)

Parameters

environmentName (string) -- The environment name that's associated with each listed environment account connection.
maxResults (integer) -- The maximum number of environment account connections to list.
nextToken (string) -- A token to indicate the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
requestedBy (string) --
[REQUIRED]

The type of account making the ListEnvironmentAccountConnections request.
statuses (list) --
The status details for each listed environment account connection.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnections': [
        {
            'arn': 'string',
            'environmentAccountId': 'string',
            'environmentName': 'string',
            'id': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'managementAccountId': 'string',
            'requestedAt': datetime(2015, 1, 1),
            'roleArn': 'string',
            'status': 'PENDING'|'CONNECTED'|'REJECTED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- environmentAccountConnections (list) --
  
  An array of environment account connections with details that's returned by Proton.
  - (dict) --
    
    A summary of the environment account connection detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the environment account connection.
    - environmentAccountId (string) --
      
      The ID of the environment account that's connected to the environment account connection.
    - environmentName (string) --
      
      The name of the environment that's associated with the environment account connection.
    - id (string) --
      
      The ID of the environment account connection.
    - lastModifiedAt (datetime) --
      
      The time when the environment account connection was last modified.
    - managementAccountId (string) --
      
      The ID of the management account that's connected to the environment account connection.
    - requestedAt (datetime) --
      
      The time when the environment account connection request was made.
    - roleArn (string) --
      
      The IAM service role that's associated with the environment account connection.
    - status (string) --
      
      The status of the environment account connection.
- nextToken (string) --
  
  A token to indicate the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.InternalServerException

list_environment_outputs(**kwargs)¶

List the infrastructure as code outputs for your environment.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_outputs(
    environmentName='string',
    nextToken='string'
)

Parameters

environmentName (string) --
[REQUIRED]

The environment name.
nextToken (string) -- A token to indicate the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.
- outputs (list) --
  
  An array of environment outputs with detail data.
  - (dict) --
    
    An infrastructure as code defined resource output.
    - key (string) --
      
      The output key.
    - valueString (string) --
      
      The output value.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_environment_provisioned_resources(**kwargs)¶

List the provisioned resources for your environment.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_provisioned_resources(
    environmentName='string',
    nextToken='string'
)

Parameters

environmentName (string) --
[REQUIRED]

The environment name.
nextToken (string) -- A token to indicate the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.
- provisionedResources (list) --
  
  An array of environment provisioned resources.
  - (dict) --
    
    Detail data for a provisioned resource.
    - identifier (string) --
      
      The provisioned resource identifier.
    - name (string) --
      
      The provisioned resource name.
    - provisioningEngine (string) --
      
      The resource provisioning engine.
      
      Warning
      
      Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_environment_template_versions(**kwargs)¶

List major or minor versions of an environment template with detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_template_versions(
    majorVersion='string',
    maxResults=123,
    nextToken='string',
    templateName='string'
)

Parameters

majorVersion (string) --
To view a list of minor of versions under a major version of an environment template, include major Version .

To view a list of major versions of an environment template, exclude major Version .
maxResults (integer) -- The maximum number of major or minor versions of an environment template to list.
nextToken (string) -- A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
templateName (string) --
[REQUIRED]

The name of the environment template.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'templateVersions': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'majorVersion': 'string',
            'minorVersion': 'string',
            'recommendedMinorVersion': 'string',
            'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
- templateVersions (list) --
  
  An array of major or minor versions of an environment template detail data.
  - (dict) --
    
    A summary of the version of an environment template detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the version of an environment template.
    - createdAt (datetime) --
      
      The time when the version of an environment template was created.
    - description (string) --
      
      A description of the version of an environment template.
    - lastModifiedAt (datetime) --
      
      The time when the version of an environment template was last modified.
    - majorVersion (string) --
      
      The latest major version that's associated with the version of an environment template.
    - minorVersion (string) --
      
      The version of an environment template.
    - recommendedMinorVersion (string) --
      
      The recommended minor version of the environment template.
    - status (string) --
      
      The status of the version of an environment template.
    - statusMessage (string) --
      
      The status message of the version of an environment template.
    - templateName (string) --
      
      The name of the version of an environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_environment_templates(**kwargs)¶

List environment templates.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_templates(
    maxResults=123,
    nextToken='string'
)

Parameters

maxResults (integer) -- The maximum number of environment templates to list.
nextToken (string) -- A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'templates': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'displayName': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'provisioning': 'CUSTOMER_MANAGED',
            'recommendedVersion': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next environment template in the array of environment templates, after the current requested list of environment templates.
- templates (list) --
  
  An array of environment templates with detail data.
  - (dict) --
    
    The environment template data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the environment template.
    - createdAt (datetime) --
      
      The time when the environment template was created.
    - description (string) --
      
      A description of the environment template.
    - displayName (string) --
      
      The name of the environment template as displayed in the developer interface.
    - lastModifiedAt (datetime) --
      
      The time when the environment template was last modified.
    - name (string) --
      
      The name of the environment template.
    - provisioning (string) --
      
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    - recommendedVersion (string) --
      
      The recommended version of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.InternalServerException

list_environments(**kwargs)¶

List environments with detail data summaries.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
    environmentTemplates=[
        {
            'majorVersion': 'string',
            'templateName': 'string'
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters

environmentTemplates (list) --
An array of the versions of the environment template.
- (dict) --
  A search filter for environment templates.
  - majorVersion (string) -- [REQUIRED]
    Include majorVersion to filter search for a major version.
  - templateName (string) -- [REQUIRED]
    Include templateName to filter search for a template name.
maxResults (integer) -- The maximum number of environments to list.
nextToken (string) -- A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.

Return type

dict

Returns

Response Syntax

{
    'environments': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'description': 'string',
            'environmentAccountConnectionId': 'string',
            'environmentAccountId': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'name': 'string',
            'protonServiceRoleArn': 'string',
            'provisioning': 'CUSTOMER_MANAGED',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- environments (list) --
  
  An array of environment detail data summaries.
  - (dict) --
    
    A summary of the environment detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the environment.
    - createdAt (datetime) --
      
      The time when the environment was created.
    - deploymentStatus (string) --
      
      The environment deployment status.
    - deploymentStatusMessage (string) --
      
      An environment deployment status message.
    - description (string) --
      
      The description of the environment.
    - environmentAccountConnectionId (string) --
      
      The ID of the environment account connection that the environment is associated with.
    - environmentAccountId (string) --
      
      The ID of the environment account that the environment infrastructure resources are provisioned in.
    - lastDeploymentAttemptedAt (datetime) --
      
      The time when a deployment of the environment was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      
      The time when the environment was last deployed successfully.
    - name (string) --
      
      The name of the environment.
    - protonServiceRoleArn (string) --
      
      The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
    - provisioning (string) --
      
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    - templateMajorVersion (string) --
      
      The major version of the environment template.
    - templateMinorVersion (string) --
      
      The minor version of the environment template.
    - templateName (string) --
      
      The name of the environment template.
- nextToken (string) --
  
  A token to indicate the location of the next environment in the array of environments, after the current requested list of environments.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_repositories(**kwargs)¶

List repositories with detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_repositories(
    maxResults=123,
    nextToken='string'
)

Parameters

maxResults (integer) -- The maximum number of repositories to list.
nextToken (string) -- A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'repositories': [
        {
            'arn': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next repository in the array of repositories, after the current requested list of repositories.
- repositories (list) --
  
  An array of repositories.
  - (dict) --
    
    A summary of detail data for a registered repository.
    - arn (string) --
      
      The Amazon Resource Name (ARN) for a repository.
    - name (string) --
      
      The repository name.
    - provider (string) --
      
      The repository provider.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_repository_sync_definitions(**kwargs)¶

List repository sync definitions with detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_repository_sync_definitions(
    nextToken='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    syncType='TEMPLATE_SYNC'
)

Parameters

nextToken (string) -- A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.
repositoryName (string) --
[REQUIRED]

The repository name.
repositoryProvider (string) --
[REQUIRED]

The repository provider.
syncType (string) --
[REQUIRED]

The sync type. The only supported value is TEMPLATE_SYNC .

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'syncDefinitions': [
        {
            'branch': 'string',
            'directory': 'string',
            'parent': 'string',
            'target': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.
- syncDefinitions (list) --
  
  An array of repository sync definitions.
  - (dict) --
    
    The repository sync definition.
    - branch (string) --
      
      The repository branch.
    - directory (string) --
      
      The directory in the repository.
    - parent (string) --
      
      The resource that is synced from.
    - target (string) --
      
      The resource that is synced to.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.InternalServerException

list_service_instance_outputs(**kwargs)¶

View a list service instance infrastructure as code outputs with detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_service_instance_outputs(
    nextToken='string',
    serviceInstanceName='string',
    serviceName='string'
)

Parameters

nextToken (string) -- A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
serviceInstanceName (string) --
[REQUIRED]

The service instance name.
serviceName (string) --
[REQUIRED]

The service name.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
- outputs (list) --
  
  An array of service instance infrastructure as code outputs.
  - (dict) --
    
    An infrastructure as code defined resource output.
    - key (string) --
      
      The output key.
    - valueString (string) --
      
      The output value.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_service_instance_provisioned_resources(**kwargs)¶

List provisioned resources for a service instance with details.

See also: AWS API Documentation

Request Syntax

response = client.list_service_instance_provisioned_resources(
    nextToken='string',
    serviceInstanceName='string',
    serviceName='string'
)

Parameters

nextToken (string) -- A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
serviceInstanceName (string) --
[REQUIRED]

The service instance name.
serviceName (string) --
[REQUIRED]

The service name.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
- provisionedResources (list) --
  
  An array of provisioned resources for a service instance.
  - (dict) --
    
    Detail data for a provisioned resource.
    - identifier (string) --
      
      The provisioned resource identifier.
    - name (string) --
      
      The provisioned resource name.
    - provisioningEngine (string) --
      
      The resource provisioning engine.
      
      Warning
      
      Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_service_instances(**kwargs)¶

List service instances with summaries of detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_service_instances(
    maxResults=123,
    nextToken='string',
    serviceName='string'
)

Parameters

maxResults (integer) -- The maximum number of service instances to list.
nextToken (string) -- A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.
serviceName (string) -- The name of the service that the service instance belongs to.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'serviceInstances': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'environmentName': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'name': 'string',
            'serviceName': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next service instance in the array of service instances, after the current requested list of service instances.
- serviceInstances (list) --
  
  An array of service instances with summaries of detail data.
  - (dict) --
    
    A summary of the service instance detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the service instance.
    - createdAt (datetime) --
      
      The time when the service instance was created.
    - deploymentStatus (string) --
      
      The service instance deployment status.
    - deploymentStatusMessage (string) --
      
      A service instance deployment status message.
    - environmentName (string) --
      
      The name of the environment that the service instance was deployed into.
    - lastDeploymentAttemptedAt (datetime) --
      
      The time when a deployment of the service was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      
      The time when the service was last deployed successfully.
    - name (string) --
      
      The name of the service instance.
    - serviceName (string) --
      
      The name of the service that the service instance belongs to.
    - templateMajorVersion (string) --
      
      The service instance template major version.
    - templateMinorVersion (string) --
      
      The service instance template minor version.
    - templateName (string) --
      
      The name of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_service_pipeline_outputs(**kwargs)¶

View a list service pipeline infrastructure as code outputs with detail.

See also: AWS API Documentation

Request Syntax

response = client.list_service_pipeline_outputs(
    nextToken='string',
    serviceName='string'
)

Parameters

nextToken (string) -- A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
serviceName (string) --
[REQUIRED]

The service name.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
- outputs (list) --
  
  An array of outputs.
  - (dict) --
    
    An infrastructure as code defined resource output.
    - key (string) --
      
      The output key.
    - valueString (string) --
      
      The output value.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_service_pipeline_provisioned_resources(**kwargs)¶

List provisioned resources for a service and pipeline with details.

See also: AWS API Documentation

Request Syntax

response = client.list_service_pipeline_provisioned_resources(
    nextToken='string',
    serviceName='string'
)

Parameters

nextToken (string) -- A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
serviceName (string) --
[REQUIRED]

The service name.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
- provisionedResources (list) --
  
  An array of provisioned resources for a service and pipeline.
  - (dict) --
    
    Detail data for a provisioned resource.
    - identifier (string) --
      
      The provisioned resource identifier.
    - name (string) --
      
      The provisioned resource name.
    - provisioningEngine (string) --
      
      The resource provisioning engine.
      
      Warning
      
      Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_service_template_versions(**kwargs)¶

List major or minor versions of a service template with detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_service_template_versions(
    majorVersion='string',
    maxResults=123,
    nextToken='string',
    templateName='string'
)

Parameters

majorVersion (string) --
To view a list of minor of versions under a major version of a service template, include major Version .

To view a list of major versions of a service template, exclude major Version .
maxResults (integer) -- The maximum number of major or minor versions of a service template to list.
nextToken (string) -- A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.
templateName (string) --
[REQUIRED]

The name of the service template.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'templateVersions': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'majorVersion': 'string',
            'minorVersion': 'string',
            'recommendedMinorVersion': 'string',
            'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.
- templateVersions (list) --
  
  An array of major or minor versions of a service template with detail data.
  - (dict) --
    
    A summary of the service template version detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the version of a service template.
    - createdAt (datetime) --
      
      The time when the version of a service template was created.
    - description (string) --
      
      A description of the version of a service template.
    - lastModifiedAt (datetime) --
      
      The time when the version of a service template was last modified.
    - majorVersion (string) --
      
      The latest major version that's associated with the version of a service template.
    - minorVersion (string) --
      
      The minor version of a service template.
    - recommendedMinorVersion (string) --
      
      The recommended minor version of the service template.
    - status (string) --
      
      The service template minor version status.
    - statusMessage (string) --
      
      A service template minor version status message.
    - templateName (string) --
      
      The name of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

list_service_templates(**kwargs)¶

List service templates with detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_service_templates(
    maxResults=123,
    nextToken='string'
)

Parameters

maxResults (integer) -- The maximum number of service templates to list.
nextToken (string) -- A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'templates': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'displayName': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'pipelineProvisioning': 'CUSTOMER_MANAGED',
            'recommendedVersion': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next service template in the array of service templates, after the current requested list of service templates.
- templates (list) --
  
  An array of service templates with detail data.
  - (dict) --
    
    The service template summary data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the service template.
    - createdAt (datetime) --
      
      The time when the service template was created.
    - description (string) --
      
      A description of the service template.
    - displayName (string) --
      
      The service template name as displayed in the developer interface.
    - lastModifiedAt (datetime) --
      
      The time when the service template was last modified.
    - name (string) --
      
      The name of the service template.
    - pipelineProvisioning (string) --
      
      If pipelineProvisioning is true , a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.
    - recommendedVersion (string) --
      
      The recommended version of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.InternalServerException

list_services(**kwargs)¶

List services with summaries of detail data.

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    maxResults=123,
    nextToken='string'
)

Parameters

maxResults (integer) -- The maximum number of services to list.
nextToken (string) -- A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'services': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next service in the array of services, after the current requested list of services.
- services (list) --
  
  An array of services with summaries of detail data.
  - (dict) --
    
    A summary of the service detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the service.
    - createdAt (datetime) --
      
      The time when the service was created.
    - description (string) --
      
      A description of the service.
    - lastModifiedAt (datetime) --
      
      The time when the service was last modified.
    - name (string) --
      
      The name of the service.
    - status (string) --
      
      The status of the service.
    - statusMessage (string) --
      
      A service status message.
    - templateName (string) --
      
      The name of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.InternalServerException

list_tags_for_resource(**kwargs)¶

List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    maxResults=123,
    nextToken='string',
    resourceArn='string'
)

Parameters

maxResults (integer) -- The maximum number of tags to list.
nextToken (string) -- A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.
resourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource for the listed tags.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.
- tags (list) --
  
  An array of resource tags with detail data.
  - (dict) --
    
    A description of a resource tag.
    - key (string) --
      
      The key of the resource tag.
    - value (string) --
      
      The value of the resource tag.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

notify_resource_deployment_status_change(**kwargs)¶

Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles .

Warning

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.

See also: AWS API Documentation

Request Syntax

response = client.notify_resource_deployment_status_change(
    deploymentId='string',
    outputs=[
        {
            'key': 'string',
            'valueString': 'string'
        },
    ],
    resourceArn='string',
    status='IN_PROGRESS'|'FAILED'|'SUCCEEDED',
    statusMessage='string'
)

Parameters

deploymentId (string) -- The deployment ID for your provisioned resource.
outputs (list) --
The provisioned resource state change detail data that's returned by Proton.
- (dict) --
  An infrastructure as code defined resource output.
  - key (string) --
    The output key.
  - valueString (string) --
    The output value.
resourceArn (string) --
[REQUIRED]

The provisioned resource Amazon Resource Name (ARN).
status (string) --
[REQUIRED]

The status of your provisioned resource.
statusMessage (string) -- The deployment status message for your provisioned resource.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

reject_environment_account_connection(**kwargs)¶

In a management account, reject an environment account connection from another environment account.

After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.

You can’t reject an environment account connection that is connected to an environment.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.reject_environment_account_connection(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the environment account connection to reject.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

(dict) --
- environmentAccountConnection (dict) --
  The environment connection account detail data that's returned by Proton.
  - arn (string) --
    The Amazon Resource Name (ARN) of the environment account connection.
  - environmentAccountId (string) --
    The environment account that's connected to the environment account connection.
  - environmentName (string) --
    The name of the environment that's associated with the environment account connection.
  - id (string) --
    The ID of the environment account connection.
  - lastModifiedAt (datetime) --
    The time when the environment account connection was last modified.
  - managementAccountId (string) --
    The ID of the management account that's connected to the environment account connection.
  - requestedAt (datetime) --
    The time when the environment account connection request was made.
  - roleArn (string) --
    The IAM service role that's associated with the environment account connection.
  - status (string) --
    The status of the environment account connection.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

tag_resource(**kwargs)¶

Tag a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters

resourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.
tags (list) --
[REQUIRED]

An array of resource tags to apply to a resource.
- (dict) --
  A description of a resource tag.
  - key (string) -- [REQUIRED]
    The key of the resource tag.
  - value (string) -- [REQUIRED]
    The value of the resource tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

untag_resource(**kwargs)¶

Remove a tag from a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide .

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

Parameters

resourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.
tagKeys (list) --
[REQUIRED]

An array of tag keys indicating the resource tags to be removed from the resource.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_account_settings(**kwargs)¶

Update the Proton service pipeline role or repository settings.

See also: AWS API Documentation

Request Syntax

response = client.update_account_settings(
    pipelineProvisioningRepository={
        'branch': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    },
    pipelineServiceRoleArn='string'
)

Parameters

pipelineProvisioningRepository (dict) --
The repository that you provide with pull request provisioning.

Warning

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
- branch (string) -- [REQUIRED]
  The repository branch.
- name (string) -- [REQUIRED]
  The repository name.
- provider (string) -- [REQUIRED]
  The repository provider.
pipelineServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the Proton pipeline service role.

Warning

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.

Return type

dict

Returns

Response Syntax

{
    'accountSettings': {
        'pipelineProvisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'pipelineServiceRoleArn': 'string'
    }
}

Response Structure

(dict) --
- accountSettings (dict) --
  
  The Proton pipeline service role repository detail data that's returned by Proton.
  - pipelineProvisioningRepository (dict) --
    
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      
      The repository branch.
    - name (string) --
      
      The repository name.
    - provider (string) --
      
      The repository provider.
  - pipelineServiceRoleArn (string) --
    
    The Amazon Resource Name (ARN) of the Proton pipeline service role.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.InternalServerException

update_environment(**kwargs)¶

Update an environment.

If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn and provisioningRepository parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.

If the environment was provisioned with pull request provisioning, include the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.

If the environment wasn't provisioned with pull request provisioning, omit the provisioningRepository parameter.

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).

See also: AWS API Documentation

Request Syntax

response = client.update_environment(
    deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
    description='string',
    environmentAccountConnectionId='string',
    name='string',
    protonServiceRoleArn='string',
    provisioningRepository={
        'branch': 'string',
        'name': 'string',
        'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
    },
    spec='string',
    templateMajorVersion='string',
    templateMinorVersion='string'
)

Parameters

deploymentType (string) --
[REQUIRED]

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
description (string) -- A description of the environment update.
environmentAccountConnectionId (string) --
The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
name (string) --
[REQUIRED]

The name of the environment to update.
protonServiceRoleArn (string) -- The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
provisioningRepository (dict) --
The repository that you provide with pull request provisioning.

Warning

Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
- branch (string) -- [REQUIRED]
  The repository branch.
- name (string) -- [REQUIRED]
  The repository name.
- provider (string) -- [REQUIRED]
  The repository provider.
spec (string) -- The formatted specification that defines the update.
templateMajorVersion (string) -- The major version of the environment to update.
templateMinorVersion (string) -- The minor version of the environment to update.

Return type

dict

Returns

Response Syntax

{
    'environment': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'description': 'string',
        'environmentAccountConnectionId': 'string',
        'environmentAccountId': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'protonServiceRoleArn': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'provisioningRepository': {
            'arn': 'string',
            'branch': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environment (dict) --
  
  The environment detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment.
  - createdAt (datetime) --
    
    The time when the environment was created.
  - deploymentStatus (string) --
    
    The environment deployment status.
  - deploymentStatusMessage (string) --
    
    An environment deployment status message.
  - description (string) --
    
    The description of the environment.
  - environmentAccountConnectionId (string) --
    
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - environmentAccountId (string) --
    
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - lastDeploymentAttemptedAt (datetime) --
    
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    
    The time when the environment was last deployed successfully.
  - name (string) --
    
    The name of the environment.
  - protonServiceRoleArn (string) --
    
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning (string) --
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - provisioningRepository (dict) --
    
    The repository that you provide with pull request provisioning.
    
    Warning
    
    Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the repository branch.
    - branch (string) --
      
      The repository branch.
    - name (string) --
      
      The repository name.
    - provider (string) --
      
      The repository provider.
  - spec (string) --
    
    The environment spec.
  - templateMajorVersion (string) --
    
    The ID of the major version of the environment template.
  - templateMinorVersion (string) --
    
    The ID of the minor version of the environment template.
  - templateName (string) --
    
    The Amazon Resource Name (ARN) of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_environment_account_connection(**kwargs)¶

In an environment account, update an environment account connection to use a new IAM role.

For more information, see Environment account connections in the Proton Administrator guide .

See also: AWS API Documentation

Request Syntax

response = client.update_environment_account_connection(
    id='string',
    roleArn='string'
)

Parameters

id (string) --
[REQUIRED]

The ID of the environment account connection to update.
roleArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnection': {
        'arn': 'string',
        'environmentAccountId': 'string',
        'environmentName': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'managementAccountId': 'string',
        'requestedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'status': 'PENDING'|'CONNECTED'|'REJECTED'
    }
}

Response Structure

(dict) --
- environmentAccountConnection (dict) --
  
  The environment account connection detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment account connection.
  - environmentAccountId (string) --
    
    The environment account that's connected to the environment account connection.
  - environmentName (string) --
    
    The name of the environment that's associated with the environment account connection.
  - id (string) --
    
    The ID of the environment account connection.
  - lastModifiedAt (datetime) --
    
    The time when the environment account connection was last modified.
  - managementAccountId (string) --
    
    The ID of the management account that's connected to the environment account connection.
  - requestedAt (datetime) --
    
    The time when the environment account connection request was made.
  - roleArn (string) --
    
    The IAM service role that's associated with the environment account connection.
  - status (string) --
    
    The status of the environment account connection.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_environment_template(**kwargs)¶

Update an environment template.

See also: AWS API Documentation

Request Syntax

response = client.update_environment_template(
    description='string',
    displayName='string',
    name='string'
)

Parameters

description (string) -- A description of the environment template update.
displayName (string) -- The name of the environment template to update as displayed in the developer interface.
name (string) --
[REQUIRED]

The name of the environment template to update.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'provisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplate (dict) --
  
  The environment template detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the environment template.
  - createdAt (datetime) --
    
    The time when the environment template was created.
  - description (string) --
    
    A description of the environment template.
  - displayName (string) --
    
    The name of the environment template as displayed in the developer interface.
  - encryptionKey (string) --
    
    The customer provided encryption key for the environment template.
  - lastModifiedAt (datetime) --
    
    The time when the environment template was last modified.
  - name (string) --
    
    The name of the environment template.
  - provisioning (string) --
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
  - recommendedVersion (string) --
    
    The ID of the recommended version of the environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_environment_template_version(**kwargs)¶

Update a major or minor version of an environment template.

See also: AWS API Documentation

Request Syntax

response = client.update_environment_template_version(
    description='string',
    majorVersion='string',
    minorVersion='string',
    status='REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
    templateName='string'
)

Parameters

description (string) -- A description of environment template version to update.
majorVersion (string) --
[REQUIRED]

To update a major version of an environment template, include major Version .
minorVersion (string) --
[REQUIRED]

To update a minor version of an environment template, include minorVersion .
status (string) -- The status of the environment template minor version to update.
templateName (string) --
[REQUIRED]

The name of the environment template.

Return type

dict

Returns

Response Syntax

{
    'environmentTemplateVersion': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- environmentTemplateVersion (dict) --
  
  The environment template version detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of an environment template.
  - createdAt (datetime) --
    
    The time when the version of an environment template was created.
  - description (string) --
    
    A description of the minor version of an environment template.
  - lastModifiedAt (datetime) --
    
    The time when the version of an environment template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of an environment template.
  - minorVersion (string) --
    
    The minor version of an environment template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the environment template.
  - schema (string) --
    
    The schema of the version of an environment template.
  - status (string) --
    
    The status of the version of an environment template.
  - statusMessage (string) --
    
    The status message of the version of an environment template.
  - templateName (string) --
    
    The name of the version of an environment template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_service(**kwargs)¶

Edit a service description or use a spec to add and delete service instances.

Note

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

See also: AWS API Documentation

Request Syntax

response = client.update_service(
    description='string',
    name='string',
    spec='string'
)

Parameters

description (string) -- The edited service description.
name (string) --
[REQUIRED]

The name of the service to edit.
spec (string) -- Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton Administrator Guide or the Proton User Guide .

Return type

dict

Returns

Response Syntax

{
    'service': {
        'arn': 'string',
        'branchName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipeline': {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'spec': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
        'repositoryConnectionArn': 'string',
        'repositoryId': 'string',
        'spec': 'string',
        'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- service (dict) --
  
  The service detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service.
  - branchName (string) --
    
    The name of the code repository branch that holds the code that's deployed in Proton.
  - createdAt (datetime) --
    
    The time when the service was created.
  - description (string) --
    
    A description of a service.
  - lastModifiedAt (datetime) --
    
    The time when the service was last modified.
  - name (string) --
    
    The name of the service.
  - pipeline (dict) --
    
    The service pipeline detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the service pipeline.
    - createdAt (datetime) --
      
      The time when the service pipeline was created.
    - deploymentStatus (string) --
      
      The deployment status of the service pipeline.
    - deploymentStatusMessage (string) --
      
      A service pipeline deployment status message.
    - lastDeploymentAttemptedAt (datetime) --
      
      The time when a deployment of the service pipeline was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      
      The time when the service pipeline was last deployed successfully.
    - spec (string) --
      
      The service spec that was used to create the service pipeline.
    - templateMajorVersion (string) --
      
      The major version of the service template that was used to create the service pipeline.
    - templateMinorVersion (string) --
      
      The minor version of the service template that was used to create the service pipeline.
    - templateName (string) --
      
      The name of the service template that was used to create the service pipeline.
  - repositoryConnectionArn (string) --
    
    The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide .
  - repositoryId (string) --
    
    The ID of the source code repository.
  - spec (string) --
    
    The formatted specification that defines the service.
  - status (string) --
    
    The status of the service.
  - statusMessage (string) --
    
    A service status message.
  - templateName (string) --
    
    The name of the service template.

Exceptions

Proton.Client.exceptions.ServiceQuotaExceededException
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_service_instance(**kwargs)¶

Update a service instance.

There are four modes for updating a service instance as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

See also: AWS API Documentation

Request Syntax

response = client.update_service_instance(
    deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
    name='string',
    serviceName='string',
    spec='string',
    templateMajorVersion='string',
    templateMinorVersion='string'
)

Parameters

deploymentType (string) --
[REQUIRED]

The deployment type.

There are four modes for updating a service instance as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
name (string) --
[REQUIRED]

The name of the service instance to update.
serviceName (string) --
[REQUIRED]

The name of the service that the service instance belongs to.
spec (string) -- The formatted specification that defines the service instance update.
templateMajorVersion (string) -- The major version of the service template to update.
templateMinorVersion (string) -- The minor version of the service template to update.

Return type

dict

Returns

Response Syntax

{
    'serviceInstance': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'environmentName': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'name': 'string',
        'serviceName': 'string',
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceInstance (dict) --
  
  The service instance summary data returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service instance.
  - createdAt (datetime) --
    
    The time when the service instance was created.
  - deploymentStatus (string) --
    
    The service instance deployment status.
  - deploymentStatusMessage (string) --
    
    A service instance deployment status message.
  - environmentName (string) --
    
    The name of the environment that the service instance was deployed into.
  - lastDeploymentAttemptedAt (datetime) --
    
    The time when a deployment of the service instance was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    
    The time when the service instance was last deployed successfully.
  - name (string) --
    
    The name of the service instance.
  - serviceName (string) --
    
    The name of the service that the service instance belongs to.
  - spec (string) --
    
    The service spec that was used to create the service instance.
  - templateMajorVersion (string) --
    
    The major version of the service template that was used to create the service instance.
  - templateMinorVersion (string) --
    
    The minor version of the service template that was used to create the service instance.
  - templateName (string) --
    
    The name of the service template that was used to create the service instance.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_service_pipeline(**kwargs)¶

Update the service pipeline.

There are four modes for updating a service pipeline as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

See also: AWS API Documentation

Request Syntax

response = client.update_service_pipeline(
    deploymentType='NONE'|'CURRENT_VERSION'|'MINOR_VERSION'|'MAJOR_VERSION',
    serviceName='string',
    spec='string',
    templateMajorVersion='string',
    templateMinorVersion='string'
)

Parameters

deploymentType (string) --
[REQUIRED]

The deployment type.

There are four modes for updating a service pipeline as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
serviceName (string) --
[REQUIRED]

The name of the service to that the pipeline is associated with.
spec (string) --
[REQUIRED]

The spec for the service pipeline to update.
templateMajorVersion (string) -- The major version of the service template that was used to create the service that the pipeline is associated with.
templateMinorVersion (string) -- The minor version of the service template that was used to create the service that the pipeline is associated with.

Return type

dict

Returns

Response Syntax

{
    'pipeline': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
        'deploymentStatusMessage': 'string',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        'spec': 'string',
        'templateMajorVersion': 'string',
        'templateMinorVersion': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- pipeline (dict) --
  
  The pipeline details returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service pipeline.
  - createdAt (datetime) --
    
    The time when the service pipeline was created.
  - deploymentStatus (string) --
    
    The deployment status of the service pipeline.
  - deploymentStatusMessage (string) --
    
    A service pipeline deployment status message.
  - lastDeploymentAttemptedAt (datetime) --
    
    The time when a deployment of the service pipeline was last attempted.
  - lastDeploymentSucceededAt (datetime) --
    
    The time when the service pipeline was last deployed successfully.
  - spec (string) --
    
    The service spec that was used to create the service pipeline.
  - templateMajorVersion (string) --
    
    The major version of the service template that was used to create the service pipeline.
  - templateMinorVersion (string) --
    
    The minor version of the service template that was used to create the service pipeline.
  - templateName (string) --
    
    The name of the service template that was used to create the service pipeline.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_service_template(**kwargs)¶

Update a service template.

See also: AWS API Documentation

Request Syntax

response = client.update_service_template(
    description='string',
    displayName='string',
    name='string'
)

Parameters

description (string) -- A description of the service template update.
displayName (string) -- The name of the service template to update as displayed in the developer interface.
name (string) --
[REQUIRED]

The name of the service template to update.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipelineProvisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplate (dict) --
  
  The service template detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the service template.
  - createdAt (datetime) --
    
    The time when the service template was created.
  - description (string) --
    
    A description of the service template.
  - displayName (string) --
    
    The service template name as displayed in the developer interface.
  - encryptionKey (string) --
    
    The customer provided service template encryption key that's used to encrypt data.
  - lastModifiedAt (datetime) --
    
    The time when the service template was last modified.
  - name (string) --
    
    The name of the service template.
  - pipelineProvisioning (string) --
    
    If pipelineProvisioning is true , a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
  - recommendedVersion (string) --
    
    The recommended version of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_service_template_version(**kwargs)¶

Update a major or minor version of a service template.

See also: AWS API Documentation

Request Syntax

response = client.update_service_template_version(
    compatibleEnvironmentTemplates=[
        {
            'majorVersion': 'string',
            'templateName': 'string'
        },
    ],
    description='string',
    majorVersion='string',
    minorVersion='string',
    status='REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
    templateName='string'
)

Parameters

compatibleEnvironmentTemplates (list) --
An array of compatible environment names for a service template major or minor version to update.
- (dict) --
  Compatible environment template data.
  - majorVersion (string) -- [REQUIRED]
    The major version of the compatible environment template.
  - templateName (string) -- [REQUIRED]
    The compatible environment template name.
description (string) -- A description of a service template version to update.
majorVersion (string) --
[REQUIRED]

To update a major version of a service template, include major Version .
minorVersion (string) --
[REQUIRED]

To update a minor version of a service template, include minorVersion .
status (string) -- The status of the service template minor version to update.
templateName (string) --
[REQUIRED]

The name of the service template.

Return type

dict

Returns

Response Syntax

{
    'serviceTemplateVersion': {
        'arn': 'string',
        'compatibleEnvironmentTemplates': [
            {
                'majorVersion': 'string',
                'templateName': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'majorVersion': 'string',
        'minorVersion': 'string',
        'recommendedMinorVersion': 'string',
        'schema': 'string',
        'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
        'statusMessage': 'string',
        'templateName': 'string'
    }
}

Response Structure

(dict) --
- serviceTemplateVersion (dict) --
  
  The service template version detail data that's returned by Proton.
  - arn (string) --
    
    The Amazon Resource Name (ARN) of the version of a service template.
  - compatibleEnvironmentTemplates (list) --
    
    An array of compatible environment template names for the major version of a service template.
    - (dict) --
      
      Compatible environment template data.
      - majorVersion (string) --
        
        The major version of the compatible environment template.
      - templateName (string) --
        
        The compatible environment template name.
  - createdAt (datetime) --
    
    The time when the version of a service template was created.
  - description (string) --
    
    A description of the version of a service template.
  - lastModifiedAt (datetime) --
    
    The time when the version of a service template was last modified.
  - majorVersion (string) --
    
    The latest major version that's associated with the version of a service template.
  - minorVersion (string) --
    
    The minor version of a service template.
  - recommendedMinorVersion (string) --
    
    The recommended minor version of the service template.
  - schema (string) --
    
    The schema of the version of a service template.
  - status (string) --
    
    The service template version status.
  - statusMessage (string) --
    
    A service template version status message.
  - templateName (string) --
    
    The name of the version of a service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

update_template_sync_config(**kwargs)¶

Update template sync configuration parameters, except for the templateName and templateType .

See also: AWS API Documentation

Request Syntax

response = client.update_template_sync_config(
    branch='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    subdirectory='string',
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)

Parameters

branch (string) --
[REQUIRED]

The repository branch.
repositoryName (string) --
[REQUIRED]

The name of the repository, for example myrepos/myrepo .
repositoryProvider (string) --
[REQUIRED]

The repository provider.
subdirectory (string) -- A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
templateName (string) --
[REQUIRED]

The synced template name.
templateType (string) --
[REQUIRED]

The synced template type.

Return type

dict

Returns

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

(dict) --
- templateSyncConfig (dict) --
  
  The template sync configuration detail data that's returned by Proton.
  - branch (string) --
    
    The repository branch.
  - repositoryName (string) --
    
    The name of the repository, for example myrepos/myrepo .
  - repositoryProvider (string) --
    
    The repository provider.
  - subdirectory (string) --
    
    A subdirectory path to your template bundle version.
  - templateName (string) --
    
    The template name.
  - templateType (string) --
    
    The template type.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException

Paginators ¶

The available paginators are:

Proton.Paginator.ListEnvironmentAccountConnections
Proton.Paginator.ListEnvironmentOutputs
Proton.Paginator.ListEnvironmentProvisionedResources
Proton.Paginator.ListEnvironmentTemplateVersions
Proton.Paginator.ListEnvironmentTemplates
Proton.Paginator.ListEnvironments
Proton.Paginator.ListRepositories
Proton.Paginator.ListRepositorySyncDefinitions
Proton.Paginator.ListServiceInstanceOutputs
Proton.Paginator.ListServiceInstanceProvisionedResources
Proton.Paginator.ListServiceInstances
Proton.Paginator.ListServicePipelineOutputs
Proton.Paginator.ListServicePipelineProvisionedResources
Proton.Paginator.ListServiceTemplateVersions
Proton.Paginator.ListServiceTemplates
Proton.Paginator.ListServices
Proton.Paginator.ListTagsForResource

class Proton.Paginator.ListEnvironmentAccountConnections¶

paginator = client.get_paginator('list_environment_account_connections')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_environment_account_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    environmentName='string',
    requestedBy='MANAGEMENT_ACCOUNT'|'ENVIRONMENT_ACCOUNT',
    statuses=[
        'PENDING'|'CONNECTED'|'REJECTED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

environmentName (string) -- The environment name that's associated with each listed environment account connection.
requestedBy (string) --
[REQUIRED]

The type of account making the ListEnvironmentAccountConnections request.
statuses (list) --
The status details for each listed environment account connection.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'environmentAccountConnections': [
        {
            'arn': 'string',
            'environmentAccountId': 'string',
            'environmentName': 'string',
            'id': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'managementAccountId': 'string',
            'requestedAt': datetime(2015, 1, 1),
            'roleArn': 'string',
            'status': 'PENDING'|'CONNECTED'|'REJECTED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- environmentAccountConnections (list) --
  
  An array of environment account connections with details that's returned by Proton.
  - (dict) --
    
    A summary of the environment account connection detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the environment account connection.
    - environmentAccountId (string) --
      
      The ID of the environment account that's connected to the environment account connection.
    - environmentName (string) --
      
      The name of the environment that's associated with the environment account connection.
    - id (string) --
      
      The ID of the environment account connection.
    - lastModifiedAt (datetime) --
      
      The time when the environment account connection was last modified.
    - managementAccountId (string) --
      
      The ID of the management account that's connected to the environment account connection.
    - requestedAt (datetime) --
      
      The time when the environment account connection request was made.
    - roleArn (string) --
      
      The IAM service role that's associated with the environment account connection.
    - status (string) --
      
      The status of the environment account connection.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListEnvironmentOutputs¶

paginator = client.get_paginator('list_environment_outputs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_environment_outputs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    environmentName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

environmentName (string) --
[REQUIRED]

The environment name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- outputs (list) --
  
  An array of environment outputs with detail data.
  - (dict) --
    
    An infrastructure as code defined resource output.
    - key (string) --
      
      The output key.
    - valueString (string) --
      
      The output value.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListEnvironmentProvisionedResources¶

paginator = client.get_paginator('list_environment_provisioned_resources')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_environment_provisioned_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    environmentName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

environmentName (string) --
[REQUIRED]

The environment name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- provisionedResources (list) --
  
  An array of environment provisioned resources.
  - (dict) --
    
    Detail data for a provisioned resource.
    - identifier (string) --
      
      The provisioned resource identifier.
    - name (string) --
      
      The provisioned resource name.
    - provisioningEngine (string) --
      
      The resource provisioning engine.
      
      Warning
      
      Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListEnvironmentTemplateVersions¶

paginator = client.get_paginator('list_environment_template_versions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_environment_template_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    majorVersion='string',
    templateName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

majorVersion (string) --
To view a list of minor of versions under a major version of an environment template, include major Version .

To view a list of major versions of an environment template, exclude major Version .
templateName (string) --
[REQUIRED]

The name of the environment template.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'templateVersions': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'majorVersion': 'string',
            'minorVersion': 'string',
            'recommendedMinorVersion': 'string',
            'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- templateVersions (list) --
  
  An array of major or minor versions of an environment template detail data.
  - (dict) --
    
    A summary of the version of an environment template detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the version of an environment template.
    - createdAt (datetime) --
      
      The time when the version of an environment template was created.
    - description (string) --
      
      A description of the version of an environment template.
    - lastModifiedAt (datetime) --
      
      The time when the version of an environment template was last modified.
    - majorVersion (string) --
      
      The latest major version that's associated with the version of an environment template.
    - minorVersion (string) --
      
      The version of an environment template.
    - recommendedMinorVersion (string) --
      
      The recommended minor version of the environment template.
    - status (string) --
      
      The status of the version of an environment template.
    - statusMessage (string) --
      
      The status message of the version of an environment template.
    - templateName (string) --
      
      The name of the version of an environment template.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListEnvironmentTemplates¶

paginator = client.get_paginator('list_environment_templates')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_environment_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) --
The size of each page.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'templates': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'displayName': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'provisioning': 'CUSTOMER_MANAGED',
            'recommendedVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- templates (list) --
  An array of environment templates with detail data.
  - (dict) --
    The environment template data.
    - arn (string) --
      The Amazon Resource Name (ARN) of the environment template.
    - createdAt (datetime) --
      The time when the environment template was created.
    - description (string) --
      A description of the environment template.
    - displayName (string) --
      The name of the environment template as displayed in the developer interface.
    - lastModifiedAt (datetime) --
      The time when the environment template was last modified.
    - name (string) --
      The name of the environment template.
    - provisioning (string) --
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    - recommendedVersion (string) --
      The recommended version of the environment template.
- NextToken (string) --
  A token to resume pagination.

class Proton.Paginator.ListEnvironments¶

paginator = client.get_paginator('list_environments')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    environmentTemplates=[
        {
            'majorVersion': 'string',
            'templateName': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

environmentTemplates (list) --
An array of the versions of the environment template.
- (dict) --
  A search filter for environment templates.
  - majorVersion (string) -- [REQUIRED]
    Include majorVersion to filter search for a major version.
  - templateName (string) -- [REQUIRED]
    Include templateName to filter search for a template name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'environments': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'description': 'string',
            'environmentAccountConnectionId': 'string',
            'environmentAccountId': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'name': 'string',
            'protonServiceRoleArn': 'string',
            'provisioning': 'CUSTOMER_MANAGED',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- environments (list) --
  
  An array of environment detail data summaries.
  - (dict) --
    
    A summary of the environment detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the environment.
    - createdAt (datetime) --
      
      The time when the environment was created.
    - deploymentStatus (string) --
      
      The environment deployment status.
    - deploymentStatusMessage (string) --
      
      An environment deployment status message.
    - description (string) --
      
      The description of the environment.
    - environmentAccountConnectionId (string) --
      
      The ID of the environment account connection that the environment is associated with.
    - environmentAccountId (string) --
      
      The ID of the environment account that the environment infrastructure resources are provisioned in.
    - lastDeploymentAttemptedAt (datetime) --
      
      The time when a deployment of the environment was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      
      The time when the environment was last deployed successfully.
    - name (string) --
      
      The name of the environment.
    - protonServiceRoleArn (string) --
      
      The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
    - provisioning (string) --
      
      When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    - templateMajorVersion (string) --
      
      The major version of the environment template.
    - templateMinorVersion (string) --
      
      The minor version of the environment template.
    - templateName (string) --
      
      The name of the environment template.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListRepositories¶

paginator = client.get_paginator('list_repositories')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_repositories().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) --
The size of each page.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'repositories': [
        {
            'arn': 'string',
            'name': 'string',
            'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- repositories (list) --
  An array of repositories.
  - (dict) --
    A summary of detail data for a registered repository.
    - arn (string) --
      The Amazon Resource Name (ARN) for a repository.
    - name (string) --
      The repository name.
    - provider (string) --
      The repository provider.
- NextToken (string) --
  A token to resume pagination.

class Proton.Paginator.ListRepositorySyncDefinitions¶

paginator = client.get_paginator('list_repository_sync_definitions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_repository_sync_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    syncType='TEMPLATE_SYNC',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

repositoryName (string) --
[REQUIRED]

The repository name.
repositoryProvider (string) --
[REQUIRED]

The repository provider.
syncType (string) --
[REQUIRED]

The sync type. The only supported value is TEMPLATE_SYNC .
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'syncDefinitions': [
        {
            'branch': 'string',
            'directory': 'string',
            'parent': 'string',
            'target': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- syncDefinitions (list) --
  
  An array of repository sync definitions.
  - (dict) --
    
    The repository sync definition.
    - branch (string) --
      
      The repository branch.
    - directory (string) --
      
      The directory in the repository.
    - parent (string) --
      
      The resource that is synced from.
    - target (string) --
      
      The resource that is synced to.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServiceInstanceOutputs¶

paginator = client.get_paginator('list_service_instance_outputs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_instance_outputs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceInstanceName='string',
    serviceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

serviceInstanceName (string) --
[REQUIRED]

The service instance name.
serviceName (string) --
[REQUIRED]

The service name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- outputs (list) --
  
  An array of service instance infrastructure as code outputs.
  - (dict) --
    
    An infrastructure as code defined resource output.
    - key (string) --
      
      The output key.
    - valueString (string) --
      
      The output value.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServiceInstanceProvisionedResources¶

paginator = client.get_paginator('list_service_instance_provisioned_resources')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_instance_provisioned_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceInstanceName='string',
    serviceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

serviceInstanceName (string) --
[REQUIRED]

The service instance name.
serviceName (string) --
[REQUIRED]

The service name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- provisionedResources (list) --
  
  An array of provisioned resources for a service instance.
  - (dict) --
    
    Detail data for a provisioned resource.
    - identifier (string) --
      
      The provisioned resource identifier.
    - name (string) --
      
      The provisioned resource name.
    - provisioningEngine (string) --
      
      The resource provisioning engine.
      
      Warning
      
      Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServiceInstances¶

paginator = client.get_paginator('list_service_instances')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_instances().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

serviceName (string) -- The name of the service that the service instance belongs to.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'serviceInstances': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'environmentName': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'name': 'string',
            'serviceName': 'string',
            'templateMajorVersion': 'string',
            'templateMinorVersion': 'string',
            'templateName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- serviceInstances (list) --
  
  An array of service instances with summaries of detail data.
  - (dict) --
    
    A summary of the service instance detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the service instance.
    - createdAt (datetime) --
      
      The time when the service instance was created.
    - deploymentStatus (string) --
      
      The service instance deployment status.
    - deploymentStatusMessage (string) --
      
      A service instance deployment status message.
    - environmentName (string) --
      
      The name of the environment that the service instance was deployed into.
    - lastDeploymentAttemptedAt (datetime) --
      
      The time when a deployment of the service was last attempted.
    - lastDeploymentSucceededAt (datetime) --
      
      The time when the service was last deployed successfully.
    - name (string) --
      
      The name of the service instance.
    - serviceName (string) --
      
      The name of the service that the service instance belongs to.
    - templateMajorVersion (string) --
      
      The service instance template major version.
    - templateMinorVersion (string) --
      
      The service instance template minor version.
    - templateName (string) --
      
      The name of the service template.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServicePipelineOutputs¶

paginator = client.get_paginator('list_service_pipeline_outputs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_pipeline_outputs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

serviceName (string) --
[REQUIRED]

The service name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- outputs (list) --
  
  An array of outputs.
  - (dict) --
    
    An infrastructure as code defined resource output.
    - key (string) --
      
      The output key.
    - valueString (string) --
      
      The output value.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServicePipelineProvisionedResources¶

paginator = client.get_paginator('list_service_pipeline_provisioned_resources')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_pipeline_provisioned_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

serviceName (string) --
[REQUIRED]

The service name.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- provisionedResources (list) --
  
  An array of provisioned resources for a service and pipeline.
  - (dict) --
    
    Detail data for a provisioned resource.
    - identifier (string) --
      
      The provisioned resource identifier.
    - name (string) --
      
      The provisioned resource name.
    - provisioningEngine (string) --
      
      The resource provisioning engine.
      
      Warning
      
      Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms , see section 2 on Beta and Previews.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServiceTemplateVersions¶

paginator = client.get_paginator('list_service_template_versions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_template_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    majorVersion='string',
    templateName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

majorVersion (string) --
To view a list of minor of versions under a major version of a service template, include major Version .

To view a list of major versions of a service template, exclude major Version .
templateName (string) --
[REQUIRED]

The name of the service template.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'templateVersions': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'majorVersion': 'string',
            'minorVersion': 'string',
            'recommendedMinorVersion': 'string',
            'status': 'REGISTRATION_IN_PROGRESS'|'REGISTRATION_FAILED'|'DRAFT'|'PUBLISHED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- templateVersions (list) --
  
  An array of major or minor versions of a service template with detail data.
  - (dict) --
    
    A summary of the service template version detail data.
    - arn (string) --
      
      The Amazon Resource Name (ARN) of the version of a service template.
    - createdAt (datetime) --
      
      The time when the version of a service template was created.
    - description (string) --
      
      A description of the version of a service template.
    - lastModifiedAt (datetime) --
      
      The time when the version of a service template was last modified.
    - majorVersion (string) --
      
      The latest major version that's associated with the version of a service template.
    - minorVersion (string) --
      
      The minor version of a service template.
    - recommendedMinorVersion (string) --
      
      The recommended minor version of the service template.
    - status (string) --
      
      The service template minor version status.
    - statusMessage (string) --
      
      A service template minor version status message.
    - templateName (string) --
      
      The name of the service template.
- NextToken (string) --
  
  A token to resume pagination.

class Proton.Paginator.ListServiceTemplates¶

paginator = client.get_paginator('list_service_templates')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_service_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) --
The size of each page.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'templates': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'displayName': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'pipelineProvisioning': 'CUSTOMER_MANAGED',
            'recommendedVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- templates (list) --
  An array of service templates with detail data.
  - (dict) --
    The service template summary data.
    - arn (string) --
      The Amazon Resource Name (ARN) of the service template.
    - createdAt (datetime) --
      The time when the service template was created.
    - description (string) --
      A description of the service template.
    - displayName (string) --
      The service template name as displayed in the developer interface.
    - lastModifiedAt (datetime) --
      The time when the service template was last modified.
    - name (string) --
      The name of the service template.
    - pipelineProvisioning (string) --
      If pipelineProvisioning is true , a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.
    - recommendedVersion (string) --
      The recommended version of the service template.
- NextToken (string) --
  A token to resume pagination.

class Proton.Paginator.ListServices¶

paginator = client.get_paginator('list_services')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_services().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) --
The size of each page.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'services': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_IN_PROGRESS'|'CREATE_FAILED_CLEANUP_COMPLETE'|'CREATE_FAILED_CLEANUP_FAILED'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_IN_PROGRESS'|'UPDATE_FAILED_CLEANUP_COMPLETE'|'UPDATE_FAILED_CLEANUP_FAILED'|'UPDATE_FAILED'|'UPDATE_COMPLETE_CLEANUP_FAILED',
            'statusMessage': 'string',
            'templateName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- services (list) --
  An array of services with summaries of detail data.
  - (dict) --
    A summary of the service detail data.
    - arn (string) --
      The Amazon Resource Name (ARN) of the service.
    - createdAt (datetime) --
      The time when the service was created.
    - description (string) --
      A description of the service.
    - lastModifiedAt (datetime) --
      The time when the service was last modified.
    - name (string) --
      The name of the service.
    - status (string) --
      The status of the service.
    - statusMessage (string) --
      A service status message.
    - templateName (string) --
      The name of the service template.
- NextToken (string) --
  A token to resume pagination.

class Proton.Paginator.ListTagsForResource¶

paginator = client.get_paginator('list_tags_for_resource')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Proton.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    resourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

resourceArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the resource for the listed tags.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- tags (list) --
  
  An array of resource tags with detail data.
  - (dict) --
    
    A description of a resource tag.
    - key (string) --
      
      The key of the resource tag.
    - value (string) --
      
      The value of the resource tag.
- NextToken (string) --
  
  A token to resume pagination.

Waiters ¶

The available waiters are:

Proton.Waiter.EnvironmentDeployed
Proton.Waiter.EnvironmentTemplateVersionRegistered
Proton.Waiter.ServiceCreated
Proton.Waiter.ServiceDeleted
Proton.Waiter.ServiceInstanceDeployed
Proton.Waiter.ServicePipelineDeployed
Proton.Waiter.ServiceTemplateVersionRegistered
Proton.Waiter.ServiceUpdated

class Proton.Waiter.EnvironmentDeployed¶

waiter = client.get_waiter('environment_deployed')

wait(**kwargs)¶

Polls Proton.Client.get_environment() every 5 seconds until a successful state is reached. An error is returned after 999 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

name (string) --
[REQUIRED]

The name of the environment that you want to get the detail data for.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 5
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 999

Returns

None

class Proton.Waiter.EnvironmentTemplateVersionRegistered¶

waiter = client.get_waiter('environment_template_version_registered')

wait(**kwargs)¶

Polls Proton.Client.get_environment_template_version() every 2 seconds until a successful state is reached. An error is returned after 150 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    majorVersion='string',
    minorVersion='string',
    templateName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

majorVersion (string) --
[REQUIRED]

To view environment template major version detail data, include major Version .
minorVersion (string) --
[REQUIRED]

To view environment template minor version detail data, include minorVersion .
templateName (string) --
[REQUIRED]

The name of the environment template.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 2
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 150

Returns

None

class Proton.Waiter.ServiceCreated¶

waiter = client.get_waiter('service_created')

wait(**kwargs)¶

Polls Proton.Client.get_service() every 5 seconds until a successful state is reached. An error is returned after 999 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

name (string) --
[REQUIRED]

The name of the service that you want to get the detail data for.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 5
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 999

Returns

None

class Proton.Waiter.ServiceDeleted¶

waiter = client.get_waiter('service_deleted')

wait(**kwargs)¶

Polls Proton.Client.get_service() every 5 seconds until a successful state is reached. An error is returned after 999 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

name (string) --
[REQUIRED]

The name of the service that you want to get the detail data for.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 5
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 999

Returns

None

class Proton.Waiter.ServiceInstanceDeployed¶

waiter = client.get_waiter('service_instance_deployed')

wait(**kwargs)¶

Polls Proton.Client.get_service_instance() every 5 seconds until a successful state is reached. An error is returned after 999 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    serviceName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

name (string) --
[REQUIRED]

The name of a service instance that you want to get the detail data for.
serviceName (string) --
[REQUIRED]

The name of the service that the service instance belongs to.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 5
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 999

Returns

None

class Proton.Waiter.ServicePipelineDeployed¶

waiter = client.get_waiter('service_pipeline_deployed')

wait(**kwargs)¶

Polls Proton.Client.get_service() every 10 seconds until a successful state is reached. An error is returned after 360 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

name (string) --
[REQUIRED]

The name of the service that you want to get the detail data for.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 10
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 360

Returns

None

class Proton.Waiter.ServiceTemplateVersionRegistered¶

waiter = client.get_waiter('service_template_version_registered')

wait(**kwargs)¶

Polls Proton.Client.get_service_template_version() every 2 seconds until a successful state is reached. An error is returned after 150 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    majorVersion='string',
    minorVersion='string',
    templateName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

majorVersion (string) --
[REQUIRED]

To view service template major version detail data, include major Version .
minorVersion (string) --
[REQUIRED]

To view service template minor version detail data, include minorVersion .
templateName (string) --
[REQUIRED]

The name of the service template.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 2
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 150

Returns

None

class Proton.Waiter.ServiceUpdated¶

waiter = client.get_waiter('service_updated')

wait(**kwargs)¶

Polls Proton.Client.get_service() every 5 seconds until a successful state is reached. An error is returned after 999 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    name='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

name (string) --
[REQUIRED]

The name of the service that you want to get the detail data for.
WaiterConfig (dict) --
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) --
  The amount of time in seconds to wait between attempts. Default: 5
- MaxAttempts (integer) --
  The maximum number of attempts to be made. Default: 999

Returns

None

Navigation

Table Of Contents

Proton¶

Client¶

Paginators¶

Waiters¶

Navigation

Proton ¶

Client ¶

Paginators ¶

Waiters ¶