2021/11/24 - AWS Proton - 18 new8 updated api methods
Changes This release adds APIs for getting the outputs and provisioned stacks for Environments, Pipelines, and ServiceInstances. You can now add tags to EnvironmentAccountConnections. It also adds APIs for working with PR-based provisioning. Also, it adds APIs for syncing templates with a git repository.
View a list service pipeline infrastructure as code outputs with detail.
See also: AWS API Documentation
Request Syntax
client.list_service_pipeline_outputs(
nextToken='string',
serviceName='string'
)
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.
string
[REQUIRED]
The service name.
dict
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.
Get the repository sync status.
See also: AWS API Documentation
Request Syntax
client.get_repository_sync_status(
branch='string',
repositoryName='string',
repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
syncType='TEMPLATE_SYNC'
)
string
[REQUIRED]
The repository branch.
string
[REQUIRED]
The repository name.
string
[REQUIRED]
The repository provider.
string
[REQUIRED]
The repository sync type.
dict
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.
Update template sync configuration parameters, except for the templateName and templateType.
See also: AWS API Documentation
Request Syntax
client.update_template_sync_config(
branch='string',
repositoryName='string',
repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
subdirectory='string',
templateName='string',
templateType='ENVIRONMENT'|'SERVICE'
)
string
[REQUIRED]
The repository branch.
string
[REQUIRED]
The name of the repository, for example myrepos/myrepo.
string
[REQUIRED]
The repository provider.
string
A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
string
[REQUIRED]
The synced template name.
string
[REQUIRED]
The synced template type.
dict
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.
Get detail data for a repository.
See also: AWS API Documentation
Request Syntax
client.get_repository(
name='string',
provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)
string
[REQUIRED]
The repository name, for example myrepos/myrepo.
string
[REQUIRED]
The repository provider.
dict
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.
De-register and unlink your repository.
See also: AWS API Documentation
Request Syntax
client.delete_repository(
name='string',
provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)
string
[REQUIRED]
The name of the repository.
string
[REQUIRED]
The repository provider.
dict
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.
List repositories with detail data.
See also: AWS API Documentation
Request Syntax
client.list_repositories(
maxResults=123,
nextToken='string'
)
integer
The maximum number of repositories to list.
string
A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.
dict
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.
View a list service instance infrastructure as code outputs with detail data.
See also: AWS API Documentation
Request Syntax
client.list_service_instance_outputs(
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
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.
string
[REQUIRED]
The service instance name.
string
[REQUIRED]
The service name.
dict
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.
Get the status of a template sync.
See also: AWS API Documentation
Request Syntax
client.get_template_sync_status(
templateName='string',
templateType='ENVIRONMENT'|'SERVICE',
templateVersion='string'
)
string
[REQUIRED]
The template name.
string
[REQUIRED]
The template type.
string
[REQUIRED]
The template version.
dict
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.
List repository sync definitions with detail data.
See also: AWS API Documentation
Request Syntax
client.list_repository_sync_definitions(
nextToken='string',
repositoryName='string',
repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
syncType='TEMPLATE_SYNC'
)
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.
string
[REQUIRED]
The repository name.
string
[REQUIRED]
The repository provider.
string
[REQUIRED]
The sync type. The only supported value is TEMPLATE_SYNC.
dict
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.
List provisioned resources for a service and pipeline with details.
See also: AWS API Documentation
Request Syntax
client.list_service_pipeline_provisioned_resources(
nextToken='string',
serviceName='string'
)
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.
string
[REQUIRED]
The service name.
dict
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.
List the provisioned resources for your environment.
See also: AWS API Documentation
Request Syntax
client.list_environment_provisioned_resources(
environmentName='string',
nextToken='string'
)
string
[REQUIRED]
The environment name.
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.
dict
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.
Delete a template sync configuration.
See also: AWS API Documentation
Request Syntax
client.delete_template_sync_config(
templateName='string',
templateType='ENVIRONMENT'|'SERVICE'
)
string
[REQUIRED]
The template name.
string
[REQUIRED]
The template type.
dict
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.
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
client.create_repository(
connectionArn='string',
encryptionKey='string',
name='string',
provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)
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.
string
The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
string
[REQUIRED]
The repository name, for example myrepos/myrepo.
string
[REQUIRED]
The repository provider.
dict
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.
List provisioned resources for a service instance with details.
See also: AWS API Documentation
Request Syntax
client.list_service_instance_provisioned_resources(
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
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.
string
[REQUIRED]
The service instance name.
string
[REQUIRED]
The service name.
dict
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.
Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.
See also: AWS API Documentation
Request Syntax
client.notify_resource_deployment_status_change(
deploymentId='string',
outputs=[
{
'key': 'string',
'valueString': 'string'
},
],
resourceArn='string',
status='IN_PROGRESS'|'FAILED'|'SUCCEEDED',
statusMessage='string'
)
string
The deployment ID for your provisioned resource.
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.
string
[REQUIRED]
The provisioned resource Amazon Resource Name (ARN).
string
[REQUIRED]
The status of your provisioned resource.
string
The deployment status message for your provisioned resource.
dict
Response Syntax
{}
Response Structure
(dict) --
Get detail data for a template sync configuration.
See also: AWS API Documentation
Request Syntax
client.get_template_sync_config(
templateName='string',
templateType='ENVIRONMENT'|'SERVICE'
)
string
[REQUIRED]
The template name.
string
[REQUIRED]
The template type.
dict
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.
List the infrastructure as code outputs for your environment.
See also: AWS API Documentation
Request Syntax
client.list_environment_outputs(
environmentName='string',
nextToken='string'
)
string
[REQUIRED]
The environment name.
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.
dict
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.
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
client.create_template_sync_config(
branch='string',
repositoryName='string',
repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
subdirectory='string',
templateName='string',
templateType='ENVIRONMENT'|'SERVICE'
)
string
[REQUIRED]
The branch of the registered repository for your template.
string
[REQUIRED]
The name of your repository, for example myrepos/myrepo.
string
[REQUIRED]
The provider type for your repository.
string
A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.
string
[REQUIRED]
The name of your registered template.
string
[REQUIRED]
The type of the registered template.
dict
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.
{'environment': {'provisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE | '
'BITBUCKET'}}}
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
client.cancel_environment_deployment(
environmentName='string'
)
string
[REQUIRED]
The name of the environment with the deployment to cancel.
dict
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.
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.
{'provisioningRepository': {'branch': 'string',
'name': 'string',
'provider': 'GITHUB | GITHUB_ENTERPRISE | '
'BITBUCKET'}}
Response {'environment': {'provisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE | '
'BITBUCKET'}}}
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
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'
)
string
A description of the environment that's being created and deployed.
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.
string
[REQUIRED]
The name of the environment.
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.
dict
The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
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.
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.
string
[REQUIRED]
The major version of the environment template.
string
The minor version of the environment template.
string
[REQUIRED]
The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
dict
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.
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.
{'tags': [{'key': 'string', 'value': 'string'}]}
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
client.create_environment_account_connection(
clientToken='string',
environmentName='string',
managementAccountId='string',
roleArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
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.
string
[REQUIRED]
The name of the Proton environment that's created in the associated management account.
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.
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.
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.
dict
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.
{'environment': {'provisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE | '
'BITBUCKET'}}}
Delete an environment.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
name='string'
)
string
[REQUIRED]
The name of the environment to delete.
dict
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.
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.
{'accountSettings': {'pipelineProvisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE '
'| '
'BITBUCKET'}}}
Get detail data for the Proton pipeline service role.
See also: AWS API Documentation
Request Syntax
client.get_account_settings()
dict
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.
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.
{'environment': {'provisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE | '
'BITBUCKET'}}}
Get detail data for an environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
name='string'
)
string
[REQUIRED]
The name of the environment that you want to get the detail data for.
dict
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.
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.
{'pipelineProvisioningRepository': {'branch': 'string',
'name': 'string',
'provider': 'GITHUB | GITHUB_ENTERPRISE | '
'BITBUCKET'}}
Response {'accountSettings': {'pipelineProvisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE '
'| '
'BITBUCKET'}}}
Update the Proton service pipeline role or repository settings.
See also: AWS API Documentation
Request Syntax
client.update_account_settings(
pipelineProvisioningRepository={
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
pipelineServiceRoleArn='string'
)
dict
The repository that you provide with pull request provisioning.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
string
The Amazon Resource Name (ARN) of the Proton pipeline service role.
dict
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.
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.
{'provisioningRepository': {'branch': 'string',
'name': 'string',
'provider': 'GITHUB | GITHUB_ENTERPRISE | '
'BITBUCKET'}}
Response {'environment': {'provisioningRepository': {'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB | '
'GITHUB_ENTERPRISE | '
'BITBUCKET'}}}
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
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'
)
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).
string
A description of the environment update.
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.
string
[REQUIRED]
The name of the environment to update.
string
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
dict
The repository that you provide with pull request provisioning.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
string
The formatted specification that defines the update.
string
The major version of the environment to update.
string
The minor version of the environment to update.
dict
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.
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.