AWS.Proton (aws-elixir v0.8.0) View Source

This is the AWS Proton Service API Reference.

It provides descriptions, syntax and usage examples for each of the actions and data types for the AWS Proton service.

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

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

The AWS 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 AWS Proton deploys and manages, they need permissions to use all of the listed API operations.

When developers select a specific infrastructure and tooling set, AWS Proton deploys their applications. To monitor their applications that are running on AWS 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 AWS Proton administration, see the AWS Proton Administration Guide.

To learn more about deploying serverless and containerized applications on AWS Proton, see the AWS 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 AWS CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.

Given a request action that has succeeded:

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

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

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

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

Idempotent create APIs with a client token:

  • CreateEnvironmentTemplateVersion

  • CreateServiceTemplateVersion

  • CreateEnvironmentAccountConnection

## Idempotent delete APIs Given a request action that has succeeded: When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response. If you retry and the resource doesn't exist, the response is empty. In both cases, the retry succeeds. Idempotent delete APIs: * DeleteEnvironmentTemplate * DeleteEnvironmentTemplateVersion * DeleteServiceTemplate * DeleteServiceTemplateVersion * DeleteEnvironmentAccountConnection ## Asynchronous idempotent delete APIs Given a request action that has succeeded: If you retry the request with an API from this group, if the original request delete operation status isDELETE_IN_PROGRESS, the retry returns the resource detail data in the response without performing any further actions. If the original request delete operation is complete, a retry returns an empty response. Asynchronous idempotent delete APIs: * DeleteEnvironment * DeleteService

Link to this section Summary

Functions

In a management account, an environment account connection request is accepted.

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS.

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS.

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS.

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from the management account.

Create an environment template for AWS Proton.

Create a new major or minor version of an environment template.

Create an AWS Proton service.

Create a new major or minor version of a service template.

In an environment account, delete an environment account connection.

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

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.

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

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.

Get detail data for the AWS Proton pipeline service role.

Get detail data for an environment.

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

Get detail data for an environment template.

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

Get detail data for a service.

Get detail data for a service instance.

Get detail data for a service template.

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

View a list of environment account connections.

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

List environments with detail data summaries.

List service instances with summaries of detail data.

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

List service templates with detail data.

List services with summaries of detail data.

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

Remove a tag from a resource.

Update the AWS Proton pipeline service account settings.

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

Update a major or minor version of an environment template.

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

Update a major or minor version of a service template.

Link to this section Functions

Link to this function

accept_environment_account_connection(client, input, options \\ [])

View Source

In a management account, an environment account connection request is accepted.

When the environment account connection request is accepted, AWS 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 AWS Proton Administration guide.

Link to this function

cancel_environment_deployment(client, input, options \\ [])

View Source

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 AWS Proton Administration 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.

Link to this function

cancel_service_instance_deployment(client, input, options \\ [])

View Source

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 AWS Proton Administration guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

  • If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

  • If the cancellation attempt fails, the resulting deployment state is FAILED.

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

Link to this function

cancel_service_pipeline_deployment(client, input, options \\ [])

View Source

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 AWS Proton Administration guide or the AWS Proton User guide.

The following list includes potential cancellation scenarios.

  • If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.

  • If the cancellation attempt fails, the resulting deployment state is FAILED.

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

Link to this function

create_environment(client, input, options \\ [])

View Source

Deploy a new environment.

An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the Environments in the AWS Proton Administration Guide.

Link to this function

create_environment_account_connection(client, input, options \\ [])

View Source

Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from the 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 AWS Proton Administration guide.

Link to this function

create_environment_template(client, input, options \\ [])

View Source

Create an environment template for AWS Proton.

For more information, see Environment Templates in the AWS Proton Administration Guide.

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

  • Register and publish a standard environment template that instructs AWS Proton to deploy and manage environment infrastructure.

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

Link to this function

create_environment_template_version(client, input, options \\ [])

View Source

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.

Link to this function

create_service(client, input, options \\ [])

View Source

Create an AWS Proton service.

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

Link to this function

create_service_template(client, input, options \\ [])

View Source

Create a service template.

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

Link to this function

create_service_template_version(client, input, options \\ [])

View Source

Create a new major or minor version of a service template.

A major version of a service template is a version that isn't backwards compatible. A minor version of a service template is a version that's backwards compatible within its major version.

Link to this function

delete_environment(client, input, options \\ [])

View Source

Delete an environment.

Link to this function

delete_environment_account_connection(client, input, options \\ [])

View Source

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an AWS Proton environment, AWS 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 AWS Proton Administration guide.

Link to this function

delete_environment_template(client, input, options \\ [])

View Source

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

Link to this function

delete_environment_template_version(client, input, options \\ [])

View Source

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 backwards 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 backwards compatible.

Link to this function

delete_service(client, input, options \\ [])

View Source

Delete a service.

Link to this function

delete_service_template(client, input, options \\ [])

View Source

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

Link to this function

delete_service_template_version(client, input, options \\ [])

View Source

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.

Link to this function

get_account_settings(client, input, options \\ [])

View Source

Get detail data for the AWS Proton pipeline service role.

Link to this function

get_environment(client, input, options \\ [])

View Source

Get detail data for an environment.

Link to this function

get_environment_account_connection(client, input, options \\ [])

View Source

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

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

Link to this function

get_environment_template(client, input, options \\ [])

View Source

Get detail data for an environment template.

Link to this function

get_environment_template_version(client, input, options \\ [])

View Source

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

Link to this function

get_service(client, input, options \\ [])

View Source

Get detail data for a service.

Link to this function

get_service_instance(client, input, options \\ [])

View Source

Get detail data for a service instance.

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

Link to this function

get_service_template(client, input, options \\ [])

View Source

Get detail data for a service template.

Link to this function

get_service_template_version(client, input, options \\ [])

View Source

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

Link to this function

list_environment_account_connections(client, input, options \\ [])

View Source

View a list of environment account connections.

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

Link to this function

list_environment_template_versions(client, input, options \\ [])

View Source

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

Link to this function

list_environment_templates(client, input, options \\ [])

View Source

List environment templates.

Link to this function

list_environments(client, input, options \\ [])

View Source

List environments with detail data summaries.

Link to this function

list_service_instances(client, input, options \\ [])

View Source

List service instances with summaries of detail data.

Link to this function

list_service_template_versions(client, input, options \\ [])

View Source

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

Link to this function

list_service_templates(client, input, options \\ [])

View Source

List service templates with detail data.

Link to this function

list_services(client, input, options \\ [])

View Source

List services with summaries of detail data.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

List tags for a resource.

For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

Link to this function

reject_environment_account_connection(client, input, options \\ [])

View Source

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

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

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

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Tag a resource.

For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Remove a tag from a resource.

For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

Link to this function

update_account_settings(client, input, options \\ [])

View Source

Update the AWS Proton pipeline service account settings.

Link to this function

update_environment(client, input, options \\ [])

View Source

Update an environment.

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

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

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

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

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

Definitions

###

NONE

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

###

CURRENT_VERSION

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

###

MINOR_VERSION

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

###

MAJOR_VERSION

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

Link to this function

update_environment_account_connection(client, input, options \\ [])

View Source

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

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

Link to this function

update_environment_template(client, input, options \\ [])

View Source

Update an environment template.

Link to this function

update_environment_template_version(client, input, options \\ [])

View Source

Update a major or minor version of an environment template.

Link to this function

update_service(client, input, options \\ [])

View Source

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

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.

Link to this function

update_service_instance(client, input, options \\ [])

View Source

Update a service instance.

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

Definitions

###

NONE

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

###

CURRENT_VERSION

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

###

MINOR_VERSION

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

###

MAJOR_VERSION

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

Link to this function

update_service_pipeline(client, input, options \\ [])

View Source

Update the service pipeline.

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

Definitions

###

NONE

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

###

CURRENT_VERSION

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

###

MINOR_VERSION

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

###

MAJOR_VERSION

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

Link to this function

update_service_template(client, input, options \\ [])

View Source

Update a service template.

Link to this function

update_service_template_version(client, input, options \\ [])

View Source

Update a major or minor version of a service template.