2022/06/02 - AWS Proton - 8 new 17 updated api methods
Changes Add new "Components" API to enable users to Create, Delete and Update AWS Proton components.
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 Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_components(
environmentName='string',
maxResults=123,
nextToken='string',
serviceInstanceName='string',
serviceName='string'
)
string
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
integer
The maximum number of components to list.
string
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
string
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
string
The name of a service for result list filtering. Proton returns components attached to service instances of the service.
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 Administrator 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.
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 Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.cancel_component_deployment(
componentName='string'
)
string
[REQUIRED]
The name of the component with the deployment to cancel.
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 component with the deployment that is being canceled.
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.
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 Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.create_component(
description='string',
environmentName='string',
manifest='string',
name='string',
serviceInstanceName='string',
serviceName='string',
serviceSpec='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
templateFile='string'
)
string
An optional customer-provided description of the component.
string
The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName .
string
[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.
string
[REQUIRED]
The customer-provided name of the component.
string
The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.
string
The name of the service that 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.
string
The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.
list
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 Administrator Guide or Proton User Guide.
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
[REQUIRED]
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.
Delete an Proton component resource.
For more information about components, see Proton components in the Proton Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.delete_component(
name='string'
)
string
[REQUIRED]
The name of the component to delete.
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 component being deleted.
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.
Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_component_outputs(
componentName='string',
nextToken='string'
)
string
[REQUIRED]
The name of the component whose outputs you want.
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.
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.
List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_component_provisioned_resources(
componentName='string',
nextToken='string'
)
string
[REQUIRED]
The name of the component whose provisioned resources you want.
string
A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
dict
Response Syntax
{
'nextToken': 'string',
'provisionedResources': [
{
'identifier': 'string',
'name': 'string',
'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
},
]
}
Response Structure
(dict) --
nextToken (string) --
A token 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 Administrator Guide .
Get detailed data for a component.
For more information about components, see Proton components in the Proton Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.get_component(
name='string'
)
string
[REQUIRED]
The name of the component that you want to get the detailed data for.
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 requested 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.
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 Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.update_component(
deploymentType='NONE'|'CURRENT_VERSION',
description='string',
name='string',
serviceInstanceName='string',
serviceName='string',
serviceSpec='string',
templateFile='string'
)
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.
string
An optional customer-provided description of the component.
string
[REQUIRED]
The name of the component to update.
string
The name of the service instance that you want to attach this component to. 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.
string
The name of the service that 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.
string
The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
string
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.
{'environmentAccountConnection': {'componentRoleArn': 'string'}}
In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
For more information, see Environment account connections in the Proton Administrator guide .
See also: AWS API Documentation
Request Syntax
client.accept_environment_account_connection(
id='string'
)
string
[REQUIRED]
The ID of the environment account connection.
dict
Response Syntax
{
'environmentAccountConnection': {
'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'
}
}
Response Structure
(dict) --
environmentAccountConnection (dict) --
The environment account connection data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the environment account connection.
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 Administrator 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.
{'environment': {'componentRoleArn': 'string'}}
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS . For more information, see Update an environment in the Proton Administrator guide .
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED .
If the cancellation attempt fails, the resulting deployment state is FAILED .
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED and the cancellation attempt has no effect.
See also: AWS API Documentation
Request Syntax
client.cancel_environment_deployment(
environmentName='string'
)
string
[REQUIRED]
The name of the environment with the deployment to cancel.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'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 summary data that's returned by Proton.
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 Administrator 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 infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
arn (string) --
The Amazon Resource Name (ARN) of the repository branch.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The 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.
{'componentRoleArn': 'string'}
Response {'environment': {'componentRoleArn': 'string'}}
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:
Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.
For more information, see Environments and Provisioning methods in the Proton Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.create_environment(
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'
)
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.
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 Administrator Guide .
string
A description of the environment that's being created and deployed.
string
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton Administrator guide .
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
string
[REQUIRED]
The name of the environment.
string
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
dict
The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
string
[REQUIRED]
A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide .
list
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 Administrator Guide or Proton User Guide.
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
[REQUIRED]
The major version of the environment template.
string
The minor version of the environment template.
string
[REQUIRED]
The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide .
dict
Response Syntax
{
'environment': {
'arn': 'string',
'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.
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 Administrator 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 infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
arn (string) --
The Amazon Resource Name (ARN) of the repository branch.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The 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.
{'componentRoleArn': 'string'}
Response {'environmentAccountConnection': {'componentRoleArn': 'string'}}
Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator guide .
See also: AWS API Documentation
Request Syntax
client.create_environment_account_connection(
clientToken='string',
componentRoleArn='string',
environmentName='string',
managementAccountId='string',
roleArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
This field is autopopulated if not provided.
string
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 Administrator Guide .
string
[REQUIRED]
The name of the Proton environment that's created in the associated management account.
string
[REQUIRED]
The ID of the management account that accepts or rejects the environment account connection. You create 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.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.
list
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 Administrator Guide .
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
dict
Response Syntax
{
'environmentAccountConnection': {
'arn': 'string',
'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.
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 Administrator 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.
{'supportedComponentSources': ['DIRECTLY_DEFINED']}
Response {'serviceTemplateVersion': {'supportedComponentSources': ['DIRECTLY_DEFINED']}}
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
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'
)
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.
list
[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.
(dict) --
Compatible environment template data.
majorVersion (string) -- [REQUIRED]
The major version of the compatible environment template.
templateName (string) -- [REQUIRED]
The compatible environment template name.
string
A description of the new version of a service template.
string
To create a new minor version of the service template, include a major Version .
To create a new major and minor version of the service template, exclude major Version .
dict
[REQUIRED]
An object that includes the template bundle S3 bucket path and name for the new version of a service template.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: s3.
s3 (dict) --
An S3 source object that includes the template bundle S3 path and name for a template minor version.
bucket (string) -- [REQUIRED]
The name of the S3 bucket that contains a template bundle.
key (string) -- [REQUIRED]
The path to the S3 bucket that contains a template bundle.
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 Administrator Guide .
(string) --
list
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 Administrator Guide or Proton User Guide.
(dict) --
A description of a resource tag.
key (string) -- [REQUIRED]
The key of the resource tag.
value (string) -- [REQUIRED]
The value of the resource tag.
string
[REQUIRED]
The 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 Administrator Guide .
(string) --
templateName (string) --
The name of the version of a service template.
{'environment': {'componentRoleArn': 'string'}}
Delete an environment.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
name='string'
)
string
[REQUIRED]
The name of the environment to delete.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'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 detailed data of the environment being deleted.
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 Administrator 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 infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
arn (string) --
The Amazon Resource Name (ARN) of the repository branch.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The 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.
{'environmentAccountConnection': {'componentRoleArn': 'string'}}
In an environment account, delete an environment account connection.
After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.
For more information, see Environment account connections in the Proton Administrator guide .
See also: AWS API Documentation
Request Syntax
client.delete_environment_account_connection(
id='string'
)
string
[REQUIRED]
The ID of the environment account connection to delete.
dict
Response Syntax
{
'environmentAccountConnection': {
'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'
}
}
Response Structure
(dict) --
environmentAccountConnection (dict) --
The detailed data of the environment account connection being deleted.
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 Administrator 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.
{'serviceTemplateVersion': {'supportedComponentSources': ['DIRECTLY_DEFINED']}}
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
client.delete_service_template_version(
majorVersion='string',
minorVersion='string',
templateName='string'
)
string
[REQUIRED]
The service template major version to delete.
string
[REQUIRED]
The service template minor version to delete.
string
[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 Administrator Guide .
(string) --
templateName (string) --
The name of the version of a service template.
{'environment': {'componentRoleArn': 'string'}}
Get detailed data for an environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
name='string'
)
string
[REQUIRED]
The name of the environment that you want to get the detailed data for.
dict
Response Syntax
{
'environment': {
'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',
'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 detailed data of the requested environment.
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 Administrator 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 infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
arn (string) --
The Amazon Resource Name (ARN) of the repository branch.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The 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.
{'environmentAccountConnection': {'componentRoleArn': 'string'}}
In an environment account, get the detailed data for an environment account connection.
For more information, see Environment account connections in the Proton Administrator guide .
See also: AWS API Documentation
Request Syntax
client.get_environment_account_connection(
id='string'
)
string
[REQUIRED]
The ID of the environment account connection that you want to get the detailed data for.
dict
Response Syntax
{
'environmentAccountConnection': {
'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'
}
}
Response Structure
(dict) --
environmentAccountConnection (dict) --
The detailed data of the requested environment account connection.
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 Administrator 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.
{'serviceTemplateVersion': {'supportedComponentSources': ['DIRECTLY_DEFINED']}}
Get detailed data for a major or minor version of a service template.
See also: AWS API Documentation
Request Syntax
client.get_service_template_version(
majorVersion='string',
minorVersion='string',
templateName='string'
)
string
[REQUIRED]
To get service template major version detail data, include major Version .
string
[REQUIRED]
To get service template minor version detail data, include minorVersion .
string
[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 Administrator Guide .
(string) --
templateName (string) --
The name of the version of a service template.
{'environmentAccountConnections': {'componentRoleArn': 'string'}}
View a list of environment account connections.
For more information, see Environment account connections in the Proton Administrator guide .
See also: AWS API Documentation
Request Syntax
client.list_environment_account_connections(
environmentName='string',
maxResults=123,
nextToken='string',
requestedBy='MANAGEMENT_ACCOUNT'|'ENVIRONMENT_ACCOUNT',
statuses=[
'PENDING'|'CONNECTED'|'REJECTED',
]
)
string
The environment name that's associated with each listed environment account connection.
integer
The maximum number of environment account connections to list.
string
A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
string
[REQUIRED]
The type of account making the ListEnvironmentAccountConnections request.
list
The status details for each listed environment account connection.
(string) --
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 Administrator 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.
{'environments': {'componentRoleArn': 'string'}}
List environments with detail data summaries.
See also: AWS API Documentation
Request Syntax
client.list_environments(
environmentTemplates=[
{
'majorVersion': 'string',
'templateName': 'string'
},
],
maxResults=123,
nextToken='string'
)
list
An array of the versions of the environment template.
(dict) --
A search filter for environment templates.
majorVersion (string) -- [REQUIRED]
Include majorVersion to filter search for a major version.
templateName (string) -- [REQUIRED]
Include templateName to filter search for a template name.
integer
The maximum number of environments to list.
string
A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.
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 Administrator 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.
{'environmentAccountConnection': {'componentRoleArn': 'string'}}
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 Administrator guide .
See also: AWS API Documentation
Request Syntax
client.reject_environment_account_connection(
id='string'
)
string
[REQUIRED]
The ID of the environment account connection to reject.
dict
Response Syntax
{
'environmentAccountConnection': {
'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'
}
}
Response Structure
(dict) --
environmentAccountConnection (dict) --
The environment connection account detail data that's returned by Proton.
arn (string) --
The Amazon Resource Name (ARN) of the environment account connection.
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 Administrator 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.
{'componentRoleArn': 'string'}
Response {'environment': {'componentRoleArn': 'string'}}
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 Administrator 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
client.update_environment(
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'
)
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 Administrator Guide .
string
[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).
string
A description of the environment update.
string
The ID of the environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
string
[REQUIRED]
The name of the environment to update.
string
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
dict
The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
branch (string) -- [REQUIRED]
The repository branch.
name (string) -- [REQUIRED]
The repository name.
provider (string) -- [REQUIRED]
The repository provider.
string
The formatted specification that defines the update.
string
The major version of the environment to update.
string
The minor version of the environment to update.
dict
Response Syntax
{
'environment': {
'arn': 'string',
'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.
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 Administrator 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 infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
arn (string) --
The Amazon Resource Name (ARN) of the repository branch.
branch (string) --
The repository branch.
name (string) --
The repository name.
provider (string) --
The repository provider.
spec (string) --
The environment spec.
templateMajorVersion (string) --
The 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.
{'componentRoleArn': 'string'}
Response {'environmentAccountConnection': {'componentRoleArn': 'string'}}
In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton Administrator guide .
See also: AWS API Documentation
Request Syntax
client.update_environment_account_connection(
componentRoleArn='string',
id='string',
roleArn='string'
)
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 Administrator Guide .
string
[REQUIRED]
The ID of the environment account connection to update.
string
The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.
dict
Response Syntax
{
'environmentAccountConnection': {
'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'
}
}
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.
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 Administrator 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.
{'supportedComponentSources': ['DIRECTLY_DEFINED']}
Response {'serviceTemplateVersion': {'supportedComponentSources': ['DIRECTLY_DEFINED']}}
Update a major or minor version of a service template.
See also: AWS API Documentation
Request Syntax
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'
)
list
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.
(dict) --
Compatible environment template data.
majorVersion (string) -- [REQUIRED]
The major version of the compatible environment template.
templateName (string) -- [REQUIRED]
The compatible environment template name.
string
A description of a service template version to update.
string
[REQUIRED]
To update a major version of a service template, include major Version .
string
[REQUIRED]
To update a minor version of a service template, include minorVersion .
string
The status of the service template minor version to update.
list
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 Administrator Guide .
(string) --
string
[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 Administrator Guide .
(string) --
templateName (string) --
The name of the version of a service template.