Table of Contents
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, 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:
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:
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:
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:
import boto3
client = boto3.client('proton')
These are the available methods:
accept_environment_account_connection()can_paginate()cancel_component_deployment()cancel_environment_deployment()cancel_service_instance_deployment()cancel_service_pipeline_deployment()close()create_component()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_component()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_component()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_component_outputs()list_component_provisioned_resources()list_components()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_component()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 User guide .
See also: AWS API Documentation
Request Syntax
response = client.accept_environment_account_connection(
id='string'
)
[REQUIRED]
The ID of the environment account connection.
{
'environmentAccountConnection': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The environment account connection data that's returned by Proton.
The Amazon Resource Name (ARN) of the environment account connection.
The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
The environment account that's connected to the environment account connection.
The name of the environment that's associated with the environment account connection.
The ID of the environment account connection.
The time when the environment account connection was last modified.
The ID of the management account that's connected to the environment account connection.
The time when the environment account connection request was made.
The IAM service role that's associated with the environment account connection.
The status of the environment account connection.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.cancel_component_deployment(**kwargs)¶Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.cancel_component_deployment(
componentName='string'
)
[REQUIRED]
The name of the component with the deployment to cancel.
{
'component': {
'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',
'environmentName': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
The detailed data of the component with the deployment that is being canceled.
The Amazon Resource Name (ARN) of the component.
The time when the component was created.
The component deployment status.
The message associated with the component deployment status.
A description of the component.
The name of the Proton environment that this component is associated with.
The time when a deployment of the component was last attempted.
The time when the component was last deployed successfully.
The time when the component was last modified.
The name of the component.
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncancel_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 User guide .
The following list includes potential cancellation scenarios.
CANCELLED .FAILED .SUCCEEDED and the cancellation attempt has no effect.See also: AWS API Documentation
Request Syntax
response = client.cancel_environment_deployment(
environmentName='string'
)
[REQUIRED]
The name of the environment with the deployment to cancel.
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The environment summary data that's returned by Proton.
The Amazon Resource Name (ARN) of the environment.
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
The time when the environment was created.
The environment deployment status.
An environment deployment status message.
The description of the environment.
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
The ID of the environment account that the environment infrastructure resources are provisioned in.
The time when a deployment of the environment was last attempted.
The time when the environment was last deployed successfully.
The name of the environment.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
The Amazon Resource Name (ARN) of the linked repository.
The repository branch.
The repository name.
The repository provider.
The environment spec.
The major version of the environment template.
The minor version of the environment template.
The Amazon Resource Name (ARN) of the environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncancel_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 User guide .
The following list includes potential cancellation scenarios.
CANCELLED .FAILED .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'
)
[REQUIRED]
The name of the service instance with the deployment to cancel.
[REQUIRED]
The name of the service with the service instance deployment to cancel.
dict
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) --
The message associated with the service instance deployment status.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncancel_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 User guide .
The following list includes potential cancellation scenarios.
CANCELLED .FAILED .SUCCEEDED and the cancellation attempt has no effect.See also: AWS API Documentation
Request Syntax
response = client.cancel_service_pipeline_deployment(
serviceName='string'
)
[REQUIRED]
The name of the service with the service pipeline deployment to cancel.
{
'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
The service pipeline detail data that's returned by Proton.
The Amazon Resource Name (ARN) of the service pipeline.
The time when the service pipeline was created.
The deployment status of the service pipeline.
A service pipeline deployment status message.
The time when a deployment of the service pipeline was last attempted.
The time when the service pipeline was last deployed successfully.
The service spec that was used to create the service pipeline.
The major version of the service template that was used to create the service pipeline.
The minor version of the service template that was used to create the service pipeline.
The name of the service template that was used to create the service pipeline.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionclose()¶Closes underlying endpoint connections.
create_component(**kwargs)¶Create an Proton component. A component is an infrastructure extension for a service instance.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_component(
description='string',
environmentName='string',
manifest='string',
name='string',
serviceInstanceName='string',
serviceName='string',
serviceSpec='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateFile='string'
)
serviceInstanceName and serviceName .[REQUIRED]
A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
[REQUIRED]
The customer-provided name of the component.
serviceInstanceName and serviceName or neither of them.serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
[REQUIRED]
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Note
Components support a single IaC file, even if you use Terraform as your template language.
dict
Response Syntax
{
'component': {
'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',
'environmentName': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the created component.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Exceptions
Proton.Client.exceptions.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncreate_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:
For more information, see Environments and Provisioning methods in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_environment(
codebuildRoleArn='string',
componentRoleArn='string',
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'
)
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
You must specify componentRoleArn to allow directly defined components to be associated with this environment.
For more information about components, see Proton components in the Proton User Guide .
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide .
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
[REQUIRED]
The name of the environment.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
The repository branch.
The repository name.
The repository provider.
[REQUIRED]
A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide .
An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
[REQUIRED]
The major version of the environment template.
[REQUIRED]
The name of the environment template. For more information, see Environment Templates in the Proton User Guide .
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
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 linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
Exceptions
Proton.Client.exceptions.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncreate_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 User guide .
See also: AWS API Documentation
Request Syntax
response = client.create_environment_account_connection(
clientToken='string',
codebuildRoleArn='string',
componentRoleArn='string',
environmentName='string',
managementAccountId='string',
roleArn='string',
tags=[
{
'key': 'string',
'value': '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.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.
For more information about components, see Proton components in the Proton User Guide .
[REQUIRED]
The name of the Proton environment that's created in the associated management account.
[REQUIRED]
The ID of the management account that accepts or rejects the environment account connection. You create and 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.
An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
dict
Response Syntax
{
'environmentAccountConnection': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.InternalServerExceptioncreate_environment_template(**kwargs)¶Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide .
You can create an environment template in one of the two following ways:
provisioning parameter and set the value to CUSTOMER_MANAGED . For more information, see Register and publish an environment template in the Proton User 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'
},
]
)
[REQUIRED]
The name of the environment template.
An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
dict
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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.InternalServerExceptioncreate_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'
)
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.
To create a new minor version of the environment template, include major Version .
To create a new major and minor version of the environment template, exclude major Version .
[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.
An S3 source object that includes the template bundle S3 path and name for a template minor version.
The name of the S3 bucket that contains a template bundle.
The path to the S3 bucket that contains a template bundle.
An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
[REQUIRED]
The name of the environment template.
dict
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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncreate_repository(**kwargs)¶Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.
For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_repository(
connectionArn='string',
encryptionKey='string',
name='string',
provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see Setting up for Proton in the Proton User Guide .
[REQUIRED]
The repository name (for example, myrepos/myrepo ).
[REQUIRED]
The repository provider.
An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
dict
Response Syntax
{
'repository': {
'arn': 'string',
'connectionArn': 'string',
'encryptionKey': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
}
}
Response Structure
(dict) --
repository (dict) --
The repository link's detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
connectionArn (string) --
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.
encryptionKey (string) --
Your customer Amazon Web Services KMS encryption key.
name (string) --
The repository name.
provider (string) --
The repository provider.
Exceptions
Proton.Client.exceptions.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.InternalServerExceptioncreate_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 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'
)
[REQUIRED]
The service name.
[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 User Guide .
An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
[REQUIRED]
The major version of the service template that was used to create the service.
[REQUIRED]
The name of the service template that's used to create the service.
dict
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 the 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 Setting up an AWS CodeStar connection 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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncreate_service_template(**kwargs)¶Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD 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 Proton templates in the Proton User 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'
},
]
)
[REQUIRED]
The name of the service template.
An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
dict
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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.InternalServerExceptioncreate_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'
}
},
supportedComponentSources=[
'DIRECTLY_DEFINED',
],
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateName='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.
[REQUIRED]
An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.
Compatible environment template data.
The major version of the compatible environment template.
The compatible environment template name.
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 .
[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.
An S3 source object that includes the template bundle S3 path and name for a template minor version.
The name of the S3 bucket that contains a template bundle.
The path to the S3 bucket that contains a template bundle.
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide .
An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton User Guide .
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
[REQUIRED]
The name of the service template.
dict
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',
'supportedComponentSources': [
'DIRECTLY_DEFINED',
],
'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.
supportedComponentSources (list) --
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide .
templateName (string) --
The name of the version of a service template.
Exceptions
Proton.Client.exceptions.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptioncreate_template_sync_config(**kwargs)¶Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User 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'
)
[REQUIRED]
The repository branch for your template.
[REQUIRED]
The repository name (for example, myrepos/myrepo ).
[REQUIRED]
The provider type for your repository.
[REQUIRED]
The name of your registered template.
[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 repository name (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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.InternalServerExceptiondelete_component(**kwargs)¶Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_component(
name='string'
)
[REQUIRED]
The name of the component to delete.
{
'component': {
'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',
'environmentName': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
The detailed data of the component being deleted.
The Amazon Resource Name (ARN) of the component.
The time when the component was created.
The component deployment status.
The message associated with the component deployment status.
A description of the component.
The name of the Proton environment that this component is associated with.
The time when a deployment of the component was last attempted.
The time when the component was last deployed successfully.
The time when the component was last modified.
The name of the component.
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_environment(**kwargs)¶Delete an environment.
See also: AWS API Documentation
Request Syntax
response = client.delete_environment(
name='string'
)
[REQUIRED]
The name of the environment to delete.
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The detailed data of the environment being deleted.
The Amazon Resource Name (ARN) of the environment.
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
The time when the environment was created.
The environment deployment status.
An environment deployment status message.
The description of the environment.
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
The ID of the environment account that the environment infrastructure resources are provisioned in.
The time when a deployment of the environment was last attempted.
The time when the environment was last deployed successfully.
The name of the environment.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
The Amazon Resource Name (ARN) of the linked repository.
The repository branch.
The repository name.
The repository provider.
The environment spec.
The major version of the environment template.
The minor version of the environment template.
The Amazon Resource Name (ARN) of the environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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 User guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_environment_account_connection(
id='string'
)
[REQUIRED]
The ID of the environment account connection to delete.
{
'environmentAccountConnection': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The detailed data of the environment account connection being deleted.
The Amazon Resource Name (ARN) of the environment account connection.
The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
The environment account that's connected to the environment account connection.
The name of the environment that's associated with the environment account connection.
The ID of the environment account connection.
The time when the environment account connection was last modified.
The ID of the management account that's connected to the environment account connection.
The time when the environment account connection request was made.
The IAM service role that's associated with the environment account connection.
The status of the environment account connection.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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'
)
[REQUIRED]
The name of the environment template to delete.
{
'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
The detailed data of the environment template being deleted.
The Amazon Resource Name (ARN) of the environment template.
The time when the environment template was created.
A description of the environment template.
The name of the environment template as displayed in the developer interface.
The customer provided encryption key for the environment template.
The time when the environment template was last modified.
The name of the environment template.
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
The ID of the recommended version of the environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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'
)
[REQUIRED]
The environment template major version to delete.
[REQUIRED]
The environment template minor version to delete.
[REQUIRED]
The name of the environment template.
dict
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 detailed data of the environment template version being deleted.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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'
)
[REQUIRED]
The repository name.
[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 deleted repository link's detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
connectionArn (string) --
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.
encryptionKey (string) --
Your customer Amazon Web Services KMS encryption key.
name (string) --
The repository name.
provider (string) --
The repository provider.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_service(**kwargs)¶Delete a service, with its instances and pipeline.
Note
You can't delete a service if it has any service instances that have components attached to them.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_service(
name='string'
)
[REQUIRED]
The name of the service to delete.
{
'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
The detailed data of the service being deleted.
The Amazon Resource Name (ARN) of the service.
The name of the code repository branch that holds the code that's deployed in Proton.
The time when the service was created.
A description of the service.
The time when the service was last modified.
The name of the service.
The service pipeline detail data.
The Amazon Resource Name (ARN) of the service pipeline.
The time when the service pipeline was created.
The deployment status of the service pipeline.
A service pipeline deployment status message.
The time when a deployment of the service pipeline was last attempted.
The time when the service pipeline was last deployed successfully.
The service spec that was used to create the service pipeline.
The major version of the service template that was used to create the service pipeline.
The minor version of the service template that was used to create the service pipeline.
The name of the service template that was used to create the service pipeline.
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide .
The ID of the source code repository.
The formatted specification that defines the service.
The status of the service.
A service status message.
The name of the service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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'
)
[REQUIRED]
The name of the service template to delete.
{
'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
The detailed data of the service template being deleted.
The Amazon Resource Name (ARN) of the service template.
The time when the service template was created.
A description of the service template.
The service template name as displayed in the developer interface.
The customer provided service template encryption key that's used to encrypt data.
The time when the service template was last modified.
The name of the service template.
If pipelineProvisioning is true , a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
The recommended version of the service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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'
)
[REQUIRED]
The service template major version to delete.
[REQUIRED]
The service template minor version to delete.
[REQUIRED]
The name of the service template.
dict
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',
'supportedComponentSources': [
'DIRECTLY_DEFINED',
],
'templateName': 'string'
}
}
Response Structure
(dict) --
serviceTemplateVersion (dict) --
The detailed data of the service template version being deleted.
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.
supportedComponentSources (list) --
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide .
templateName (string) --
The name of the version of a service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiondelete_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'
)
[REQUIRED]
The template name.
[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 repository name (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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_account_settings()¶Get detail data for Proton account-wide settings.
See also: AWS API Documentation
Request Syntax
response = client.get_account_settings()
{
'accountSettings': {
'pipelineCodebuildRoleArn': 'string',
'pipelineProvisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'pipelineServiceRoleArn': 'string'
}
}
Response Structure
The Proton pipeline service role detail data that's returned by Proton.
The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.
The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
The Amazon Resource Name (ARN) of the linked repository.
The repository branch.
The repository name.
The repository provider.
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_component(**kwargs)¶Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_component(
name='string'
)
[REQUIRED]
The name of the component that you want to get the detailed data for.
{
'component': {
'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',
'environmentName': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
The detailed data of the requested component.
The Amazon Resource Name (ARN) of the component.
The time when the component was created.
The component deployment status.
The message associated with the component deployment status.
A description of the component.
The name of the Proton environment that this component is associated with.
The time when a deployment of the component was last attempted.
The time when the component was last deployed successfully.
The time when the component was last modified.
The name of the component.
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_environment(**kwargs)¶Get detailed data for an environment.
See also: AWS API Documentation
Request Syntax
response = client.get_environment(
name='string'
)
[REQUIRED]
The name of the environment that you want to get the detailed data for.
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The detailed data of the requested environment.
The Amazon Resource Name (ARN) of the environment.
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
The time when the environment was created.
The environment deployment status.
An environment deployment status message.
The description of the environment.
The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
The ID of the environment account that the environment infrastructure resources are provisioned in.
The time when a deployment of the environment was last attempted.
The time when the environment was last deployed successfully.
The name of the environment.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
The Amazon Resource Name (ARN) of the linked repository.
The repository branch.
The repository name.
The repository provider.
The environment spec.
The major version of the environment template.
The minor version of the environment template.
The Amazon Resource Name (ARN) of the environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_environment_account_connection(**kwargs)¶In an environment account, get the detailed data for an environment account connection.
For more information, see Environment account connections in the Proton User guide .
See also: AWS API Documentation
Request Syntax
response = client.get_environment_account_connection(
id='string'
)
[REQUIRED]
The ID of the environment account connection that you want to get the detailed data for.
{
'environmentAccountConnection': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The detailed data of the requested environment account connection.
The Amazon Resource Name (ARN) of the environment account connection.
The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
The environment account that's connected to the environment account connection.
The name of the environment that's associated with the environment account connection.
The ID of the environment account connection.
The time when the environment account connection was last modified.
The ID of the management account that's connected to the environment account connection.
The time when the environment account connection request was made.
The IAM service role that's associated with the environment account connection.
The status of the environment account connection.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_environment_template(**kwargs)¶Get detailed data for an environment template.
See also: AWS API Documentation
Request Syntax
response = client.get_environment_template(
name='string'
)
[REQUIRED]
The name of the environment template that you want to get the detailed data for.
{
'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
The detailed data of the requested environment template.
The Amazon Resource Name (ARN) of the environment template.
The time when the environment template was created.
A description of the environment template.
The name of the environment template as displayed in the developer interface.
The customer provided encryption key for the environment template.
The time when the environment template was last modified.
The name of the environment template.
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
The ID of the recommended version of the environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_environment_template_version(**kwargs)¶Get detailed 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'
)
[REQUIRED]
To get environment template major version detail data, include major Version .
[REQUIRED]
To get environment template minor version detail data, include minorVersion .
[REQUIRED]
The name of the environment template a version of which you want to get detailed data for.
dict
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 detailed data of the requested environment template version.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_repository(**kwargs)¶Get detail data for a linked repository.
See also: AWS API Documentation
Request Syntax
response = client.get_repository(
name='string',
provider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
)
[REQUIRED]
The repository name, for example myrepos/myrepo .
[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 link's detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
connectionArn (string) --
The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.
encryptionKey (string) --
Your customer Amazon Web Services KMS encryption key.
name (string) --
The repository name.
provider (string) --
The repository provider.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_repository_sync_status(**kwargs)¶Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
Note
A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).
For more information about ABAC, see ABAC in the Proton User Guide .
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'
)
[REQUIRED]
The repository branch.
[REQUIRED]
The repository name.
[REQUIRED]
The repository provider.
[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.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_service(**kwargs)¶Get detailed data for a service.
See also: AWS API Documentation
Request Syntax
response = client.get_service(
name='string'
)
[REQUIRED]
The name of the service that you want to get the detailed data for.
{
'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
The detailed data of the requested service.
The Amazon Resource Name (ARN) of the service.
The name of the code repository branch that holds the code that's deployed in Proton.
The time when the service was created.
A description of the service.
The time when the service was last modified.
The name of the service.
The service pipeline detail data.
The Amazon Resource Name (ARN) of the service pipeline.
The time when the service pipeline was created.
The deployment status of the service pipeline.
A service pipeline deployment status message.
The time when a deployment of the service pipeline was last attempted.
The time when the service pipeline was last deployed successfully.
The service spec that was used to create the service pipeline.
The major version of the service template that was used to create the service pipeline.
The minor version of the service template that was used to create the service pipeline.
The name of the service template that was used to create the service pipeline.
The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide .
The ID of the source code repository.
The formatted specification that defines the service.
The status of the service.
A service status message.
The name of the service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_service_instance(**kwargs)¶Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
See also: AWS API Documentation
Request Syntax
response = client.get_service_instance(
name='string',
serviceName='string'
)
[REQUIRED]
The name of a service instance that you want to get the detailed data for.
[REQUIRED]
The name of the service that the service instance belongs to.
dict
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 detailed data of the requested service instance.
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) --
The message associated with the service instance deployment status.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_service_template(**kwargs)¶Get detailed data for a service template.
See also: AWS API Documentation
Request Syntax
response = client.get_service_template(
name='string'
)
[REQUIRED]
The name of the service template that you want to get detailed data for.
{
'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
The detailed data of the requested service template.
The Amazon Resource Name (ARN) of the service template.
The time when the service template was created.
A description of the service template.
The service template name as displayed in the developer interface.
The customer provided service template encryption key that's used to encrypt data.
The time when the service template was last modified.
The name of the service template.
If pipelineProvisioning is true , a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.
The recommended version of the service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_service_template_version(**kwargs)¶Get detailed 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'
)
[REQUIRED]
To get service template major version detail data, include major Version .
[REQUIRED]
To get service template minor version detail data, include minorVersion .
[REQUIRED]
The name of the service template a version of which you want to get detailed data for.
dict
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',
'supportedComponentSources': [
'DIRECTLY_DEFINED',
],
'templateName': 'string'
}
}
Response Structure
(dict) --
serviceTemplateVersion (dict) --
The detailed data of the requested service template version.
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.
supportedComponentSources (list) --
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide .
templateName (string) --
The name of the version of a service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_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'
)
[REQUIRED]
The template name.
[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 repository name (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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_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'
)
[REQUIRED]
The template name.
[REQUIRED]
The template type.
[REQUIRED]
The template major 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.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_component_outputs(**kwargs)¶Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_component_outputs(
componentName='string',
nextToken='string'
)
[REQUIRED]
The name of the component whose outputs you want.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
outputs (list) --
An array of component Infrastructure as Code (IaC) outputs.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_component_provisioned_resources(**kwargs)¶List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_component_provisioned_resources(
componentName='string',
nextToken='string'
)
[REQUIRED]
The name of the component whose provisioned resources you want.
dict
Response Syntax
{
'nextToken': 'string',
'provisionedResources': [
{
'identifier': 'string',
'name': 'string',
'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates 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 component.
(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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_components(**kwargs)¶List components with summary data. You can filter the result list by environment, service, or a single service instance.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_components(
environmentName='string',
maxResults=123,
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
dict
Response Syntax
{
'components': [
{
'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),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
components (list) --
An array of components with summary data.
(dict) --
Summary data of an Proton component resource.
For more information about components, see Proton components in the Proton User Guide .
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
nextToken (string) --
A token that indicates the location of the next component in the array of components, after the current requested list of components.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.InternalServerExceptionlist_environment_account_connections(**kwargs)¶View a list of environment account connections.
For more information, see Environment account connections in the Proton User 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',
]
)
[REQUIRED]
The type of account making the ListEnvironmentAccountConnections request.
The status details for each listed environment account connection.
dict
Response Syntax
{
'environmentAccountConnections': [
{
'arn': 'string',
'componentRoleArn': '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) --
Summary data of an Proton environment account connection resource.
arn (string) --
The Amazon Resource Name (ARN) of the environment account connection.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
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 that indicates 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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
[REQUIRED]
The environment name.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates 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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
[REQUIRED]
The environment name.
dict
Response Syntax
{
'nextToken': 'string',
'provisionedResources': [
{
'identifier': 'string',
'name': 'string',
'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates 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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
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 .
[REQUIRED]
The name of the environment template.
dict
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 that indicates 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 environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_environment_templates(**kwargs)¶List environment templates.
See also: AWS API Documentation
Request Syntax
response = client.list_environment_templates(
maxResults=123,
nextToken='string'
)
dict
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 that indicates 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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
An array of the versions of the environment template.
A search filter for environment templates.
Include majorVersion to filter search for a major version.
Include templateName to filter search for a template name.
dict
Response Syntax
{
'environments': [
{
'arn': 'string',
'componentRoleArn': '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) --
Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
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 that indicates the location of the next environment in the array of environments, after the current requested list of environments.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_repositories(**kwargs)¶List linked repositories with detail data.
See also: AWS API Documentation
Request Syntax
response = client.list_repositories(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'nextToken': 'string',
'repositories': [
{
'arn': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories.
repositories (list) --
An array of repository links.
(dict) --
Summary data of a linked repository—a repository that has been registered with Proton.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
name (string) --
The repository name.
provider (string) --
The repository provider.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
[REQUIRED]
The repository name.
[REQUIRED]
The repository provider.
[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 that indicates 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) --
A 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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.InternalServerExceptionlist_service_instance_outputs(**kwargs)¶Get a list service of instance Infrastructure as Code (IaC) outputs.
See also: AWS API Documentation
Request Syntax
response = client.list_service_instance_outputs(
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
[REQUIRED]
The name of the service instance whose outputs you want.
[REQUIRED]
The name of the service that serviceInstanceName is associated to.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates 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 (IaC) outputs.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
[REQUIRED]
The name of the service instance whose provisioned resources you want.
[REQUIRED]
The name of the service that serviceInstanceName is associated to.
dict
Response Syntax
{
'nextToken': 'string',
'provisionedResources': [
{
'identifier': 'string',
'name': 'string',
'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates 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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_service_instances(**kwargs)¶List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.list_service_instances(
filters=[
{
'key': 'name'|'deploymentStatus'|'templateName'|'serviceName'|'deployedTemplateVersionStatus'|'environmentName'|'lastDeploymentAttemptedAtBefore'|'lastDeploymentAttemptedAtAfter'|'createdAtBefore'|'createdAtAfter',
'value': 'string'
},
],
maxResults=123,
nextToken='string',
serviceName='string',
sortBy='name'|'deploymentStatus'|'templateName'|'serviceName'|'environmentName'|'lastDeploymentAttemptedAt'|'createdAt',
sortOrder='ASCENDING'|'DESCENDING'
)
An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
A filtering criterion to scope down the result list of the ListServiceInstances action.
The name of a filtering criterion.
A value to filter by.
With the date/time keys ( *At{Before,After} ), the value is a valid RFC 3339 string with no UTC offset and with an optional fractional precision (for example, 1985-04-12T23:20:50.52Z ).
The field that the result list is sorted by.
When you choose to sort by serviceName , service instances within each service are sorted by service instance name.
Default: serviceName
Result list sort order.
Default: ASCENDING
dict
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 that indicates 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 summary data.
(dict) --
Summary data of an Proton service instance resource.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_service_pipeline_outputs(**kwargs)¶Get a list of service pipeline Infrastructure as Code (IaC) outputs.
See also: AWS API Documentation
Request Syntax
response = client.list_service_pipeline_outputs(
nextToken='string',
serviceName='string'
)
[REQUIRED]
The name of the service whose pipeline's outputs you want.
dict
Response Syntax
{
'nextToken': 'string',
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
outputs (list) --
An array of service pipeline Infrastructure as Code (IaC) outputs.
(dict) --
An infrastructure as code defined resource output.
key (string) --
The output key.
valueString (string) --
The output value.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
[REQUIRED]
The name of the service whose pipeline's provisioned resources you want.
dict
Response Syntax
{
'nextToken': 'string',
'provisionedResources': [
{
'identifier': 'string',
'name': 'string',
'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates 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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
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 .
[REQUIRED]
The name of the service template.
dict
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 that indicates 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) --
Summary data of an Proton service template version resource.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionlist_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'
)
dict
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 that indicates 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) --
Summary data of an Proton service template resource.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.InternalServerExceptionlist_services(**kwargs)¶List services with summaries of detail data.
See also: AWS API Documentation
Request Syntax
response = client.list_services(
maxResults=123,
nextToken='string'
)
dict
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 that indicates 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) --
Summary data of an Proton service resource.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.InternalServerExceptionList tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
maxResults=123,
nextToken='string',
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for the listed tags.
dict
Response Syntax
{
'nextToken': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.
tags (list) --
A list 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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionnotify_resource_deployment_status_change(**kwargs)¶Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
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'
)
The provisioned resource state change detail data that's returned by Proton.
An infrastructure as code defined resource output.
The output key.
The output value.
[REQUIRED]
The provisioned resource Amazon Resource Name (ARN).
dict
Response Syntax
{}
Response Structure
Exceptions
Proton.Client.exceptions.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionreject_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 can't accept or use the rejected environment account connection.
You can’t reject an environment account connection that's connected to an environment.
For more information, see Environment account connections in the Proton User guide .
See also: AWS API Documentation
Request Syntax
response = client.reject_environment_account_connection(
id='string'
)
[REQUIRED]
The ID of the environment account connection to reject.
{
'environmentAccountConnection': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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
The environment connection account detail data that's returned by Proton.
The Amazon Resource Name (ARN) of the environment account connection.
The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
The environment account that's connected to the environment account connection.
The name of the environment that's associated with the environment account connection.
The ID of the environment account connection.
The time when the environment account connection was last modified.
The ID of the management account that's connected to the environment account connection.
The time when the environment account connection request was made.
The IAM service role that's associated with the environment account connection.
The status of the environment account connection.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptiontag_resource(**kwargs)¶Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.
[REQUIRED]
A list of customer tags to apply to the Proton resource.
A description of a resource tag.
The key of the resource tag.
The value of the resource tag.
dict
Response Syntax
{}
Response Structure
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionuntag_resource(**kwargs)¶Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to remove customer tags from.
[REQUIRED]
A list of customer tag keys that indicate the customer tags to be removed from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_account_settings(**kwargs)¶Update Proton settings that are used for multiple services in the Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.update_account_settings(
deletePipelineProvisioningRepository=True|False,
pipelineCodebuildRoleArn='string',
pipelineProvisioningRepository={
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
pipelineServiceRoleArn='string'
)
true to remove a configured pipeline repository from the account settings. Don't set this field if you are updating the configured pipeline repository.A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To remove a previously configured repository, set deletePipelineProvisioningRepository to true , and don't set pipelineProvisioningRepository .
The repository branch.
The repository name.
The repository provider.
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
To remove a previously configured ARN, specify an empty string.
dict
Response Syntax
{
'accountSettings': {
'pipelineCodebuildRoleArn': 'string',
'pipelineProvisioningRepository': {
'arn': 'string',
'branch': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
'pipelineServiceRoleArn': 'string'
}
}
Response Structure
(dict) --
accountSettings (dict) --
The Proton pipeline service role and repository data shared across the Amazon Web Services account.
pipelineCodebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.
pipelineProvisioningRepository (dict) --
The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
pipelineServiceRoleArn (string) --
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.InternalServerExceptionupdate_component(**kwargs)¶Update a component.
There are a few modes for updating a component. The deploymentType field defines the mode.
Note
You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS .
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_component(
deploymentType='NONE'|'CURRENT_VERSION',
description='string',
name='string',
serviceInstanceName='string',
serviceName='string',
serviceSpec='string',
templateFile='string'
)
[REQUIRED]
The deployment type. It defines the mode for updating a component, as follows:
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify description in this mode.
CURRENT_VERSION
In this mode, the component is deployed and updated with the new serviceSpec , templateSource , and/or type that you provide. Only requested parameters are updated.
[REQUIRED]
The name of the component to update.
serviceInstanceName and serviceName or for neither of them.serviceInstanceName is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Note
Components support a single IaC file, even if you use Terraform as your template language.
dict
Response Syntax
{
'component': {
'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',
'environmentName': 'string',
'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
'lastDeploymentSucceededAt': datetime(2015, 1, 1),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string',
'serviceSpec': 'string'
}
}
Response Structure
(dict) --
component (dict) --
The detailed data of the updated component.
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
description (string) --
A description of the component.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
serviceSpec (string) --
The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.
Exceptions
Proton.Client.exceptions.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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 that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository parameter and omit the protonServiceRoleArn and environmentAccountConnectionId parameters.
For more information, see Environments and Provisioning methods in the Proton User Guide .
There are four modes for updating an environment. 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.
See also: AWS API Documentation
Request Syntax
response = client.update_environment(
codebuildRoleArn='string',
componentRoleArn='string',
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'
)
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
[REQUIRED]
There are four modes for updating an environment. 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 major or minor 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).
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.
[REQUIRED]
The name of the environment to update.
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
The repository branch.
The repository name.
The repository provider.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
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 linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
arn (string) --
The Amazon Resource Name (ARN) of the linked repository.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The major version of the environment template.
templateMinorVersion (string) --
The minor version of the environment template.
templateName (string) --
The Amazon Resource Name (ARN) of the environment template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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 User guide .
See also: AWS API Documentation
Request Syntax
response = client.update_environment_account_connection(
codebuildRoleArn='string',
componentRoleArn='string',
id='string',
roleArn='string'
)
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
[REQUIRED]
The ID of the environment account connection to update.
dict
Response Syntax
{
'environmentAccountConnection': {
'arn': 'string',
'codebuildRoleArn': 'string',
'componentRoleArn': '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.
codebuildRoleArn (string) --
The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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'
)
[REQUIRED]
The name of the environment template to update.
dict
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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'
)
[REQUIRED]
To update a major version of an environment template, include major Version .
[REQUIRED]
To update a minor version of an environment template, include minorVersion .
[REQUIRED]
The name of the environment template.
dict
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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.
Note
You can't delete a service instance (remove it from the spec) if it has an attached component.
For more information about components, see Proton components in the Proton User Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_service(
description='string',
name='string',
spec='string'
)
[REQUIRED]
The name of the service to edit.
dict
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 the 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 Setting up an AWS CodeStar connection 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.ServiceQuotaExceededExceptionProton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_service_instance(**kwargs)¶Update a service instance.
There are a few modes for updating a service instance. The deploymentType field defines the mode.
Note
You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is IN_PROGRESS .
For more information about components, see Proton components in the Proton User Guide .
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'
)
[REQUIRED]
The deployment type. It defines the mode for updating a service instance, as follows:
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 major or minor 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 specify a different major version that's higher than the major version in use and a minor version.
[REQUIRED]
The name of the service instance to update.
[REQUIRED]
The name of the service that the service instance belongs to.
dict
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) --
The message associated with the service instance deployment status.
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_service_pipeline(**kwargs)¶Update the service pipeline.
There are four modes for updating a service pipeline. 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 major or minor 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 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 specify a different major version that's higher than the major version in use and a minor version.
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'
)
[REQUIRED]
The deployment type.
There are four modes for updating a service pipeline. 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 major or minor 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 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 specify a different major version that's higher than the major version in use and a minor version.
[REQUIRED]
The name of the service to that the pipeline is associated with.
[REQUIRED]
The spec for the service pipeline to update.
dict
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 that are 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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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'
)
[REQUIRED]
The name of the service template to update.
dict
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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_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',
supportedComponentSources=[
'DIRECTLY_DEFINED',
],
templateName='string'
)
An array of environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.
Compatible environment template data.
The major version of the compatible environment template.
The compatible environment template name.
[REQUIRED]
To update a major version of a service template, include major Version .
[REQUIRED]
To update a minor version of a service template, include minorVersion .
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
Note
A change to supportedComponentSources doesn't impact existing component attachments to instances based on this template version. A change only affects later associations.
For more information about components, see Proton components in the Proton User Guide .
[REQUIRED]
The name of the service template.
dict
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',
'supportedComponentSources': [
'DIRECTLY_DEFINED',
],
'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.
supportedComponentSources (list) --
An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.
For more information about components, see Proton components in the Proton User Guide .
templateName (string) --
The name of the version of a service template.
Exceptions
Proton.Client.exceptions.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionupdate_template_sync_config(**kwargs)¶Update template sync configuration parameters, except for the templateName and templateType . Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
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'
)
[REQUIRED]
The repository branch for your template.
[REQUIRED]
The repository name (for example, myrepos/myrepo ).
[REQUIRED]
The repository provider.
[REQUIRED]
The synced template name.
[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 repository name (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.ValidationExceptionProton.Client.exceptions.AccessDeniedExceptionProton.Client.exceptions.ThrottlingExceptionProton.Client.exceptions.ConflictExceptionProton.Client.exceptions.ResourceNotFoundExceptionProton.Client.exceptions.InternalServerExceptionThe available paginators are:
Proton.Paginator.ListComponentOutputsProton.Paginator.ListComponentProvisionedResourcesProton.Paginator.ListComponentsProton.Paginator.ListEnvironmentAccountConnectionsProton.Paginator.ListEnvironmentOutputsProton.Paginator.ListEnvironmentProvisionedResourcesProton.Paginator.ListEnvironmentTemplateVersionsProton.Paginator.ListEnvironmentTemplatesProton.Paginator.ListEnvironmentsProton.Paginator.ListRepositoriesProton.Paginator.ListRepositorySyncDefinitionsProton.Paginator.ListServiceInstanceOutputsProton.Paginator.ListServiceInstanceProvisionedResourcesProton.Paginator.ListServiceInstancesProton.Paginator.ListServicePipelineOutputsProton.Paginator.ListServicePipelineProvisionedResourcesProton.Paginator.ListServiceTemplateVersionsProton.Paginator.ListServiceTemplatesProton.Paginator.ListServicesProton.Paginator.ListTagsForResourceProton.Paginator.ListComponentOutputs¶paginator = client.get_paginator('list_component_outputs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Proton.Client.list_component_outputs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
componentName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the component whose outputs you want.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
outputs (list) --
An array of component Infrastructure as Code (IaC) 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.
Proton.Paginator.ListComponentProvisionedResources¶paginator = client.get_paginator('list_component_provisioned_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Proton.Client.list_component_provisioned_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
componentName='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the component whose provisioned resources you want.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'provisionedResources': [
{
'identifier': 'string',
'name': 'string',
'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
provisionedResources (list) --
An array of provisioned resources for a component.
(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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
NextToken (string) --
A token to resume pagination.
Proton.Paginator.ListComponents¶paginator = client.get_paginator('list_components')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Proton.Client.list_components().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
environmentName='string',
serviceInstanceName='string',
serviceName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'components': [
{
'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),
'lastModifiedAt': datetime(2015, 1, 1),
'name': 'string',
'serviceInstanceName': 'string',
'serviceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
components (list) --
An array of components with summary data.
(dict) --
Summary data of an Proton component resource.
For more information about components, see Proton components in the Proton User Guide .
arn (string) --
The Amazon Resource Name (ARN) of the component.
createdAt (datetime) --
The time when the component was created.
deploymentStatus (string) --
The component deployment status.
deploymentStatusMessage (string) --
The message associated with the component deployment status.
environmentName (string) --
The name of the Proton environment that this component is associated with.
lastDeploymentAttemptedAt (datetime) --
The time when a deployment of the component was last attempted.
lastDeploymentSucceededAt (datetime) --
The time when the component was last deployed successfully.
lastModifiedAt (datetime) --
The time when the component was last modified.
name (string) --
The name of the component.
serviceInstanceName (string) --
The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.
serviceName (string) --
The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.
NextToken (string) --
A token to resume pagination.
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'
}
)
[REQUIRED]
The type of account making the ListEnvironmentAccountConnections request.
The status details for each listed environment account connection.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'environmentAccountConnections': [
{
'arn': 'string',
'componentRoleArn': '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) --
Summary data of an Proton environment account connection resource.
arn (string) --
The Amazon Resource Name (ARN) of the environment account connection.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.
The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.
For more information about components, see Proton components in the Proton User Guide .
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.
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'
}
)
[REQUIRED]
The environment name.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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.
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'
}
)
[REQUIRED]
The environment name.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
NextToken (string) --
A token to resume pagination.
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'
}
)
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 .
[REQUIRED]
The name of the environment template.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 environment template.
NextToken (string) --
A token to resume pagination.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
An array of environment templates with detail data.
The environment template data.
The Amazon Resource Name (ARN) of the environment template.
The time when the environment template was created.
A description of the environment template.
The name of the environment template as displayed in the developer interface.
The time when the environment template was last modified.
The name of the environment template.
When included, indicates that the environment template is for customer provisioned and managed infrastructure.
The recommended version of the environment template.
A token to resume pagination.
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'
}
)
An array of the versions of the environment template.
A search filter for environment templates.
Include majorVersion to filter search for a major version.
Include templateName to filter search for a template name.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'environments': [
{
'arn': 'string',
'componentRoleArn': '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) --
Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.
arn (string) --
The Amazon Resource Name (ARN) of the environment.
componentRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
For more information about components, see Proton components in the Proton User Guide .
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.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'repositories': [
{
'arn': 'string',
'name': 'string',
'provider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET'
},
],
'NextToken': 'string'
}
Response Structure
An array of repository links.
Summary data of a linked repository—a repository that has been registered with Proton.
The Amazon Resource Name (ARN) of the linked repository.
The repository name.
The repository provider.
A token to resume pagination.
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'
}
)
[REQUIRED]
The repository name.
[REQUIRED]
The repository provider.
[REQUIRED]
The sync type. The only supported value is TEMPLATE_SYNC .
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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) --
A 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.
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'
}
)
[REQUIRED]
The name of the service instance whose outputs you want.
[REQUIRED]
The name of the service that serviceInstanceName is associated to.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
outputs (list) --
An array of service instance Infrastructure as Code (IaC) 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.
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'
}
)
[REQUIRED]
The name of the service instance whose provisioned resources you want.
[REQUIRED]
The name of the service that serviceInstanceName is associated to.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
NextToken (string) --
A token to resume pagination.
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(
filters=[
{
'key': 'name'|'deploymentStatus'|'templateName'|'serviceName'|'deployedTemplateVersionStatus'|'environmentName'|'lastDeploymentAttemptedAtBefore'|'lastDeploymentAttemptedAtAfter'|'createdAtBefore'|'createdAtAfter',
'value': 'string'
},
],
serviceName='string',
sortBy='name'|'deploymentStatus'|'templateName'|'serviceName'|'environmentName'|'lastDeploymentAttemptedAt'|'createdAt',
sortOrder='ASCENDING'|'DESCENDING',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
A filtering criterion to scope down the result list of the ListServiceInstances action.
The name of a filtering criterion.
A value to filter by.
With the date/time keys ( *At{Before,After} ), the value is a valid RFC 3339 string with no UTC offset and with an optional fractional precision (for example, 1985-04-12T23:20:50.52Z ).
The field that the result list is sorted by.
When you choose to sort by serviceName , service instances within each service are sorted by service instance name.
Default: serviceName
Result list sort order.
Default: ASCENDING
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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 summary data.
(dict) --
Summary data of an Proton service instance resource.
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.
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'
}
)
[REQUIRED]
The name of the service whose pipeline's outputs you want.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'outputs': [
{
'key': 'string',
'valueString': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
outputs (list) --
An array of service pipeline Infrastructure as Code (IaC) 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.
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'
}
)
[REQUIRED]
The name of the service whose pipeline's provisioned resources you want.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide .
NextToken (string) --
A token to resume pagination.
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'
}
)
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 .
[REQUIRED]
The name of the service template.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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) --
Summary data of an Proton service template version resource.
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.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
An array of service templates with detail data.
Summary data of an Proton service template resource.
The Amazon Resource Name (ARN) of the service template.
The time when the service template was created.
A description of the service template.
The service template name as displayed in the developer interface.
The time when the service template was last modified.
The name of the service template.
If pipelineProvisioning is true , a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.
The recommended version of the service template.
A token to resume pagination.
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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
An array of services with summaries of detail data.
Summary data of an Proton service resource.
The Amazon Resource Name (ARN) of the service.
The time when the service was created.
A description of the service.
The time when the service was last modified.
The name of the service.
The status of the service.
A service status message.
The name of the service template.
A token to resume pagination.
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'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for the listed tags.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
A list 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.
The available waiters are:
Proton.Waiter.ComponentDeletedProton.Waiter.ComponentDeployedProton.Waiter.EnvironmentDeployedProton.Waiter.EnvironmentTemplateVersionRegisteredProton.Waiter.ServiceCreatedProton.Waiter.ServiceDeletedProton.Waiter.ServiceInstanceDeployedProton.Waiter.ServicePipelineDeployedProton.Waiter.ServiceTemplateVersionRegisteredProton.Waiter.ServiceUpdatedProton.Waiter.ComponentDeleted¶waiter = client.get_waiter('component_deleted')
wait(**kwargs)¶Polls Proton.Client.get_component() 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
}
)
[REQUIRED]
The name of the component that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None
Proton.Waiter.ComponentDeployed¶waiter = client.get_waiter('component_deployed')
wait(**kwargs)¶Polls Proton.Client.get_component() 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
}
)
[REQUIRED]
The name of the component that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None
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
}
)
[REQUIRED]
The name of the environment that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None
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
}
)
[REQUIRED]
To get environment template major version detail data, include major Version .
[REQUIRED]
To get environment template minor version detail data, include minorVersion .
[REQUIRED]
The name of the environment template a version of which you want to get detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 150
None
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
}
)
[REQUIRED]
The name of the service that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None
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
}
)
[REQUIRED]
The name of the service that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None
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
}
)
[REQUIRED]
The name of a service instance that you want to get the detailed data for.
[REQUIRED]
The name of the service that the service instance belongs to.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None
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
}
)
[REQUIRED]
The name of the service that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 10
The maximum number of attempts to be made. Default: 360
None
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
}
)
[REQUIRED]
To get service template major version detail data, include major Version .
[REQUIRED]
To get service template minor version detail data, include minorVersion .
[REQUIRED]
The name of the service template a version of which you want to get detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 150
None
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
}
)
[REQUIRED]
The name of the service that you want to get the detailed data for.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 999
None