Class: AWS.Proton

var params = {
  componentName: 'STRING_VALUE' /* required */
};
proton.cancelComponentDeployment(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: {}) —
  • componentName — (String)

    The name of the component 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:

    • component — (map)

      The detailed data of the component with the deployment that is being canceled.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the component.

      • createdAt — required — (Date)

        The time when the component was created.

      • deploymentStatus — required — (String)

        The component deployment status.

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

        The message associated with the component deployment status.

      • description — (String)

        A description of the component.

      • environmentName — required — (String)

        The name of the Proton environment that this component is associated with.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this component.

      • lastClientRequestToken — (String)

        The last token the client requested.

      • lastDeploymentAttemptedAt — (Date)

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

      • lastDeploymentSucceededAt — (Date)

        The time when the component was last deployed successfully.

      • lastModifiedAt — required — (Date)

        The time when the component was last modified.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this component.

      • name — required — (String)

        The name of the component.

      • serviceInstanceName — (String)

        The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

      • serviceName — (String)

        The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

      • serviceSpec — (String)

        The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

Returns:

• (AWS.Request) —

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

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

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the environment.

      • codebuildRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

      • componentRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

        The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

        For more information about components, see Proton components in the Proton User Guide.

      • createdAt — required — (Date)

        The time when the environment was created.

      • deploymentStatus — required — (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.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this environment.

      • lastDeploymentAttemptedAt — required — (Date)

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

      • lastDeploymentSucceededAt — required — (Date)

        The time when the environment was last deployed successfully.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this environment.

      • name — required — (String)

        The name of the environment.

      • protonServiceRoleArn — (String)

        The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

      • provisioning — (String)

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

        Possible values include:
        • "CUSTOMER_MANAGED"
      • provisioningRepository — (map)

        The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

        • arn — required — (String)

          The Amazon Resource Name (ARN) of the linked repository.

        • branch — required — (String)

          The repository branch.

        • name — required — (String)

          The repository name.

        • provider — required — (String)

          The repository provider.

          Possible values include:
          • "GITHUB"
          • "GITHUB_ENTERPRISE"
          • "BITBUCKET"
      • spec — (String)

        The environment spec.

      • templateMajorVersion — required — (String)

        The major version of the environment template.

      • templateMinorVersion — required — (String)

        The minor version of the environment template.

      • templateName — required — (String)

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

Returns:

• (AWS.Request) —

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

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

      • arn — required — (String)

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

      • createdAt — required — (Date)

        The time when the service instance was created.

      • deploymentStatus — required — (String)

        The service instance deployment status.

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

        The message associated with the service instance deployment status.

      • environmentName — required — (String)

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

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this service instance.

      • lastClientRequestToken — (String)

        The last client request token received.

      • lastDeploymentAttemptedAt — required — (Date)

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

      • lastDeploymentSucceededAt — required — (Date)

        The time when the service instance was last deployed successfully.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this service instance.

      • name — required — (String)

        The name of the service instance.

      • serviceName — required — (String)

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

      • spec — (String)

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

      • templateMajorVersion — required — (String)

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

      • templateMinorVersion — required — (String)

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

      • templateName — required — (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.

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

      • arn — required — (String)

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

      • createdAt — required — (Date)

        The time when the service pipeline was created.

      • deploymentStatus — required — (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.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this service pipeline.

      • lastDeploymentAttemptedAt — required — (Date)

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

      • lastDeploymentSucceededAt — required — (Date)

        The time when the service pipeline was last deployed successfully.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this service pipeline.

      • spec — (String)

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

      • templateMajorVersion — required — (String)

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

      • templateMinorVersion — required — (String)

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

      • templateName — required — (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.

var params = {
  manifest: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  templateFile: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  environmentName: 'STRING_VALUE',
  serviceInstanceName: 'STRING_VALUE',
  serviceName: 'STRING_VALUE',
  serviceSpec: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.createComponent(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)

    The client token for the created component.

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

    An optional customer-provided description of the component.

  • environmentName — (String)

    The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

  • manifest — (String)

    A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

  • name — (String)

    The customer-provided name of the component.

  • serviceInstanceName — (String)

    The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

  • serviceName — (String)

    The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

  • serviceSpec — (String)

    The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (String)

      The value of the resource tag.

  • templateFile — (String)

    A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

    Note: Components support a single IaC file, even if you use Terraform as your template language.

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:

    • component — (map)

      The detailed data of the created component.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the component.

      • createdAt — required — (Date)

        The time when the component was created.

      • deploymentStatus — required — (String)

        The component deployment status.

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

        The message associated with the component deployment status.

      • description — (String)

        A description of the component.

      • environmentName — required — (String)

        The name of the Proton environment that this component is associated with.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this component.

      • lastClientRequestToken — (String)

        The last token the client requested.

      • lastDeploymentAttemptedAt — (Date)

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

      • lastDeploymentSucceededAt — (Date)

        The time when the component was last deployed successfully.

      • lastModifiedAt — required — (Date)

        The time when the component was last modified.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this component.

      • name — required — (String)

        The name of the component.

      • serviceInstanceName — (String)

        The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

      • serviceName — (String)

        The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

      • serviceSpec — (String)

        The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  spec: 'STRING_VALUE', /* required */
  templateMajorVersion: 'STRING_VALUE', /* required */
  templateName: 'STRING_VALUE', /* required */
  codebuildRoleArn: 'STRING_VALUE',
  componentRoleArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  environmentAccountConnectionId: 'STRING_VALUE',
  protonServiceRoleArn: 'STRING_VALUE',
  provisioningRepository: {
    branch: 'STRING_VALUE', /* required */
    name: 'STRING_VALUE', /* required */
    provider: GITHUB | GITHUB_ENTERPRISE | BITBUCKET /* required */
  },
  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: {}) —
  • codebuildRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

    To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

  • componentRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

    You must specify componentRoleArn to allow directly defined components to be associated with this environment.

    For more information about components, see Proton components in the Proton User Guide.

  • 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. For more information, see Environment account connections in the Proton User guide.

    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

  • name — (String)

    The name of the environment.

  • protonServiceRoleArn — (String)

    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

  • provisioningRepository — (map)

    The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

    • branch — required — (String)

      The repository branch.

    • name — required — (String)

      The repository name.

    • provider — required — (String)

      The repository provider.

      Possible values include:
      • "GITHUB"
      • "GITHUB_ENTERPRISE"
      • "BITBUCKET"
  • spec — (String)

    A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (String)

      The value of the resource tag.

  • templateMajorVersion — (String)

    The major version of the environment template.

  • templateMinorVersion — (String)

    The minor version of the environment template.

  • templateName — (String)

    The name of the environment template. For more information, see Environment Templates in the 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:

    • environment — (map)

      The environment detail data that's returned by Proton.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the environment.

      • codebuildRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

      • componentRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

        The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

        For more information about components, see Proton components in the Proton User Guide.

      • createdAt — required — (Date)

        The time when the environment was created.

      • deploymentStatus — required — (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.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this environment.

      • lastDeploymentAttemptedAt — required — (Date)

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

      • lastDeploymentSucceededAt — required — (Date)

        The time when the environment was last deployed successfully.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this environment.

      • name — required — (String)

        The name of the environment.

      • protonServiceRoleArn — (String)

        The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

      • provisioning — (String)

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

        Possible values include:
        • "CUSTOMER_MANAGED"
      • provisioningRepository — (map)

        The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

        • arn — required — (String)

          The Amazon Resource Name (ARN) of the linked repository.

        • branch — required — (String)

          The repository branch.

        • name — required — (String)

          The repository name.

        • provider — required — (String)

          The repository provider.

          Possible values include:
          • "GITHUB"
          • "GITHUB_ENTERPRISE"
          • "BITBUCKET"
      • spec — (String)

        The environment spec.

      • templateMajorVersion — required — (String)

        The major version of the environment template.

      • templateMinorVersion — required — (String)

        The minor version of the environment template.

      • templateName — required — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  environmentName: 'STRING_VALUE', /* required */
  managementAccountId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  codebuildRoleArn: 'STRING_VALUE',
  componentRoleArn: 'STRING_VALUE',
  roleArn: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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 identical requests are made with the same client token, 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.
  • codebuildRoleArn — (String)

    The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

  • componentRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

    You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.

    For more information about components, see Proton components in the Proton User Guide.

  • environmentName — (String)

    The name of the 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 and manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

  • roleArn — (String)

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

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (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:

    • environmentAccountConnection — (map)

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

      • arn — required — (String)

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

      • codebuildRoleArn — (String)

        The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

      • componentRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

        The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

        For more information about components, see Proton components in the Proton User Guide.

      • environmentAccountId — required — (String)

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

      • environmentName — required — (String)

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

      • id — required — (String)

        The ID of the environment account connection.

      • lastModifiedAt — required — (Date)

        The time when the environment account connection was last modified.

      • managementAccountId — required — (String)

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

      • requestedAt — required — (Date)

        The time when the environment account connection request was made.

      • roleArn — required — (String)

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

      • status — required — (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.

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

    An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (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 Proton.

      • arn — required — (String)

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

      • createdAt — required — (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.

      • lastModifiedAt — required — (Date)

        The time when the environment template was last modified.

      • name — required — (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.

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 identical requests are made with the same client token, 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 major Version.

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

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

      • bucket — required — (String)

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

      • key — required — (String)

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

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (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 Proton.

      • arn — required — (String)

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

      • createdAt — required — (Date)

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

      • description — (String)

        A description of the minor version of an environment template.

      • lastModifiedAt — required — (Date)

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

      • majorVersion — required — (String)

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

      • minorVersion — required — (String)

        The minor version of an environment template.

      • recommendedMinorVersion — (String)

        The recommended minor version of the environment template.

      • schema — (String)

        The schema of the version of an environment template.

      • status — required — (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.

      • templateName — required — (String)

        The name of the version of an environment template.

Returns:

• (AWS.Request) —

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

var params = {
  connectionArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  provider: GITHUB | GITHUB_ENTERPRISE | BITBUCKET, /* required */
  encryptionKey: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
proton.createRepository(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: {}) —
  • connectionArn — (String)

    The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account. For more information, see Setting up for Proton in the Proton User Guide.

  • encryptionKey — (String)

    The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.

  • name — (String)

    The repository name (for example, myrepos/myrepo).

  • provider — (String)

    The repository provider.

    Possible values include:
    • "GITHUB"
    • "GITHUB_ENTERPRISE"
    • "BITBUCKET"
  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (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:

    • repository — (map)

      The repository link's detail data that's returned by Proton.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the linked repository.

      • connectionArn — required — (String)

        The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.

      • encryptionKey — (String)

        Your customer Amazon Web Services KMS encryption key.

      • name — required — (String)

        The repository name.

      • provider — required — (String)

        The repository provider.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
        • "BITBUCKET"

Returns:

• (AWS.Request) —

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

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 Proton. Don't include this parameter if your service template doesn't include a service pipeline.

  • description — (String)

    A description of the Proton service.

  • name — (String)

    The service name.

  • repositoryConnectionArn — (String)

    The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide. 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 Proton User Guide.

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (String)

      The value of the resource tag.

  • templateMajorVersion — (String)

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

  • templateMinorVersion — (String)

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

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the service.

      • branchName — (String)

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

      • createdAt — required — (Date)

        The time when the service was created.

      • description — (String)

        A description of the service.

      • lastModifiedAt — required — (Date)

        The time when the service was last modified.

      • name — required — (String)

        The name of the service.

      • pipeline — (map)

        The service pipeline detail data.

        • arn — required — (String)

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

        • createdAt — required — (Date)

          The time when the service pipeline was created.

        • deploymentStatus — required — (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.

        • lastAttemptedDeploymentId — (String)

          The ID of the last attempted deployment of this service pipeline.

        • lastDeploymentAttemptedAt — required — (Date)

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

        • lastDeploymentSucceededAt — required — (Date)

          The time when the service pipeline was last deployed successfully.

        • lastSucceededDeploymentId — (String)

          The ID of the last successful deployment of this service pipeline.

        • spec — (String)

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

        • templateMajorVersion — required — (String)

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

        • templateMinorVersion — required — (String)

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

        • templateName — required — (String)

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

      • repositoryConnectionArn — (String)

        The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

      • repositoryId — (String)

        The ID of the source code repository.

      • spec — required — (String)

        The formatted specification that defines the service.

      • status — required — (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.

      • templateName — required — (String)

        The name of the service template.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  serviceName: 'STRING_VALUE', /* required */
  spec: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  templateMajorVersion: 'STRING_VALUE',
  templateMinorVersion: 'STRING_VALUE'
};
proton.createServiceInstance(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)

    The client token of the service instance to create.

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

    The name of the service instance to create.

  • serviceName — (String)

    The name of the service the service instance is added to.

  • spec — (String)

    The spec for the service instance you want to create.

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (String)

      The value of the resource tag.

  • templateMajorVersion — (String)

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

  • templateMinorVersion — (String)

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

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 detailed data of the service instance being created.

      • arn — required — (String)

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

      • createdAt — required — (Date)

        The time when the service instance was created.

      • deploymentStatus — required — (String)

        The service instance deployment status.

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

        The message associated with the service instance deployment status.

      • environmentName — required — (String)

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

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this service instance.

      • lastClientRequestToken — (String)

        The last client request token received.

      • lastDeploymentAttemptedAt — required — (Date)

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

      • lastDeploymentSucceededAt — required — (Date)

        The time when the service instance was last deployed successfully.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this service instance.

      • name — required — (String)

        The name of the service instance.

      • serviceName — required — (String)

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

      • spec — (String)

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

      • templateMajorVersion — required — (String)

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

      • templateMinorVersion — required — (String)

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

      • templateName — required — (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.

var params = {
  branch: 'STRING_VALUE', /* required */
  filePath: 'STRING_VALUE', /* required */
  repositoryName: 'STRING_VALUE', /* required */
  repositoryProvider: GITHUB | GITHUB_ENTERPRISE | BITBUCKET, /* required */
  serviceName: 'STRING_VALUE' /* required */
};
proton.createServiceSyncConfig(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: {}) —
  • branch — (String)

    The repository branch for your Proton Ops file.

  • filePath — (String)

    The path to the Proton Ops file.

  • repositoryName — (String)

    The repository name.

  • repositoryProvider — (String)

    The provider type for your repository.

    Possible values include:
    • "GITHUB"
    • "GITHUB_ENTERPRISE"
    • "BITBUCKET"
  • serviceName — (String)

    The name of the service the Proton Ops file is 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:

    • serviceSyncConfig — (map)

      The detailed data of the Proton Ops file.

      • branch — required — (String)

        The name of the code repository branch that holds the service code Proton will sync with.

      • filePath — required — (String)

        The file path to the service sync configuration file.

      • repositoryName — required — (String)

        The name of the code repository that holds the service code Proton will sync with.

      • repositoryProvider — required — (String)

        The name of the repository provider that holds the repository Proton will sync with.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
        • "BITBUCKET"
      • serviceName — required — (String)

        The name of the service that the service instance is added to.

Returns:

• (AWS.Request) —

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

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)

    By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Template bundles in the Proton User Guide.

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

    An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (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 Proton.

      • arn — required — (String)

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

      • createdAt — required — (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.

      • lastModifiedAt — required — (Date)

        The time when the service template was last modified.

      • name — required — (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 recommended version of the service template.

Returns:

• (AWS.Request) —

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

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',
  supportedComponentSources: [
    DIRECTLY_DEFINED,
    /* more items */
  ],
  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 identical requests are made with the same client token, 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 environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

    • majorVersion — required — (String)

      The major version of the compatible environment template.

    • templateName — required — (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 major Version.

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

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

      • bucket — required — (String)

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

      • key — required — (String)

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

  • supportedComponentSources — (Array<String>)

    An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

    For more information about components, see Proton components in the Proton User Guide.

  • tags — (Array<map>)

    An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

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

    • key — required — (String)

      The key of the resource tag.

    • value — required — (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 Proton.

      • arn — required — (String)

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

      • compatibleEnvironmentTemplates — required — (Array<map>)

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

        • majorVersion — required — (String)

          The major version of the compatible environment template.

        • templateName — required — (String)

          The compatible environment template name.

      • createdAt — required — (Date)

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

      • description — (String)

        A description of the version of a service template.

      • lastModifiedAt — required — (Date)

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

      • majorVersion — required — (String)

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

      • minorVersion — required — (String)

        The minor version of a service template.

      • recommendedMinorVersion — (String)

        The recommended minor version of the service template.

      • schema — (String)

        The schema of the version of a service template.

      • status — required — (String)

        The service template version status.

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

        A service template version status message.

      • supportedComponentSources — (Array<String>)

        An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

        For more information about components, see Proton components in the Proton User Guide.

      • templateName — required — (String)

        The name of the version of a service template.

Returns:

• (AWS.Request) —

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

var params = {
  branch: 'STRING_VALUE', /* required */
  repositoryName: 'STRING_VALUE', /* required */
  repositoryProvider: GITHUB | GITHUB_ENTERPRISE | BITBUCKET, /* required */
  templateName: 'STRING_VALUE', /* required */
  templateType: ENVIRONMENT | SERVICE, /* required */
  subdirectory: 'STRING_VALUE'
};
proton.createTemplateSyncConfig(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: {}) —
  • branch — (String)

    The repository branch for your template.

  • repositoryName — (String)

    The repository name (for example, myrepos/myrepo).

  • repositoryProvider — (String)

    The provider type for your repository.

    Possible values include:
    • "GITHUB"
    • "GITHUB_ENTERPRISE"
    • "BITBUCKET"
  • subdirectory — (String)

    A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.

  • templateName — (String)

    The name of your registered template.

  • templateType — (String)

    The type of the registered template.

    Possible values include:
    • "ENVIRONMENT"
    • "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:

    • templateSyncConfig — (map)

      The template sync configuration detail data that's returned by Proton.

      • branch — required — (String)

        The repository branch.

      • repositoryName — required — (String)

        The repository name (for example, myrepos/myrepo).

      • repositoryProvider — required — (String)

        The repository provider.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
        • "BITBUCKET"
      • subdirectory — (String)

        A subdirectory path to your template bundle version.

      • templateName — required — (String)

        The template name.

      • templateType — required — (String)

        The template type.

        Possible values include:
        • "ENVIRONMENT"
        • "SERVICE"

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.deleteComponent(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 component 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:

    • component — (map)

      The detailed data of the component being deleted.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the component.

      • createdAt — required — (Date)

        The time when the component was created.

      • deploymentStatus — required — (String)

        The component deployment status.

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

        The message associated with the component deployment status.

      • description — (String)

        A description of the component.

      • environmentName — required — (String)

        The name of the Proton environment that this component is associated with.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this component.

      • lastClientRequestToken — (String)

        The last token the client requested.

      • lastDeploymentAttemptedAt — (Date)

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

      • lastDeploymentSucceededAt — (Date)

        The time when the component was last deployed successfully.

      • lastModifiedAt — required — (Date)

        The time when the component was last modified.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this component.

      • name — required — (String)

        The name of the component.

      • serviceInstanceName — (String)

        The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

      • serviceName — (String)

        The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

      • serviceSpec — (String)

        The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

Returns:

• (AWS.Request) —

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

var params = {
  id: 'STRING_VALUE' /* required */
};
proton.deleteDeployment(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 deployment 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:

    • deployment — (map)

      The detailed data of the deployment being deleted.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the deployment.

      • completedAt — (Date)

        The date and time the deployment was completed.

      • componentName — (String)

        The name of the component associated with this deployment.

      • createdAt — required — (Date)

        The date and time the deployment was created.

      • deploymentStatus — required — (String)

        The status of the deployment.

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

        The deployment status message.

      • environmentName — required — (String)

        The name of the environment associated with this deployment.

      • id — required — (String)

        The ID of the deployment.

      • initialState — (map)

        The initial state of the target resource at the time of the deployment.

        • component — (map)

          The state of the component associated with the deployment.

          • serviceInstanceName — (String)

            The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

          • serviceName — (String)

            The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

          • serviceSpec — (String)

            The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

          • templateFile — (String)

            The template file used.

        • environment — (map)

          The state of the environment associated with the deployment.

          • spec — (String)

            The environment spec that was used to create the environment.

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

            The name of the environment template that was used to create the environment.

        • serviceInstance — (map)

          The state of the service instance associated with the deployment.

          • lastSuccessfulComponentDeploymentIds — (Array<String>)

            The IDs for the last successful components deployed for this service instance.

          • lastSuccessfulEnvironmentDeploymentId — (String)

            The ID for the last successful environment deployed for this service instance.

          • lastSuccessfulServicePipelineDeploymentId — (String)

            The ID for the last successful service pipeline deployed for this service instance.

          • spec — required — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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

        • servicePipeline — (map)

          The state of the service pipeline associated with the deployment.

          • spec — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment.

      • lastModifiedAt — required — (Date)

        The date and time the deployment was last modified.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment.

      • serviceInstanceName — (String)

        The name of the deployment's service instance.

      • serviceName — (String)

        The name of the service in this deployment.

      • targetArn — required — (String)

        The Amazon Resource Name (ARN) of the target of the deployment.

      • targetResourceCreatedAt — required — (Date)

        The date and time the depoyment target was created.

      • targetResourceType — required — (String)

        The resource type of the deployment target. It can be an environment, service, service instance, or component.

        Possible values include:
        • "ENVIRONMENT"
        • "SERVICE_PIPELINE"
        • "SERVICE_INSTANCE"
        • "COMPONENT"
      • targetState — (map)

        The target state of the target resource at the time of the deployment.

        • component — (map)

          The state of the component associated with the deployment.

          • serviceInstanceName — (String)

            The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

          • serviceName — (String)

            The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

          • serviceSpec — (String)

            The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

          • templateFile — (String)

            The template file used.

        • environment — (map)

          The state of the environment associated with the deployment.

          • spec — (String)

            The environment spec that was used to create the environment.

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

            The name of the environment template that was used to create the environment.

        • serviceInstance — (map)

          The state of the service instance associated with the deployment.

          • lastSuccessfulComponentDeploymentIds — (Array<String>)

            The IDs for the last successful components deployed for this service instance.

          • lastSuccessfulEnvironmentDeploymentId — (String)

            The ID for the last successful environment deployed for this service instance.

          • lastSuccessfulServicePipelineDeploymentId — (String)

            The ID for the last successful service pipeline deployed for this service instance.

          • spec — required — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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

        • servicePipeline — (map)

          The state of the service pipeline associated with the deployment.

          • spec — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (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.

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 detailed data of the environment being deleted.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the environment.

      • codebuildRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

      • componentRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

        The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

        For more information about components, see Proton components in the Proton User Guide.

      • createdAt — required — (Date)

        The time when the environment was created.

      • deploymentStatus — required — (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.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this environment.

      • lastDeploymentAttemptedAt — required — (Date)

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

      • lastDeploymentSucceededAt — required — (Date)

        The time when the environment was last deployed successfully.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this environment.

      • name — required — (String)

        The name of the environment.

      • protonServiceRoleArn — (String)

        The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.

      • provisioning — (String)

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

        Possible values include:
        • "CUSTOMER_MANAGED"
      • provisioningRepository — (map)

        The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

        • arn — required — (String)

          The Amazon Resource Name (ARN) of the linked repository.

        • branch — required — (String)

          The repository branch.

        • name — required — (String)

          The repository name.

        • provider — required — (String)

          The repository provider.

          Possible values include:
          • "GITHUB"
          • "GITHUB_ENTERPRISE"
          • "BITBUCKET"
      • spec — (String)

        The environment spec.

      • templateMajorVersion — required — (String)

        The major version of the environment template.

      • templateMinorVersion — required — (String)

        The minor version of the environment template.

      • templateName — required — (String)

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

Returns:

• (AWS.Request) —

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

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 detailed data of the environment account connection being deleted.

      • arn — required — (String)

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

      • codebuildRoleArn — (String)

        The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

      • componentRoleArn — (String)

        The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

        The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

        For more information about components, see Proton components in the Proton User Guide.

      • environmentAccountId — required — (String)

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

      • environmentName — required — (String)

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

      • id — required — (String)

        The ID of the environment account connection.

      • lastModifiedAt — required — (Date)

        The time when the environment account connection was last modified.

      • managementAccountId — required — (String)

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

      • requestedAt — required — (Date)

        The time when the environment account connection request was made.

      • roleArn — required — (String)

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

      • status — required — (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.

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 detailed data of the environment template being deleted.

      • arn — required — (String)

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

      • createdAt — required — (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.

      • lastModifiedAt — required — (Date)

        The time when the environment template was last modified.

      • name — required — (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.

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 detailed data of the environment template version being deleted.

      • arn — required — (String)

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

      • createdAt — required — (Date)

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

      • description — (String)

        A description of the minor version of an environment template.

      • lastModifiedAt — required — (Date)

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

      • majorVersion — required — (String)

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

      • minorVersion — required — (String)

        The minor version of an environment template.

      • recommendedMinorVersion — (String)

        The recommended minor version of the environment template.

      • schema — (String)

        The schema of the version of an environment template.

      • status — required — (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.

      • templateName — required — (String)

        The name of the version of an environment template.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  provider: GITHUB | GITHUB_ENTERPRISE | BITBUCKET /* required */
};
proton.deleteRepository(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 repository name.

  • provider — (String)

    The repository provider.

    Possible values include:
    • "GITHUB"
    • "GITHUB_ENTERPRISE"
    • "BITBUCKET"

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:

    • repository — (map)

      The deleted repository link's detail data that's returned by Proton.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the linked repository.

      • connectionArn — required — (String)

        The Amazon Resource Name (ARN) of your AWS CodeStar connection that connects Proton to your repository provider account.

      • encryptionKey — (String)

        Your customer Amazon Web Services KMS encryption key.

      • name — required — (String)

        The repository name.

      • provider — required — (String)

        The repository provider.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
        • "BITBUCKET"

Returns:

• (AWS.Request) —

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

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 detailed data of the service being deleted.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the service.

      • branchName — (String)

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

      • createdAt — required — (Date)

        The time when the service was created.

      • description — (String)

        A description of the service.

      • lastModifiedAt — required — (Date)

        The time when the service was last modified.

      • name — required — (String)

        The name of the service.

      • pipeline — (map)

        The service pipeline detail data.

        • arn — required — (String)

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

        • createdAt — required — (Date)

          The time when the service pipeline was created.

        • deploymentStatus — required — (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.

        • lastAttemptedDeploymentId — (String)

          The ID of the last attempted deployment of this service pipeline.

        • lastDeploymentAttemptedAt — required — (Date)

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

        • lastDeploymentSucceededAt — required — (Date)

          The time when the service pipeline was last deployed successfully.

        • lastSucceededDeploymentId — (String)

          The ID of the last successful deployment of this service pipeline.

        • spec — (String)

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

        • templateMajorVersion — required — (String)

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

        • templateMinorVersion — required — (String)

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

        • templateName — required — (String)

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

      • repositoryConnectionArn — (String)

        The Amazon Resource Name (ARN) of the repository connection. For more information, see Setting up an AWS CodeStar connection in the Proton User Guide.

      • repositoryId — (String)

        The ID of the source code repository.

      • spec — required — (String)

        The formatted specification that defines the service.

      • status — required — (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.

      • templateName — required — (String)

        The name of the service template.

Returns:

• (AWS.Request) —

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

var params = {
  serviceName: 'STRING_VALUE' /* required */
};
proton.deleteServiceSyncConfig(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 that you want to delete the service sync configuration 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:

    • serviceSyncConfig — (map)

      The detailed data for the service sync config.

      • branch — required — (String)

        The name of the code repository branch that holds the service code Proton will sync with.

      • filePath — required — (String)

        The file path to the service sync configuration file.

      • repositoryName — required — (String)

        The name of the code repository that holds the service code Proton will sync with.

      • repositoryProvider — required — (String)

        The name of the repository provider that holds the repository Proton will sync with.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
        • "BITBUCKET"
      • serviceName — required — (String)

        The name of the service that the service instance is added to.

Returns:

• (AWS.Request) —

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

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 detailed data of the service template being deleted.

      • arn — required — (String)

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

      • createdAt — required — (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.

      • lastModifiedAt — required — (Date)

        The time when the service template was last modified.

      • name — required — (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 recommended version of the service template.

Returns:

• (AWS.Request) —

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

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 detailed data of the service template version being deleted.

      • arn — required — (String)

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

      • compatibleEnvironmentTemplates — required — (Array<map>)

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

        • majorVersion — required — (String)

          The major version of the compatible environment template.

        • templateName — required — (String)

          The compatible environment template name.

      • createdAt — required — (Date)

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

      • description — (String)

        A description of the version of a service template.

      • lastModifiedAt — required — (Date)

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

      • majorVersion — required — (String)

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

      • minorVersion — required — (String)

        The minor version of a service template.

      • recommendedMinorVersion — (String)

        The recommended minor version of the service template.

      • schema — (String)

        The schema of the version of a service template.

      • status — required — (String)

        The service template version status.

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

        A service template version status message.

      • supportedComponentSources — (Array<String>)

        An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

        For more information about components, see Proton components in the Proton User Guide.

      • templateName — required — (String)

        The name of the version of a service template.

Returns:

• (AWS.Request) —

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

var params = {
  templateName: 'STRING_VALUE', /* required */
  templateType: ENVIRONMENT | SERVICE /* required */
};
proton.deleteTemplateSyncConfig(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: {}) —
  • templateName — (String)

    The template name.

  • templateType — (String)

    The template type.

    Possible values include:
    • "ENVIRONMENT"
    • "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:

    • templateSyncConfig — (map)

      The template sync configuration detail data that's returned by Proton.

      • branch — required — (String)

        The repository branch.

      • repositoryName — required — (String)

        The repository name (for example, myrepos/myrepo).

      • repositoryProvider — required — (String)

        The repository provider.

        Possible values include:
        • "GITHUB"
        • "GITHUB_ENTERPRISE"
        • "BITBUCKET"
      • subdirectory — (String)

        A subdirectory path to your template bundle version.

      • templateName — required — (String)

        The template name.

      • templateType — required — (String)

        The template type.

        Possible values include:
        • "ENVIRONMENT"
        • "SERVICE"

Returns:

• (AWS.Request) —

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

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 Proton pipeline service role detail data that's returned by Proton.

      • pipelineCodebuildRoleArn — (String)

        The Amazon Resource Name (ARN) of the service role that Proton uses for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.

      • pipelineProvisioningRepository — (map)

        The linked repository for pipeline provisioning. Required if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

        • arn — required — (String)

          The Amazon Resource Name (ARN) of the linked repository.

        • branch — required — (String)

          The repository branch.

        • name — required — (String)

          The repository name.

        • provider — required — (String)

          The repository provider.

          Possible values include:
          • "GITHUB"
          • "GITHUB_ENTERPRISE"
          • "BITBUCKET"
      • pipelineServiceRoleArn — (String)

        The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE' /* required */
};
proton.getComponent(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 component that you want to get the detailed 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:

    • component — (map)

      The detailed data of the requested component.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the component.

      • createdAt — required — (Date)

        The time when the component was created.

      • deploymentStatus — required — (String)

        The component deployment status.

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

        The message associated with the component deployment status.

      • description — (String)

        A description of the component.

      • environmentName — required — (String)

        The name of the Proton environment that this component is associated with.

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment of this component.

      • lastClientRequestToken — (String)

        The last token the client requested.

      • lastDeploymentAttemptedAt — (Date)

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

      • lastDeploymentSucceededAt — (Date)

        The time when the component was last deployed successfully.

      • lastModifiedAt — required — (Date)

        The time when the component was last modified.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment of this component.

      • name — required — (String)

        The name of the component.

      • serviceInstanceName — (String)

        The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

      • serviceName — (String)

        The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

      • serviceSpec — (String)

        The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• componentDeleted

• componentDeployed

var params = {
  id: 'STRING_VALUE', /* required */
  componentName: 'STRING_VALUE',
  environmentName: 'STRING_VALUE',
  serviceInstanceName: 'STRING_VALUE',
  serviceName: 'STRING_VALUE'
};
proton.getDeployment(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: {}) —
  • componentName — (String)

    The name of a component that you want to get the detailed data for.

  • environmentName — (String)

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

  • id — (String)

    The ID of the deployment that you want to get the detailed data for.

  • serviceInstanceName — (String)

    The name of the service instance associated with the given deployment ID. serviceName must be specified to identify the service instance.

  • serviceName — (String)

    The name of the service associated with the given deployment ID.

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:

    • deployment — (map)

      The detailed data of the requested deployment.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the deployment.

      • completedAt — (Date)

        The date and time the deployment was completed.

      • componentName — (String)

        The name of the component associated with this deployment.

      • createdAt — required — (Date)

        The date and time the deployment was created.

      • deploymentStatus — required — (String)

        The status of the deployment.

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

        The deployment status message.

      • environmentName — required — (String)

        The name of the environment associated with this deployment.

      • id — required — (String)

        The ID of the deployment.

      • initialState — (map)

        The initial state of the target resource at the time of the deployment.

        • component — (map)

          The state of the component associated with the deployment.

          • serviceInstanceName — (String)

            The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

          • serviceName — (String)

            The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

          • serviceSpec — (String)

            The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

          • templateFile — (String)

            The template file used.

        • environment — (map)

          The state of the environment associated with the deployment.

          • spec — (String)

            The environment spec that was used to create the environment.

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

            The name of the environment template that was used to create the environment.

        • serviceInstance — (map)

          The state of the service instance associated with the deployment.

          • lastSuccessfulComponentDeploymentIds — (Array<String>)

            The IDs for the last successful components deployed for this service instance.

          • lastSuccessfulEnvironmentDeploymentId — (String)

            The ID for the last successful environment deployed for this service instance.

          • lastSuccessfulServicePipelineDeploymentId — (String)

            The ID for the last successful service pipeline deployed for this service instance.

          • spec — required — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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

        • servicePipeline — (map)

          The state of the service pipeline associated with the deployment.

          • spec — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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

      • lastAttemptedDeploymentId — (String)

        The ID of the last attempted deployment.

      • lastModifiedAt — required — (Date)

        The date and time the deployment was last modified.

      • lastSucceededDeploymentId — (String)

        The ID of the last successful deployment.

      • serviceInstanceName — (String)

        The name of the deployment's service instance.

      • serviceName — (String)

        The name of the service in this deployment.

      • targetArn — required — (String)

        The Amazon Resource Name (ARN) of the target of the deployment.

      • targetResourceCreatedAt — required — (Date)

        The date and time the depoyment target was created.

      • targetResourceType — required — (String)

        The resource type of the deployment target. It can be an environment, service, service instance, or component.

        Possible values include:
        • "ENVIRONMENT"
        • "SERVICE_PIPELINE"
        • "SERVICE_INSTANCE"
        • "COMPONENT"
      • targetState — (map)

        The target state of the target resource at the time of the deployment.

        • component — (map)

          The state of the component associated with the deployment.

          • serviceInstanceName — (String)

            The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

          • serviceName — (String)

            The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

          • serviceSpec — (String)

            The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

          • templateFile — (String)

            The template file used.

        • environment — (map)

          The state of the environment associated with the deployment.

          • spec — (String)

            The environment spec that was used to create the environment.

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

            The name of the environment template that was used to create the environment.

        • serviceInstance — (map)

          The state of the service instance associated with the deployment.

          • lastSuccessfulComponentDeploymentIds — (Array<String>)

            The IDs for the last successful components deployed for this service instance.

          • lastSuccessfulEnvironmentDeploymentId — (String)

            The ID for the last successful environment deployed for this service instance.

          • lastSuccessfulServicePipelineDeploymentId — (String)

            The ID for the last successful service pipeline deployed for this service instance.

          • spec — required — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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

        • servicePipeline — (map)

          The state of the service pipeline associated with the deployment.

          • spec — (String)

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

          • templateMajorVersion — required — (String)

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

          • templateMinorVersion — required — (String)

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

          • templateName — required — (String)

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