proton {paws}

AWS Proton

Description

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

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

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

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

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

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

To learn more about Proton, see the Proton User Guide.

Ensuring Idempotency

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

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

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

Idempotent create APIs with a client token

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

Given a request action that has succeeded:

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

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

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

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

Idempotent create APIs with a client token:

• CreateEnvironmentTemplateVersion

• CreateServiceTemplateVersion

• CreateEnvironmentAccountConnection

Idempotent create APIs

Given a request action that has succeeded:

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

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

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

Idempotent create APIs:

• CreateEnvironmentTemplate

• CreateServiceTemplate

• CreateEnvironment

• CreateService

Idempotent delete APIs

Given a request action that has succeeded:

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

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

In both cases, the retry succeeds.

Idempotent delete APIs:

• DeleteEnvironmentTemplate

• DeleteEnvironmentTemplateVersion

• DeleteServiceTemplate

• DeleteServiceTemplateVersion

• DeleteEnvironmentAccountConnection

Asynchronous idempotent delete APIs

Given a request action that has succeeded:

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

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

Asynchronous idempotent delete APIs:

• DeleteEnvironment

• DeleteService

Usage

proton(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- proton(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

accept_environment_account_connection	In a management account, an environment account connection request is accepted
cancel_component_deployment	Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status)
cancel_environment_deployment	Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS
cancel_service_instance_deployment	Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS
cancel_service_pipeline_deployment	Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS
create_component	Create an Proton component
create_environment	Deploy a new environment
create_environment_account_connection	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
create_environment_template	Create an environment template for Proton
create_environment_template_version	Create a new major or minor version of an environment template
create_repository	Create and register a link to a repository
create_service	Create an Proton service
create_service_instance	Create a service instance
create_service_sync_config	Create the Proton Ops configuration file
create_service_template	Create a service template
create_service_template_version	Create a new major or minor version of a service template
create_template_sync_config	Set up a template to create new template versions automatically by tracking a linked repository
delete_component	Delete an Proton component resource
delete_deployment	Delete the deployment
delete_environment	Delete an environment
delete_environment_account_connection	In an environment account, delete an environment account connection
delete_environment_template	If no other major or minor versions of an environment template exist, delete the environment template
delete_environment_template_version	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_repository	De-register and unlink your repository
delete_service	Delete a service, with its instances and pipeline
delete_service_sync_config	Delete the Proton Ops file
delete_service_template	If no other major or minor versions of the service template exist, delete the service template
delete_service_template_version	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_template_sync_config	Delete a template sync configuration
get_account_settings	Get detail data for Proton account-wide settings
get_component	Get detailed data for a component
get_deployment	Get detailed data for a deployment
get_environment	Get detailed data for an environment
get_environment_account_connection	In an environment account, get the detailed data for an environment account connection
get_environment_template	Get detailed data for an environment template
get_environment_template_version	Get detailed data for a major or minor version of an environment template
get_repository	Get detail data for a linked repository
get_repository_sync_status	Get the sync status of a repository used for Proton template sync
get_resources_summary	Get counts of Proton resources
get_service	Get detailed data for a service
get_service_instance	Get detailed data for a service instance
get_service_instance_sync_status	Get the status of the synced service instance
get_service_sync_blocker_summary	Get detailed data for the service sync blocker summary
get_service_sync_config	Get detailed information for the service sync configuration
get_service_template	Get detailed data for a service template
get_service_template_version	Get detailed data for a major or minor version of a service template
get_template_sync_config	Get detail data for a template sync configuration
get_template_sync_status	Get the status of a template sync
list_component_outputs	Get a list of component Infrastructure as Code (IaC) outputs
list_component_provisioned_resources	List provisioned resources for a component with details
list_components	List components with summary data
list_deployments	List deployments
list_environment_account_connections	View a list of environment account connections
list_environment_outputs	List the infrastructure as code outputs for your environment
list_environment_provisioned_resources	List the provisioned resources for your environment
list_environments	List environments with detail data summaries
list_environment_templates	List environment templates
list_environment_template_versions	List major or minor versions of an environment template with detail data
list_repositories	List linked repositories with detail data
list_repository_sync_definitions	List repository sync definitions with detail data
list_service_instance_outputs	Get a list service of instance Infrastructure as Code (IaC) outputs
list_service_instance_provisioned_resources	List provisioned resources for a service instance with details
list_service_instances	List service instances with summary data
list_service_pipeline_outputs	Get a list of service pipeline Infrastructure as Code (IaC) outputs
list_service_pipeline_provisioned_resources	List provisioned resources for a service and pipeline with details
list_services	List services with summaries of detail data
list_service_templates	List service templates with detail data
list_service_template_versions	List major or minor versions of a service template with detail data
list_tags_for_resource	List tags for a resource
notify_resource_deployment_status_change	Notify Proton of status changes to a provisioned resource when you use self-managed provisioning
reject_environment_account_connection	In a management account, reject an environment account connection from another environment account
tag_resource	Tag a resource
untag_resource	Remove a customer tag from a resource
update_account_settings	Update Proton settings that are used for multiple services in the Amazon Web Services account
update_component	Update a component
update_environment	Update an environment
update_environment_account_connection	In an environment account, update an environment account connection to use a new IAM role
update_environment_template	Update an environment template
update_environment_template_version	Update a major or minor version of an environment template
update_service	Edit a service description or use a spec to add and delete service instances
update_service_instance	Update a service instance
update_service_pipeline	Update the service pipeline
update_service_sync_blocker	Update the service sync blocker by resolving it
update_service_sync_config	Update the Proton Ops config file
update_service_template	Update a service template
update_service_template_version	Update a major or minor version of a service template
update_template_sync_config	Update template sync configuration parameters, except for the templateName and templateType

Examples

## Not run: 
svc <- proton()
svc$accept_environment_account_connection(
  Foo = 123
)

## End(Not run)