Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.Proton

Inherits:
AWS.Service show all
Identifier:
proton
API Version:
2020-07-20
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

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

Sending a Request Using Proton

var proton = new AWS.Proton();
proton.acceptEnvironmentAccountConnection(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Proton object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var proton = new AWS.Proton({apiVersion: '2020-07-20'});

You can also set the API version globally in AWS.config.apiVersions using the proton service identifier:

AWS.config.apiVersions = {
  proton: '2020-07-20',
  // other service API versions
};

var proton = new AWS.Proton();

Version:

  • 2020-07-20

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Proton(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Proton object

var proton = new AWS.Proton({apiVersion: '2020-07-20'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Proton.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Proton.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Proton.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the acceptEnvironmentAccountConnection operation

var params = {
  id: 'STRING_VALUE' /* required */
};
proton.acceptEnvironmentAccountConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the environment account connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnection — (map)

        The environment account connection data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

cancelEnvironmentDeployment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the cancelEnvironmentDeployment operation

var params = {
  environmentName: 'STRING_VALUE' /* required */
};
proton.cancelEnvironmentDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • environmentName — (String)

      The name of the environment with the deployment to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environment — (map)

        The environment summary data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment.

        • createdAtrequired — (Date)

          The time when the environment was created.

        • deploymentStatusrequired — (String)

          The environment deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • 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.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the environment was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the environment was last deployed successfully.

        • namerequired — (String)

          The name of the environment.

        • protonServiceRoleArn — (String)

          The ARN of the AWS Proton service role that allows AWS 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.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • spec — (String)

          The environment spec.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the environment template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the environment template.

        • templateNamerequired — (String)

          The ARN of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

cancelServiceInstanceDeployment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the cancelServiceInstanceDeployment operation

var params = {
  serviceInstanceName: 'STRING_VALUE', /* required */
  serviceName: 'STRING_VALUE' /* required */
};
proton.cancelServiceInstanceDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • serviceInstanceName — (String)

      The name of the service instance with the deployment to cancel.

    • serviceName — (String)

      The name of the service with the service instance deployment to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceInstance — (map)

        The service instance summary data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service instance.

        • createdAtrequired — (Date)

          The time when the service instance was created.

        • deploymentStatusrequired — (String)

          The service instance deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • deploymentStatusMessage — (String)

          A service instance deployment status message.

        • environmentNamerequired — (String)

          The name of the environment that the service instance was deployed into.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the service instance was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the service instance was last deployed successfully.

        • namerequired — (String)

          The name of the service instance.

        • serviceNamerequired — (String)

          The name of the service that the service instance belongs to.

        • spec — (String)

          The service spec that was used to create the service instance.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the service template that was used to create the service instance.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the service template that was used to create the service instance.

        • templateNamerequired — (String)

          The name of the service template that was used to create the service instance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

cancelServicePipelineDeployment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the cancelServicePipelineDeployment operation

var params = {
  serviceName: 'STRING_VALUE' /* required */
};
proton.cancelServicePipelineDeployment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • serviceName — (String)

      The name of the service with the service pipeline deployment to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipeline — (map)

        The service pipeline detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service pipeline.

        • createdAtrequired — (Date)

          The time when the service pipeline was created.

        • deploymentStatusrequired — (String)

          The deployment status of the service pipeline.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • deploymentStatusMessage — (String)

          A service pipeline deployment status message.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the service pipeline was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the service pipeline was last deployed successfully.

        • spec — (String)

          The service spec that was used to create the service pipeline.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the service template that was used to create the service pipeline.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the service template that was used to create the service pipeline.

        • templateNamerequired — (String)

          The name of the service template that was used to create the service pipeline.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEnvironment(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createEnvironment operation

var params = {
  name: 'STRING_VALUE', /* required */
  spec: 'STRING_VALUE', /* required */
  templateMajorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  environmentAccountConnectionId: 'STRING_VALUE',
  protonServiceRoleArn: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  templateMinorVersion: 'STRING_VALUE'
};
proton.createEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A description of the environment that's being created and deployed.

    • environmentAccountConnectionId — (String)

      The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. For more information, see Environment account connections in the AWS Proton Administration guide.

    • name — (String)

      The name of the environment.

    • protonServiceRoleArn — (String)

      The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId or protonServiceRoleArn parameter and value.

    • spec — (String)

      A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the AWS Proton Administration Guide.

    • tags — (Array<map>)

      Create tags for your environment. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

    • templateMajorVersion — (String)

      The ID of the major version of the environment template.

    • templateMinorVersion — (String)

      The ID of the minor version of the environment template.

    • templateName — (String)

      The name of the environment template. For more information, see Environment Templates in the AWS Proton Administration Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environment — (map)

        The environment detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment.

        • createdAtrequired — (Date)

          The time when the environment was created.

        • deploymentStatusrequired — (String)

          The environment deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • 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.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the environment was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the environment was last deployed successfully.

        • namerequired — (String)

          The name of the environment.

        • protonServiceRoleArn — (String)

          The ARN of the AWS Proton service role that allows AWS 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.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • spec — (String)

          The environment spec.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the environment template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the environment template.

        • templateNamerequired — (String)

          The ARN of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the createEnvironmentAccountConnection operation

var params = {
  environmentName: 'STRING_VALUE', /* required */
  managementAccountId: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
proton.createEnvironmentAccountConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      When included, if two identicial requests are made with the same client token, AWS Proton returns the environment account connection that the first request created.

      If a token is not provided, the SDK will use a version 4 UUID.
    • environmentName — (String)

      The name of the AWS Proton environment that's created in the associated management account.

    • managementAccountId — (String)

      The ID of the management account that accepts or rejects the environment account connection. You create an manage the AWS Proton environment in this account. If the management account accepts the environment account connection, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. AWS Proton uses this role to provision infrastructure resources in the associated environment account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnection — (map)

        The environment account connection detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createEnvironmentTemplate operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  encryptionKey: 'STRING_VALUE',
  provisioning: CUSTOMER_MANAGED,
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.createEnvironmentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A description of the environment template.

    • displayName — (String)

      The environment template name as displayed in the developer interface.

    • encryptionKey — (String)

      A customer provided encryption key that AWS Proton uses to encrypt data.

    • name — (String)

      The name of the environment template.

    • provisioning — (String)

      When included, indicates that the environment template is for customer provisioned and managed infrastructure.

      Possible values include:
      • "CUSTOMER_MANAGED"
    • tags — (Array<map>)

      Create tags for your environment template. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplate — (map)

        The environment template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment template.

        • createdAtrequired — (Date)

          The time when the environment template was created.

        • description — (String)

          A description of the environment template.

        • displayName — (String)

          The name of the environment template as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided encryption key for the environment template.

        • lastModifiedAtrequired — (Date)

          The time when the environment template was last modified.

        • namerequired — (String)

          The name of the environment template.

        • provisioning — (String)

          When included, indicates that the environment template is for customer provisioned and managed infrastructure.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the createEnvironmentTemplateVersion operation

var params = {
  source: { /* required */
    s3: {
      bucket: 'STRING_VALUE', /* required */
      key: 'STRING_VALUE' /* required */
    }
  },
  templateName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  majorVersion: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.createEnvironmentTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      When included, if two identicial requests are made with the same client token, AWS Proton returns the environment template version that the first request created.

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A description of the new version of an environment template.

    • majorVersion — (String)

      To create a new minor version of the environment template, include a majorVersion.

      To create a new major and minor version of the environment template, exclude majorVersion.

    • source — (map)

      An object that includes the template bundle S3 bucket path and name for the new version of an template.

      • s3 — (map)

        An S3 source object that includes the template bundle S3 path and name for a template minor version.

        • bucketrequired — (String)

          The name of the S3 bucket that contains a template bundle.

        • keyrequired — (String)

          The path to the S3 bucket that contains a template bundle.

    • tags — (Array<map>)

      Create tags for a new version of an environment template.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

    • templateName — (String)

      The name of the environment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplateVersion — (map)

        The environment template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of an environment template.

        • createdAtrequired — (Date)

          The time when the version of an environment template was created.

        • description — (String)

          A description of the minor version of an environment template.

        • lastModifiedAtrequired — (Date)

          The time when the version of an environment template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of an environment template.

        • minorVersionrequired — (String)

          The ID of the minor version of an environment template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the environment template.

        • schema — (String)

          The schema of the version of an environment template.

        • statusrequired — (String)

          The status of the version of an environment template.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          The status message of the version of an environment template.

        • templateNamerequired — (String)

          The name of the version of an environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createService(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createService operation

var params = {
  name: 'STRING_VALUE', /* required */
  spec: 'STRING_VALUE', /* required */
  templateMajorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE', /* required */
  branchName: 'STRING_VALUE',
  description: 'STRING_VALUE',
  repositoryConnectionArn: 'STRING_VALUE',
  repositoryId: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  templateMinorVersion: 'STRING_VALUE'
};
proton.createService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • branchName — (String)

      The name of the code repository branch that holds the code that's deployed in AWS Proton. Don't include this parameter if your service template doesn't include a service pipeline.

    • description — (String)

      A description of the AWS Proton service.

    • name — (String)

      The service name.

    • repositoryConnectionArn — (String)

      The ARN of the repository connection. For more information, see Set up repository connection in the AWS Proton Administration Guide and Getting started in the AWS Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.

    • repositoryId — (String)

      The ID of the code repository. Don't include this parameter if your service template doesn't include a service pipeline.

    • spec — (String)

      A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the AWS Proton Administration Guide and Create a service in the AWS Proton User Guide.

    • tags — (Array<map>)

      Create tags for your service. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

    • templateMajorVersion — (String)

      The ID of the major version of the service template that was used to create the service.

    • templateMinorVersion — (String)

      The ID of the minor version of the service template that was used to create the service.

    • templateName — (String)

      The name of the service template that's used to create the service.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • service — (map)

        The service detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service.

        • branchName — (String)

          The name of the code repository branch that holds the code that's deployed in AWS Proton.

        • createdAtrequired — (Date)

          The time when the service was created.

        • description — (String)

          A description of a service.

        • lastModifiedAtrequired — (Date)

          The time when the service was last modified.

        • namerequired — (String)

          The name of the service.

        • pipeline — (map)

          The service pipeline detail data.

          • arnrequired — (String)

            The Amazon Resource Name (ARN) of the service pipeline.

          • createdAtrequired — (Date)

            The time when the service pipeline was created.

          • deploymentStatusrequired — (String)

            The deployment status of the service pipeline.

            Possible values include:
            • "IN_PROGRESS"
            • "FAILED"
            • "SUCCEEDED"
            • "DELETE_IN_PROGRESS"
            • "DELETE_FAILED"
            • "DELETE_COMPLETE"
            • "CANCELLING"
            • "CANCELLED"
          • deploymentStatusMessage — (String)

            A service pipeline deployment status message.

          • lastDeploymentAttemptedAtrequired — (Date)

            The time when a deployment of the service pipeline was last attempted.

          • lastDeploymentSucceededAtrequired — (Date)

            The time when the service pipeline was last deployed successfully.

          • spec — (String)

            The service spec that was used to create the service pipeline.

          • templateMajorVersionrequired — (String)

            The ID of the major version of the service template that was used to create the service pipeline.

          • templateMinorVersionrequired — (String)

            The ID of the minor version of the service template that was used to create the service pipeline.

          • templateNamerequired — (String)

            The name of the service template that was used to create the service pipeline.

        • repositoryConnectionArn — (String)

          The ARN of the repository connection. For more information, see Set up a repository connection in the AWS Proton Administration Guide and Getting started in the AWS Proton User Guide.

        • repositoryId — (String)

          The ID of the code repository.

        • specrequired — (String)

          The formatted specification that defines the service.

        • statusrequired — (String)

          The status of the service.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_COMPLETE"
          • "CREATE_FAILED_CLEANUP_FAILED"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_COMPLETE"
          • "UPDATE_FAILED_CLEANUP_FAILED"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE_CLEANUP_FAILED"
        • statusMessage — (String)

          A service status message.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createServiceTemplate(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createServiceTemplate operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  encryptionKey: 'STRING_VALUE',
  pipelineProvisioning: CUSTOMER_MANAGED,
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.createServiceTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A description of the service template.

    • displayName — (String)

      The name of the service template as displayed in the developer interface.

    • encryptionKey — (String)

      A customer provided encryption key that's used to encrypt data.

    • name — (String)

      The name of the service template.

    • pipelineProvisioning — (String)

      AWS Proton includes a service pipeline for your service by default. When included, this parameter indicates that an AWS Proton service pipeline won't be included for your service. Once specified, this parameter can't be changed. For more information, see Service template bundles in the AWS Proton Administration Guide.

      Possible values include:
      • "CUSTOMER_MANAGED"
    • tags — (Array<map>)

      Create tags for your service template. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide or AWS Proton User Guide.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplate — (map)

        The service template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service template.

        • createdAtrequired — (Date)

          The time when the service template was created.

        • description — (String)

          A description of the service template.

        • displayName — (String)

          The service template name as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided service template encryption key that's used to encrypt data.

        • lastModifiedAtrequired — (Date)

          The time when the service template was last modified.

        • namerequired — (String)

          The name of the service template.

        • pipelineProvisioning — (String)

          If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createServiceTemplateVersion operation

var params = {
  compatibleEnvironmentTemplates: [ /* required */
    {
      majorVersion: 'STRING_VALUE', /* required */
      templateName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  source: { /* required */
    s3: {
      bucket: 'STRING_VALUE', /* required */
      key: 'STRING_VALUE' /* required */
    }
  },
  templateName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  majorVersion: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.createServiceTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

      When included, if two identicial requests are made with the same client token, AWS Proton returns the service template version that the first request created.

      If a token is not provided, the SDK will use a version 4 UUID.
    • compatibleEnvironmentTemplates — (Array<map>)

      An array of compatible environment template objects for the new version of a service template.

      • majorVersionrequired — (String)

        The major version of the compatible environment template.

      • templateNamerequired — (String)

        The compatible environment template name.

    • description — (String)

      A description of the new version of a service template.

    • majorVersion — (String)

      To create a new minor version of the service template, include a majorVersion.

      To create a new major and minor version of the service template, exclude majorVersion.

    • source — (map)

      An object that includes the template bundle S3 bucket path and name for the new version of a service template.

      • s3 — (map)

        An S3 source object that includes the template bundle S3 path and name for a template minor version.

        • bucketrequired — (String)

          The name of the S3 bucket that contains a template bundle.

        • keyrequired — (String)

          The path to the S3 bucket that contains a template bundle.

    • tags — (Array<map>)

      Create tags for a new version of a service template.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

    • templateName — (String)

      The name of the service template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplateVersion — (map)

        The service template version summary of detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of a service template.

        • compatibleEnvironmentTemplatesrequired — (Array<map>)

          An array of compatible environment template names for the major version of a service template.

          • majorVersionrequired — (String)

            The major version of the compatible environment template.

          • templateNamerequired — (String)

            The compatible environment template name.

        • createdAtrequired — (Date)

          The time when the version of a service template was created.

        • description — (String)

          A description of the version of a service template.

        • lastModifiedAtrequired — (Date)

          The time when the version of a service template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of a service template.

        • minorVersionrequired — (String)

          The ID of the minor version of a service template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the service template.

        • schema — (String)

          The schema of the version of a service template.

        • statusrequired — (String)

          The service template version status.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          A service template version status message.

        • templateNamerequired — (String)

          The name of the version of a service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

Delete an environment.

Service Reference:

Examples:

Calling the deleteEnvironment operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.deleteEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the environment to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environment — (map)

        The environment detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment.

        • createdAtrequired — (Date)

          The time when the environment was created.

        • deploymentStatusrequired — (String)

          The environment deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • 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.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the environment was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the environment was last deployed successfully.

        • namerequired — (String)

          The name of the environment.

        • protonServiceRoleArn — (String)

          The ARN of the AWS Proton service role that allows AWS 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.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • spec — (String)

          The environment spec.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the environment template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the environment template.

        • templateNamerequired — (String)

          The ARN of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the deleteEnvironmentAccountConnection operation

var params = {
  id: 'STRING_VALUE' /* required */
};
proton.deleteEnvironmentAccountConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the environment account connection to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnection — (map)

        The environment account connection detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteEnvironmentTemplate operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.deleteEnvironmentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the environment template to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplate — (map)

        The environment template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment template.

        • createdAtrequired — (Date)

          The time when the environment template was created.

        • description — (String)

          A description of the environment template.

        • displayName — (String)

          The name of the environment template as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided encryption key for the environment template.

        • lastModifiedAtrequired — (Date)

          The time when the environment template was last modified.

        • namerequired — (String)

          The name of the environment template.

        • provisioning — (String)

          When included, indicates that the environment template is for customer provisioned and managed infrastructure.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the deleteEnvironmentTemplateVersion operation

var params = {
  majorVersion: 'STRING_VALUE', /* required */
  minorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE' /* required */
};
proton.deleteEnvironmentTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • majorVersion — (String)

      The environment template major version to delete.

    • minorVersion — (String)

      The environment template minor version to delete.

    • templateName — (String)

      The name of the environment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplateVersion — (map)

        The environment template version detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of an environment template.

        • createdAtrequired — (Date)

          The time when the version of an environment template was created.

        • description — (String)

          A description of the minor version of an environment template.

        • lastModifiedAtrequired — (Date)

          The time when the version of an environment template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of an environment template.

        • minorVersionrequired — (String)

          The ID of the minor version of an environment template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the environment template.

        • schema — (String)

          The schema of the version of an environment template.

        • statusrequired — (String)

          The status of the version of an environment template.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          The status message of the version of an environment template.

        • templateNamerequired — (String)

          The name of the version of an environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteService(params = {}, callback) ⇒ AWS.Request

Delete a service.

Service Reference:

Examples:

Calling the deleteService operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.deleteService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the service to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • service — (map)

        The service detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service.

        • branchName — (String)

          The name of the code repository branch that holds the code that's deployed in AWS Proton.

        • createdAtrequired — (Date)

          The time when the service was created.

        • description — (String)

          A description of a service.

        • lastModifiedAtrequired — (Date)

          The time when the service was last modified.

        • namerequired — (String)

          The name of the service.

        • pipeline — (map)

          The service pipeline detail data.

          • arnrequired — (String)

            The Amazon Resource Name (ARN) of the service pipeline.

          • createdAtrequired — (Date)

            The time when the service pipeline was created.

          • deploymentStatusrequired — (String)

            The deployment status of the service pipeline.

            Possible values include:
            • "IN_PROGRESS"
            • "FAILED"
            • "SUCCEEDED"
            • "DELETE_IN_PROGRESS"
            • "DELETE_FAILED"
            • "DELETE_COMPLETE"
            • "CANCELLING"
            • "CANCELLED"
          • deploymentStatusMessage — (String)

            A service pipeline deployment status message.

          • lastDeploymentAttemptedAtrequired — (Date)

            The time when a deployment of the service pipeline was last attempted.

          • lastDeploymentSucceededAtrequired — (Date)

            The time when the service pipeline was last deployed successfully.

          • spec — (String)

            The service spec that was used to create the service pipeline.

          • templateMajorVersionrequired — (String)

            The ID of the major version of the service template that was used to create the service pipeline.

          • templateMinorVersionrequired — (String)

            The ID of the minor version of the service template that was used to create the service pipeline.

          • templateNamerequired — (String)

            The name of the service template that was used to create the service pipeline.

        • repositoryConnectionArn — (String)

          The ARN of the repository connection. For more information, see Set up a repository connection in the AWS Proton Administration Guide and Getting started in the AWS Proton User Guide.

        • repositoryId — (String)

          The ID of the code repository.

        • specrequired — (String)

          The formatted specification that defines the service.

        • statusrequired — (String)

          The status of the service.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_COMPLETE"
          • "CREATE_FAILED_CLEANUP_FAILED"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_COMPLETE"
          • "UPDATE_FAILED_CLEANUP_FAILED"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE_CLEANUP_FAILED"
        • statusMessage — (String)

          A service status message.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteServiceTemplate(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteServiceTemplate operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.deleteServiceTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the service template to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplate — (map)

        The service template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service template.

        • createdAtrequired — (Date)

          The time when the service template was created.

        • description — (String)

          A description of the service template.

        • displayName — (String)

          The service template name as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided service template encryption key that's used to encrypt data.

        • lastModifiedAtrequired — (Date)

          The time when the service template was last modified.

        • namerequired — (String)

          The name of the service template.

        • pipelineProvisioning — (String)

          If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteServiceTemplateVersion operation

var params = {
  majorVersion: 'STRING_VALUE', /* required */
  minorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE' /* required */
};
proton.deleteServiceTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • majorVersion — (String)

      The service template major version to delete.

    • minorVersion — (String)

      The service template minor version to delete.

    • templateName — (String)

      The name of the service template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplateVersion — (map)

        The service template version detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of a service template.

        • compatibleEnvironmentTemplatesrequired — (Array<map>)

          An array of compatible environment template names for the major version of a service template.

          • majorVersionrequired — (String)

            The major version of the compatible environment template.

          • templateNamerequired — (String)

            The compatible environment template name.

        • createdAtrequired — (Date)

          The time when the version of a service template was created.

        • description — (String)

          A description of the version of a service template.

        • lastModifiedAtrequired — (Date)

          The time when the version of a service template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of a service template.

        • minorVersionrequired — (String)

          The ID of the minor version of a service template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the service template.

        • schema — (String)

          The schema of the version of a service template.

        • statusrequired — (String)

          The service template version status.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          A service template version status message.

        • templateNamerequired — (String)

          The name of the version of a service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccountSettings(params = {}, callback) ⇒ AWS.Request

Get detail data for the AWS Proton pipeline service role.

Service Reference:

Examples:

Calling the getAccountSettings operation

var params = {
};
proton.getAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountSettings — (map)

        The AWS Proton pipeline service role detail data that's returned by AWS Proton.

        • pipelineServiceRoleArn — (String)

          The Amazon Resource Name (ARN) of the AWS Proton pipeline service role.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnvironment(params = {}, callback) ⇒ AWS.Request

Get detail data for an environment.

Service Reference:

Examples:

Calling the getEnvironment operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.getEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the environment that you want to get the detail data for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environment — (map)

        The environment detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment.

        • createdAtrequired — (Date)

          The time when the environment was created.

        • deploymentStatusrequired — (String)

          The environment deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • 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.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the environment was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the environment was last deployed successfully.

        • namerequired — (String)

          The name of the environment.

        • protonServiceRoleArn — (String)

          The ARN of the AWS Proton service role that allows AWS 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.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • spec — (String)

          The environment spec.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the environment template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the environment template.

        • templateNamerequired — (String)

          The ARN of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getEnvironmentAccountConnection operation

var params = {
  id: 'STRING_VALUE' /* required */
};
proton.getEnvironmentAccountConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the environment account connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnection — (map)

        The environment account connection detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

Get detail data for an environment template.

Service Reference:

Examples:

Calling the getEnvironmentTemplate operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.getEnvironmentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the environment template that you want to get the detail data for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplate — (map)

        The environment template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment template.

        • createdAtrequired — (Date)

          The time when the environment template was created.

        • description — (String)

          A description of the environment template.

        • displayName — (String)

          The name of the environment template as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided encryption key for the environment template.

        • lastModifiedAtrequired — (Date)

          The time when the environment template was last modified.

        • namerequired — (String)

          The name of the environment template.

        • provisioning — (String)

          When included, indicates that the environment template is for customer provisioned and managed infrastructure.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getEnvironmentTemplateVersion operation

var params = {
  majorVersion: 'STRING_VALUE', /* required */
  minorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE' /* required */
};
proton.getEnvironmentTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • majorVersion — (String)

      To view environment template major version detail data, include majorVersion.

    • minorVersion — (String)

      To view environment template minor version detail data, include minorVersion.

    • templateName — (String)

      The name of the environment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplateVersion — (map)

        The environment template version detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of an environment template.

        • createdAtrequired — (Date)

          The time when the version of an environment template was created.

        • description — (String)

          A description of the minor version of an environment template.

        • lastModifiedAtrequired — (Date)

          The time when the version of an environment template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of an environment template.

        • minorVersionrequired — (String)

          The ID of the minor version of an environment template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the environment template.

        • schema — (String)

          The schema of the version of an environment template.

        • statusrequired — (String)

          The status of the version of an environment template.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          The status message of the version of an environment template.

        • templateNamerequired — (String)

          The name of the version of an environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getService(params = {}, callback) ⇒ AWS.Request

Get detail data for a service.

Service Reference:

Examples:

Calling the getService operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.getService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the service that you want to get the detail data for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • service — (map)

        The service detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service.

        • branchName — (String)

          The name of the code repository branch that holds the code that's deployed in AWS Proton.

        • createdAtrequired — (Date)

          The time when the service was created.

        • description — (String)

          A description of a service.

        • lastModifiedAtrequired — (Date)

          The time when the service was last modified.

        • namerequired — (String)

          The name of the service.

        • pipeline — (map)

          The service pipeline detail data.

          • arnrequired — (String)

            The Amazon Resource Name (ARN) of the service pipeline.

          • createdAtrequired — (Date)

            The time when the service pipeline was created.

          • deploymentStatusrequired — (String)

            The deployment status of the service pipeline.

            Possible values include:
            • "IN_PROGRESS"
            • "FAILED"
            • "SUCCEEDED"
            • "DELETE_IN_PROGRESS"
            • "DELETE_FAILED"
            • "DELETE_COMPLETE"
            • "CANCELLING"
            • "CANCELLED"
          • deploymentStatusMessage — (String)

            A service pipeline deployment status message.

          • lastDeploymentAttemptedAtrequired — (Date)

            The time when a deployment of the service pipeline was last attempted.

          • lastDeploymentSucceededAtrequired — (Date)

            The time when the service pipeline was last deployed successfully.

          • spec — (String)

            The service spec that was used to create the service pipeline.

          • templateMajorVersionrequired — (String)

            The ID of the major version of the service template that was used to create the service pipeline.

          • templateMinorVersionrequired — (String)

            The ID of the minor version of the service template that was used to create the service pipeline.

          • templateNamerequired — (String)

            The name of the service template that was used to create the service pipeline.

        • repositoryConnectionArn — (String)

          The ARN of the repository connection. For more information, see Set up a repository connection in the AWS Proton Administration Guide and Getting started in the AWS Proton User Guide.

        • repositoryId — (String)

          The ID of the code repository.

        • specrequired — (String)

          The formatted specification that defines the service.

        • statusrequired — (String)

          The status of the service.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_COMPLETE"
          • "CREATE_FAILED_CLEANUP_FAILED"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_COMPLETE"
          • "UPDATE_FAILED_CLEANUP_FAILED"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE_CLEANUP_FAILED"
        • statusMessage — (String)

          A service status message.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServiceInstance(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getServiceInstance operation

var params = {
  name: 'STRING_VALUE', /* required */
  serviceName: 'STRING_VALUE' /* required */
};
proton.getServiceInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of a service instance that you want to get the detail data for.

    • serviceName — (String)

      The name of the service that the service instance belongs to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceInstance — (map)

        The service instance detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service instance.

        • createdAtrequired — (Date)

          The time when the service instance was created.

        • deploymentStatusrequired — (String)

          The service instance deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • deploymentStatusMessage — (String)

          A service instance deployment status message.

        • environmentNamerequired — (String)

          The name of the environment that the service instance was deployed into.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the service instance was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the service instance was last deployed successfully.

        • namerequired — (String)

          The name of the service instance.

        • serviceNamerequired — (String)

          The name of the service that the service instance belongs to.

        • spec — (String)

          The service spec that was used to create the service instance.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the service template that was used to create the service instance.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the service template that was used to create the service instance.

        • templateNamerequired — (String)

          The name of the service template that was used to create the service instance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServiceTemplate(params = {}, callback) ⇒ AWS.Request

Get detail data for a service template.

Service Reference:

Examples:

Calling the getServiceTemplate operation

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.getServiceTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the service template that you want to get detail data for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplate — (map)

        The service template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service template.

        • createdAtrequired — (Date)

          The time when the service template was created.

        • description — (String)

          A description of the service template.

        • displayName — (String)

          The service template name as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided service template encryption key that's used to encrypt data.

        • lastModifiedAtrequired — (Date)

          The time when the service template was last modified.

        • namerequired — (String)

          The name of the service template.

        • pipelineProvisioning — (String)

          If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getServiceTemplateVersion operation

var params = {
  majorVersion: 'STRING_VALUE', /* required */
  minorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE' /* required */
};
proton.getServiceTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • majorVersion — (String)

      To view service template major version detail data, include majorVersion.

    • minorVersion — (String)

      To view service template minor version detail data, include minorVersion.

    • templateName — (String)

      The name of the service template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplateVersion — (map)

        The service template version detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of a service template.

        • compatibleEnvironmentTemplatesrequired — (Array<map>)

          An array of compatible environment template names for the major version of a service template.

          • majorVersionrequired — (String)

            The major version of the compatible environment template.

          • templateNamerequired — (String)

            The compatible environment template name.

        • createdAtrequired — (Date)

          The time when the version of a service template was created.

        • description — (String)

          A description of the version of a service template.

        • lastModifiedAtrequired — (Date)

          The time when the version of a service template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of a service template.

        • minorVersionrequired — (String)

          The ID of the minor version of a service template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the service template.

        • schema — (String)

          The schema of the version of a service template.

        • statusrequired — (String)

          The service template version status.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          A service template version status message.

        • templateNamerequired — (String)

          The name of the version of a service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnvironmentAccountConnections(params = {}, callback) ⇒ AWS.Request

View a list of environment account connections.

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

Examples:

Calling the listEnvironmentAccountConnections operation

var params = {
  requestedBy: MANAGEMENT_ACCOUNT | ENVIRONMENT_ACCOUNT, /* required */
  environmentName: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  statuses: [
    PENDING | CONNECTED | REJECTED,
    /* more items */
  ]
};
proton.listEnvironmentAccountConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • environmentName — (String)

      The environment name that's associated with each listed environment account connection.

    • maxResults — (Integer)

      The maximum number of environment account connections to list.

    • nextToken — (String)

      A token to indicate 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.

    • requestedBy — (String)

      The type of account making the ListEnvironmentAccountConnections request.

      Possible values include:
      • "MANAGEMENT_ACCOUNT"
      • "ENVIRONMENT_ACCOUNT"
    • statuses — (Array<String>)

      The status details for each listed environment account connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnections — (Array<map>)

        An array of environment account connections with details that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The ID of the environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"
      • nextToken — (String)

        A token to indicate the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnvironments(params = {}, callback) ⇒ AWS.Request

List environments with detail data summaries.

Service Reference:

Examples:

Calling the listEnvironments operation

var params = {
  environmentTemplates: [
    {
      majorVersion: 'STRING_VALUE', /* required */
      templateName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • environmentTemplates — (Array<map>)

      An array of the versions of the environment template.

      • majorVersionrequired — (String)

        Include majorVersion to filter search for a major version.

      • templateNamerequired — (String)

        Include templateName to filter search for a template name.

    • maxResults — (Integer)

      The maximum number of environments to list.

    • nextToken — (String)

      A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environments — (Array<map>)

        An array of environment detail data summaries.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment.

        • createdAtrequired — (Date)

          The time when the environment was created.

        • deploymentStatusrequired — (String)

          The environment deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • 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.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the environment was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the environment was last deployed successfully.

        • namerequired — (String)

          The name of the environment.

        • protonServiceRoleArn — (String)

          The ARN of the AWS Proton service role that allows AWS 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.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • templateMajorVersionrequired — (String)

          The ID of the major version of the environment template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the environment template.

        • templateNamerequired — (String)

          The name of the environment template.

      • nextToken — (String)

        A token to indicate the location of the next environment in the array of environments, after the current requested list of environments.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnvironmentTemplates(params = {}, callback) ⇒ AWS.Request

List environment templates.

Service Reference:

Examples:

Calling the listEnvironmentTemplates operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listEnvironmentTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of environment templates to list.

    • nextToken — (String)

      A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next environment template in the array of environment templates, after the current requested list of environment templates.

      • templates — (Array<map>)

        An array of environment templates with detail data.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment template.

        • createdAtrequired — (Date)

          The time when the environment template was created.

        • description — (String)

          A description of the environment template.

        • displayName — (String)

          The name of the environment template as displayed in the developer interface.

        • lastModifiedAtrequired — (Date)

          The time when the environment template was last modified.

        • namerequired — (String)

          The name of the environment template.

        • provisioning — (String)

          When included, indicates that the environment template is for customer provisioned and managed infrastructure.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEnvironmentTemplateVersions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listEnvironmentTemplateVersions operation

var params = {
  templateName: 'STRING_VALUE', /* required */
  majorVersion: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listEnvironmentTemplateVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • majorVersion — (String)

      To view a list of minor of versions under a major version of an environment template, include majorVersion.

      To view a list of major versions of an environment template, exclude majorVersion.

    • maxResults — (Integer)

      The maximum number of major or minor versions of an environment template to list.

    • nextToken — (String)

      A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.

    • templateName — (String)

      The name of the environment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.

      • templateVersions — (Array<map>)

        An array of major or minor versions of an environment template detail data.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of an environment template.

        • createdAtrequired — (Date)

          The time when the version of an environment template was created.

        • description — (String)

          A description of the version of an environment template.

        • lastModifiedAtrequired — (Date)

          The time when the version of an environment template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of an environment template.

        • minorVersionrequired — (String)

          The ID of the version of an environment template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the environment template.

        • statusrequired — (String)

          The status of the version of an environment template.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          The status message of the version of an environment template.

        • templateNamerequired — (String)

          The name of the version of an environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listServiceInstances(params = {}, callback) ⇒ AWS.Request

List service instances with summaries of detail data.

Service Reference:

Examples:

Calling the listServiceInstances operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serviceName: 'STRING_VALUE'
};
proton.listServiceInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of service instances to list.

    • nextToken — (String)

      A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.

    • serviceName — (String)

      The name of the service that the service instance belongs to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next service instance in the array of service instances, after the current requested list of service instances.

      • serviceInstances — (Array<map>)

        An array of service instances with summaries of detail data.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service instance.

        • createdAtrequired — (Date)

          The time when the service instance was created.

        • deploymentStatusrequired — (String)

          The service instance deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • deploymentStatusMessage — (String)

          A service instance deployment status message.

        • environmentNamerequired — (String)

          The name of the environment that the service instance was deployed into.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the service was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the service was last deployed successfully.

        • namerequired — (String)

          The name of the service instance.

        • serviceNamerequired — (String)

          The name of the service that the service instance belongs to.

        • templateMajorVersionrequired — (String)

          The ID of the major version of a service template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of a service template.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listServices(params = {}, callback) ⇒ AWS.Request

List services with summaries of detail data.

Service Reference:

Examples:

Calling the listServices operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listServices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of services to list.

    • nextToken — (String)

      A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next service in the array of services, after the current requested list of services.

      • services — (Array<map>)

        An array of services with summaries of detail data.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service.

        • createdAtrequired — (Date)

          The time when the service was created.

        • description — (String)

          A description of the service.

        • lastModifiedAtrequired — (Date)

          The time when the service was last modified.

        • namerequired — (String)

          The name of the service.

        • statusrequired — (String)

          The status of the service.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_COMPLETE"
          • "CREATE_FAILED_CLEANUP_FAILED"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_COMPLETE"
          • "UPDATE_FAILED_CLEANUP_FAILED"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE_CLEANUP_FAILED"
        • statusMessage — (String)

          A service status message.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listServiceTemplates(params = {}, callback) ⇒ AWS.Request

List service templates with detail data.

Service Reference:

Examples:

Calling the listServiceTemplates operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listServiceTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of service templates to list.

    • nextToken — (String)

      A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next service template in the array of service templates, after the current requested list of service templates.

      • templates — (Array<map>)

        An array of service templates with detail data.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service template.

        • createdAtrequired — (Date)

          The time when the service template was created.

        • description — (String)

          A description of the service template.

        • displayName — (String)

          The service template name as displayed in the developer interface.

        • lastModifiedAtrequired — (Date)

          The time when the service template was last modified.

        • namerequired — (String)

          The name of the service template.

        • pipelineProvisioning — (String)

          If pipelineProvisioning is true, a service pipeline is included in the service template, otherwise a service pipeline isn't included in the service template.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listServiceTemplateVersions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listServiceTemplateVersions operation

var params = {
  templateName: 'STRING_VALUE', /* required */
  majorVersion: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listServiceTemplateVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • majorVersion — (String)

      To view a list of minor of versions under a major version of a service template, include majorVersion.

      To view a list of major versions of a service template, exclude majorVersion.

    • maxResults — (Integer)

      The maximum number of major or minor versions of a service template to list.

    • nextToken — (String)

      A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.

    • templateName — (String)

      The name of the service template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.

      • templateVersions — (Array<map>)

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

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of a service template.

        • createdAtrequired — (Date)

          The time when the version of a service template was created.

        • description — (String)

          A description of the version of a service template.

        • lastModifiedAtrequired — (Date)

          The time when the version of a service template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of a service template.

        • minorVersionrequired — (String)

          The ID of the minor version of a service template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the service template.

        • statusrequired — (String)

          The service template minor version status.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          A service template minor version status message.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
proton.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of tags to list.

    • nextToken — (String)

      A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.

    • resourceArn — (String)

      The ARN of the resource for the listed tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.

      • tags — (Array<map>)

        An array of resource tags with detail data.

        • keyrequired — (String)

          The key of the resource tag.

        • valuerequired — (String)

          The value of the resource tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

rejectEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the rejectEnvironmentAccountConnection operation

var params = {
  id: 'STRING_VALUE' /* required */
};
proton.rejectEnvironmentAccountConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the environment account connection to reject.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnection — (map)

        The environment connection account detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.

    • tags — (Array<map>)

      An array of resource tags to apply to a resource.

      • keyrequired — (String)

        The key of the resource tag.

      • valuerequired — (String)

        The value of the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
proton.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.

    • tagKeys — (Array<String>)

      An array of tag keys indicating the resource tags to be removed from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAccountSettings(params = {}, callback) ⇒ AWS.Request

Update the AWS Proton pipeline service account settings.

Service Reference:

Examples:

Calling the updateAccountSettings operation

var params = {
  pipelineServiceRoleArn: 'STRING_VALUE'
};
proton.updateAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • pipelineServiceRoleArn — (String)

      The Amazon Resource Name (ARN) of the AWS Proton pipeline service role.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountSettings — (map)

        The AWS Proton pipeline service role detail data that's returned by AWS Proton.

        • pipelineServiceRoleArn — (String)

          The Amazon Resource Name (ARN) of the AWS Proton pipeline service role.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnvironment(params = {}, callback) ⇒ AWS.Request

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.

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).

Service Reference:

Examples:

Calling the updateEnvironment operation

var params = {
  deploymentType: NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION, /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  environmentAccountConnectionId: 'STRING_VALUE',
  protonServiceRoleArn: 'STRING_VALUE',
  spec: 'STRING_VALUE',
  templateMajorVersion: 'STRING_VALUE',
  templateMinorVersion: 'STRING_VALUE'
};
proton.updateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • deploymentType — (String)

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

      NONE

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

      CURRENT_VERSION

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

      MINOR_VERSION

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

      MAJOR_VERSION

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

      Possible values include:
      • "NONE"
      • "CURRENT_VERSION"
      • "MINOR_VERSION"
      • "MAJOR_VERSION"
    • description — (String)

      A description of the environment update.

    • environmentAccountConnectionId — (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 associated with the current environment.

    • name — (String)

      The name of the environment to update.

    • protonServiceRoleArn — (String)

      The ARN of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.

    • spec — (String)

      The formatted specification that defines the update.

    • templateMajorVersion — (String)

      The ID of the major version of the environment to update.

    • templateMinorVersion — (String)

      The ID of the minor version of the environment to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environment — (map)

        The environment detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment.

        • createdAtrequired — (Date)

          The time when the environment was created.

        • deploymentStatusrequired — (String)

          The environment deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • 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.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the environment was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the environment was last deployed successfully.

        • namerequired — (String)

          The name of the environment.

        • protonServiceRoleArn — (String)

          The ARN of the AWS Proton service role that allows AWS 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.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • spec — (String)

          The environment spec.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the environment template.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the environment template.

        • templateNamerequired — (String)

          The ARN of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnvironmentAccountConnection(params = {}, callback) ⇒ AWS.Request

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.

Examples:

Calling the updateEnvironmentAccountConnection operation

var params = {
  id: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE' /* required */
};
proton.updateEnvironmentAccountConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The ID of the environment account connection to update.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentAccountConnection — (map)

        The environment account connection detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment account connection.

        • environmentAccountIdrequired — (String)

          The environment account that's connected to the environment account connection.

        • environmentNamerequired — (String)

          The name of the environment that's associated with the environment account connection.

        • idrequired — (String)

          The ID of the environment account connection.

        • lastModifiedAtrequired — (Date)

          The time when the environment account connection was last modified.

        • managementAccountIdrequired — (String)

          The ID of the management account that's connected to the environment account connection.

        • requestedAtrequired — (Date)

          The time when the environment account connection request was made.

        • roleArnrequired — (String)

          The IAM service role that's associated with the environment account connection.

        • statusrequired — (String)

          The status of the environment account connection.

          Possible values include:
          • "PENDING"
          • "CONNECTED"
          • "REJECTED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnvironmentTemplate(params = {}, callback) ⇒ AWS.Request

Update an environment template.

Service Reference:

Examples:

Calling the updateEnvironmentTemplate operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  displayName: 'STRING_VALUE'
};
proton.updateEnvironmentTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A description of the environment template update.

    • displayName — (String)

      The name of the environment template to update as displayed in the developer interface.

    • name — (String)

      The name of the environment template to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplate — (map)

        The environment template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the environment template.

        • createdAtrequired — (Date)

          The time when the environment template was created.

        • description — (String)

          A description of the environment template.

        • displayName — (String)

          The name of the environment template as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided encryption key for the environment template.

        • lastModifiedAtrequired — (Date)

          The time when the environment template was last modified.

        • namerequired — (String)

          The name of the environment template.

        • provisioning — (String)

          When included, indicates that the environment template is for customer provisioned and managed infrastructure.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEnvironmentTemplateVersion(params = {}, callback) ⇒ AWS.Request

Update a major or minor version of an environment template.

Examples:

Calling the updateEnvironmentTemplateVersion operation

var params = {
  majorVersion: 'STRING_VALUE', /* required */
  minorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  status: REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED
};
proton.updateEnvironmentTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A description of environment template version to update.

    • majorVersion — (String)

      To update a major version of an environment template, include majorVersion.

    • minorVersion — (String)

      To update a minor version of an environment template, include minorVersion.

    • status — (String)

      The status of the environment template minor version to update.

      Possible values include:
      • "REGISTRATION_IN_PROGRESS"
      • "REGISTRATION_FAILED"
      • "DRAFT"
      • "PUBLISHED"
    • templateName — (String)

      The name of the environment template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • environmentTemplateVersion — (map)

        The environment template version detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of an environment template.

        • createdAtrequired — (Date)

          The time when the version of an environment template was created.

        • description — (String)

          A description of the minor version of an environment template.

        • lastModifiedAtrequired — (Date)

          The time when the version of an environment template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of an environment template.

        • minorVersionrequired — (String)

          The ID of the minor version of an environment template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the environment template.

        • schema — (String)

          The schema of the version of an environment template.

        • statusrequired — (String)

          The status of the version of an environment template.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          The status message of the version of an environment template.

        • templateNamerequired — (String)

          The name of the version of an environment template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateService(params = {}, callback) ⇒ AWS.Request

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

Note: Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

Service Reference:

Examples:

Calling the updateService operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  spec: 'STRING_VALUE'
};
proton.updateService(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      The edited service description.

    • name — (String)

      The name of the service to edit.

    • spec — (String)

      Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don't include edits to the existing service instances or pipeline. For more information, see Edit a service in the AWS Proton Administration Guide or the AWS Proton User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • service — (map)

        The service detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service.

        • branchName — (String)

          The name of the code repository branch that holds the code that's deployed in AWS Proton.

        • createdAtrequired — (Date)

          The time when the service was created.

        • description — (String)

          A description of a service.

        • lastModifiedAtrequired — (Date)

          The time when the service was last modified.

        • namerequired — (String)

          The name of the service.

        • pipeline — (map)

          The service pipeline detail data.

          • arnrequired — (String)

            The Amazon Resource Name (ARN) of the service pipeline.

          • createdAtrequired — (Date)

            The time when the service pipeline was created.

          • deploymentStatusrequired — (String)

            The deployment status of the service pipeline.

            Possible values include:
            • "IN_PROGRESS"
            • "FAILED"
            • "SUCCEEDED"
            • "DELETE_IN_PROGRESS"
            • "DELETE_FAILED"
            • "DELETE_COMPLETE"
            • "CANCELLING"
            • "CANCELLED"
          • deploymentStatusMessage — (String)

            A service pipeline deployment status message.

          • lastDeploymentAttemptedAtrequired — (Date)

            The time when a deployment of the service pipeline was last attempted.

          • lastDeploymentSucceededAtrequired — (Date)

            The time when the service pipeline was last deployed successfully.

          • spec — (String)

            The service spec that was used to create the service pipeline.

          • templateMajorVersionrequired — (String)

            The ID of the major version of the service template that was used to create the service pipeline.

          • templateMinorVersionrequired — (String)

            The ID of the minor version of the service template that was used to create the service pipeline.

          • templateNamerequired — (String)

            The name of the service template that was used to create the service pipeline.

        • repositoryConnectionArn — (String)

          The ARN of the repository connection. For more information, see Set up a repository connection in the AWS Proton Administration Guide and Getting started in the AWS Proton User Guide.

        • repositoryId — (String)

          The ID of the code repository.

        • specrequired — (String)

          The formatted specification that defines the service.

        • statusrequired — (String)

          The status of the service.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_IN_PROGRESS"
          • "CREATE_FAILED_CLEANUP_COMPLETE"
          • "CREATE_FAILED_CLEANUP_FAILED"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "UPDATE_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_IN_PROGRESS"
          • "UPDATE_FAILED_CLEANUP_COMPLETE"
          • "UPDATE_FAILED_CLEANUP_FAILED"
          • "UPDATE_FAILED"
          • "UPDATE_COMPLETE_CLEANUP_FAILED"
        • statusMessage — (String)

          A service status message.

        • templateNamerequired — (String)

          The name of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateServiceInstance(params = {}, callback) ⇒ AWS.Request

Update a service instance.

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

NONE

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

CURRENT_VERSION

In this mode, the 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).

Service Reference:

Examples:

Calling the updateServiceInstance operation

var params = {
  deploymentType: NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION, /* required */
  name: 'STRING_VALUE', /* required */
  serviceName: 'STRING_VALUE', /* required */
  spec: 'STRING_VALUE',
  templateMajorVersion: 'STRING_VALUE',
  templateMinorVersion: 'STRING_VALUE'
};
proton.updateServiceInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • deploymentType — (String)

      The deployment type.

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

      NONE

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

      CURRENT_VERSION

      In this mode, the 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).

      Possible values include:
      • "NONE"
      • "CURRENT_VERSION"
      • "MINOR_VERSION"
      • "MAJOR_VERSION"
    • name — (String)

      The name of the service instance to update.

    • serviceName — (String)

      The name of the service that the service instance belongs to.

    • spec — (String)

      The formatted specification that defines the service instance update.

    • templateMajorVersion — (String)

      The major version of the service template to update.

    • templateMinorVersion — (String)

      The minor version of the service template to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceInstance — (map)

        The service instance summary data returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service instance.

        • createdAtrequired — (Date)

          The time when the service instance was created.

        • deploymentStatusrequired — (String)

          The service instance deployment status.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • deploymentStatusMessage — (String)

          A service instance deployment status message.

        • environmentNamerequired — (String)

          The name of the environment that the service instance was deployed into.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the service instance was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the service instance was last deployed successfully.

        • namerequired — (String)

          The name of the service instance.

        • serviceNamerequired — (String)

          The name of the service that the service instance belongs to.

        • spec — (String)

          The service spec that was used to create the service instance.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the service template that was used to create the service instance.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the service template that was used to create the service instance.

        • templateNamerequired — (String)

          The name of the service template that was used to create the service instance.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateServicePipeline(params = {}, callback) ⇒ AWS.Request

Update the service pipeline.

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

NONE

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

CURRENT_VERSION

In this mode, the 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).

Service Reference:

Examples:

Calling the updateServicePipeline operation

var params = {
  deploymentType: NONE | CURRENT_VERSION | MINOR_VERSION | MAJOR_VERSION, /* required */
  serviceName: 'STRING_VALUE', /* required */
  spec: 'STRING_VALUE', /* required */
  templateMajorVersion: 'STRING_VALUE',
  templateMinorVersion: 'STRING_VALUE'
};
proton.updateServicePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • deploymentType — (String)

      The deployment type.

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

      NONE

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

      CURRENT_VERSION

      In this mode, the 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).

      Possible values include:
      • "NONE"
      • "CURRENT_VERSION"
      • "MINOR_VERSION"
      • "MAJOR_VERSION"
    • serviceName — (String)

      The name of the service to that the pipeline is associated with.

    • spec — (String)

      The spec for the service pipeline to update.

    • templateMajorVersion — (String)

      The major version of the service template that was used to create the service that the pipeline is associated with.

    • templateMinorVersion — (String)

      The minor version of the service template that was used to create the service that the pipeline is associated with.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • pipeline — (map)

        The pipeline details returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service pipeline.

        • createdAtrequired — (Date)

          The time when the service pipeline was created.

        • deploymentStatusrequired — (String)

          The deployment status of the service pipeline.

          Possible values include:
          • "IN_PROGRESS"
          • "FAILED"
          • "SUCCEEDED"
          • "DELETE_IN_PROGRESS"
          • "DELETE_FAILED"
          • "DELETE_COMPLETE"
          • "CANCELLING"
          • "CANCELLED"
        • deploymentStatusMessage — (String)

          A service pipeline deployment status message.

        • lastDeploymentAttemptedAtrequired — (Date)

          The time when a deployment of the service pipeline was last attempted.

        • lastDeploymentSucceededAtrequired — (Date)

          The time when the service pipeline was last deployed successfully.

        • spec — (String)

          The service spec that was used to create the service pipeline.

        • templateMajorVersionrequired — (String)

          The ID of the major version of the service template that was used to create the service pipeline.

        • templateMinorVersionrequired — (String)

          The ID of the minor version of the service template that was used to create the service pipeline.

        • templateNamerequired — (String)

          The name of the service template that was used to create the service pipeline.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateServiceTemplate(params = {}, callback) ⇒ AWS.Request

Update a service template.

Service Reference:

Examples:

Calling the updateServiceTemplate operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  displayName: 'STRING_VALUE'
};
proton.updateServiceTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A description of the service template update.

    • displayName — (String)

      The name of the service template to update as displayed in the developer interface.

    • name — (String)

      The name of the service template to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplate — (map)

        The service template detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the service template.

        • createdAtrequired — (Date)

          The time when the service template was created.

        • description — (String)

          A description of the service template.

        • displayName — (String)

          The service template name as displayed in the developer interface.

        • encryptionKey — (String)

          The customer provided service template encryption key that's used to encrypt data.

        • lastModifiedAtrequired — (Date)

          The time when the service template was last modified.

        • namerequired — (String)

          The name of the service template.

        • pipelineProvisioning — (String)

          If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn't included in the service template.

          Possible values include:
          • "CUSTOMER_MANAGED"
        • recommendedVersion — (String)

          The ID of the recommended version of the service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateServiceTemplateVersion(params = {}, callback) ⇒ AWS.Request

Update a major or minor version of a service template.

Service Reference:

Examples:

Calling the updateServiceTemplateVersion operation

var params = {
  majorVersion: 'STRING_VALUE', /* required */
  minorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE', /* required */
  compatibleEnvironmentTemplates: [
    {
      majorVersion: 'STRING_VALUE', /* required */
      templateName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  status: REGISTRATION_IN_PROGRESS | REGISTRATION_FAILED | DRAFT | PUBLISHED
};
proton.updateServiceTemplateVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • compatibleEnvironmentTemplates — (Array<map>)

      An array of compatible environment names for a service template major or minor version to update.

      • majorVersionrequired — (String)

        The major version of the compatible environment template.

      • templateNamerequired — (String)

        The compatible environment template name.

    • description — (String)

      A description of a service template version to update.

    • majorVersion — (String)

      To update a major version of a service template, include majorVersion.

    • minorVersion — (String)

      To update a minor version of a service template, include minorVersion.

    • status — (String)

      The status of the service template minor version to update.

      Possible values include:
      • "REGISTRATION_IN_PROGRESS"
      • "REGISTRATION_FAILED"
      • "DRAFT"
      • "PUBLISHED"
    • templateName — (String)

      The name of the service template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • serviceTemplateVersion — (map)

        The service template version detail data that's returned by AWS Proton.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the version of a service template.

        • compatibleEnvironmentTemplatesrequired — (Array<map>)

          An array of compatible environment template names for the major version of a service template.

          • majorVersionrequired — (String)

            The major version of the compatible environment template.

          • templateNamerequired — (String)

            The compatible environment template name.

        • createdAtrequired — (Date)

          The time when the version of a service template was created.

        • description — (String)

          A description of the version of a service template.

        • lastModifiedAtrequired — (Date)

          The time when the version of a service template was last modified.

        • majorVersionrequired — (String)

          The ID of the latest major version that's associated with the version of a service template.

        • minorVersionrequired — (String)

          The ID of the minor version of a service template.

        • recommendedMinorVersion — (String)

          The ID of the recommended minor version of the service template.

        • schema — (String)

          The schema of the version of a service template.

        • statusrequired — (String)

          The service template version status.

          Possible values include:
          • "REGISTRATION_IN_PROGRESS"
          • "REGISTRATION_FAILED"
          • "DRAFT"
          • "PUBLISHED"
        • statusMessage — (String)

          A service template version status message.

        • templateNamerequired — (String)

          The name of the version of a service template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.