The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::Proton - Perl Interface to AWS AWS Proton

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Proton');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

This is the AWS Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions (https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html) and data types (https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html) for the AWS Proton service.

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

Alternatively, you can use the AWS CLI to access an API. For more information, see the AWS Command Line Interface User Guide (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html).

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

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

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

To learn more about AWS Proton administration, see the AWS Proton Administration Guide (https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html).

To learn more about deploying serverless and containerized applications on AWS Proton, see the AWS Proton User Guide (https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html).

Ensuring Idempotency

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

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

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

Idempotent create APIs with a client token

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

Given a request action that has succeeded:

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

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

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

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

Idempotent create APIs with a client token:

  • CreateEnvironmentTemplateVersion

  • CreateServiceTemplateVersion

  • CreateEnvironmentAccountConnection

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

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20

METHODS

AcceptEnvironmentAccountConnection

Id => Str

Each argument is described in detail in: Paws::Proton::AcceptEnvironmentAccountConnection

Returns: a Paws::Proton::AcceptEnvironmentAccountConnectionOutput instance

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.

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

CancelEnvironmentDeployment

EnvironmentName => Str

Each argument is described in detail in: Paws::Proton::CancelEnvironmentDeployment

Returns: a Paws::Proton::CancelEnvironmentDeploymentOutput instance

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment (https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-update.html) in the AWS Proton Administration guide.

The following list includes potential cancellation scenarios.

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

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

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

CancelServiceInstanceDeployment

ServiceInstanceName => Str
ServiceName => Str

Each argument is described in detail in: Paws::Proton::CancelServiceInstanceDeployment

Returns: a Paws::Proton::CancelServiceInstanceDeploymentOutput instance

Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS. For more information, see Update a service instance in the AWS Proton Administration guide (https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html) or the AWS Proton User guide (https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html).

The following list includes potential cancellation scenarios.

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

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

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

CancelServicePipelineDeployment

ServiceName => Str

Each argument is described in detail in: Paws::Proton::CancelServicePipelineDeployment

Returns: a Paws::Proton::CancelServicePipelineDeploymentOutput instance

Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administration guide (https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html) or the AWS Proton User guide (https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html).

The following list includes potential cancellation scenarios.

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

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

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

CreateEnvironment

Name => Str
Spec => Str
TemplateMajorVersion => Str
TemplateName => Str
[Description => Str]
[EnvironmentAccountConnectionId => Str]
[ProtonServiceRoleArn => Str]
[Tags => ArrayRef[Paws::Proton::Tag]]
[TemplateMinorVersion => Str]

Each argument is described in detail in: Paws::Proton::CreateEnvironment

Returns: a Paws::Proton::CreateEnvironmentOutput instance

Deploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the Environments (https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html) in the AWS Proton Administration Guide.

CreateEnvironmentAccountConnection

EnvironmentName => Str
ManagementAccountId => Str
RoleArn => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::Proton::CreateEnvironmentAccountConnection

Returns: a Paws::Proton::CreateEnvironmentAccountConnectionOutput instance

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

An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the AWS Proton Administration guide.

CreateEnvironmentTemplate

Name => Str
[Description => Str]
[DisplayName => Str]
[EncryptionKey => Str]
[Provisioning => Str]
[Tags => ArrayRef[Paws::Proton::Tag]]

Each argument is described in detail in: Paws::Proton::CreateEnvironmentTemplate

Returns: a Paws::Proton::CreateEnvironmentTemplateOutput instance

Create an environment template for AWS Proton. For more information, see Environment Templates (https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html) in the AWS Proton Administration Guide.

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

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

  • Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template (https://docs.aws.amazon.com/proton/latest/adminguide/env-template-v1.html) in the AWS Proton Administration Guide.

CreateEnvironmentTemplateVersion

Source => Paws::Proton::TemplateVersionSourceInput
TemplateName => Str
[ClientToken => Str]
[Description => Str]
[MajorVersion => Str]
[Tags => ArrayRef[Paws::Proton::Tag]]

Each argument is described in detail in: Paws::Proton::CreateEnvironmentTemplateVersion

Returns: a Paws::Proton::CreateEnvironmentTemplateVersionOutput instance

Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.

CreateService

Name => Str
Spec => Str
TemplateMajorVersion => Str
TemplateName => Str
[BranchName => Str]
[Description => Str]
[RepositoryConnectionArn => Str]
[RepositoryId => Str]
[Tags => ArrayRef[Paws::Proton::Tag]]
[TemplateMinorVersion => Str]

Each argument is described in detail in: Paws::Proton::CreateService

Returns: a Paws::Proton::CreateServiceOutput instance

Create an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services (https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html) in the AWS Proton Administration Guide and Services (https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html) in the AWS Proton User Guide.

CreateServiceTemplate

Name => Str
[Description => Str]
[DisplayName => Str]
[EncryptionKey => Str]
[PipelineProvisioning => Str]
[Tags => ArrayRef[Paws::Proton::Tag]]

Each argument is described in detail in: Paws::Proton::CreateServiceTemplate

Returns: a Paws::Proton::CreateServiceTemplateOutput instance

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates (https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html) in the AWS Proton Administration Guide.

CreateServiceTemplateVersion

CompatibleEnvironmentTemplates => ArrayRef[Paws::Proton::CompatibleEnvironmentTemplateInput]
Source => Paws::Proton::TemplateVersionSourceInput
TemplateName => Str
[ClientToken => Str]
[Description => Str]
[MajorVersion => Str]
[Tags => ArrayRef[Paws::Proton::Tag]]

Each argument is described in detail in: Paws::Proton::CreateServiceTemplateVersion

Returns: a Paws::Proton::CreateServiceTemplateVersionOutput instance

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

DeleteEnvironment

Name => Str

Each argument is described in detail in: Paws::Proton::DeleteEnvironment

Returns: a Paws::Proton::DeleteEnvironmentOutput instance

Delete an environment.

DeleteEnvironmentAccountConnection

Id => Str

Each argument is described in detail in: Paws::Proton::DeleteEnvironmentAccountConnection

Returns: a Paws::Proton::DeleteEnvironmentAccountConnectionOutput instance

In an environment account, delete an environment account connection.

After you delete an environment account connection that’s in use by an AWS Proton environment, AWS Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.

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

DeleteEnvironmentTemplate

Name => Str

Each argument is described in detail in: Paws::Proton::DeleteEnvironmentTemplate

Returns: a Paws::Proton::DeleteEnvironmentTemplateOutput instance

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

DeleteEnvironmentTemplateVersion

MajorVersion => Str
MinorVersion => Str
TemplateName => Str

Each argument is described in detail in: Paws::Proton::DeleteEnvironmentTemplateVersion

Returns: a Paws::Proton::DeleteEnvironmentTemplateVersionOutput instance

If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the Recommended version. Delete the Recommended version of the environment template if no other major versions or minor versions of the environment template exist. A major version of an environment template is a version that's not backwards compatible.

Delete a minor version of an environment template if it isn't the Recommended version. Delete a Recommended minor version of the environment template if no other minor versions of the environment template exist. A minor version of an environment template is a version that's backwards compatible.

DeleteService

Name => Str

Each argument is described in detail in: Paws::Proton::DeleteService

Returns: a Paws::Proton::DeleteServiceOutput instance

Delete a service.

DeleteServiceTemplate

Name => Str

Each argument is described in detail in: Paws::Proton::DeleteServiceTemplate

Returns: a Paws::Proton::DeleteServiceTemplateOutput instance

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

DeleteServiceTemplateVersion

MajorVersion => Str
MinorVersion => Str
TemplateName => Str

Each argument is described in detail in: Paws::Proton::DeleteServiceTemplateVersion

Returns: a Paws::Proton::DeleteServiceTemplateVersionOutput instance

If no other minor versions of a service template exist, delete a major version of the service template if it's not the Recommended version. Delete the Recommended version of the service template if no other major versions or minor versions of the service template exist. A major version of a service template is a version that isn't backwards compatible.

Delete a minor version of a service template if it's not the Recommended version. Delete a Recommended minor version of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards compatible.

GetAccountSettings

Each argument is described in detail in: Paws::Proton::GetAccountSettings

Returns: a Paws::Proton::GetAccountSettingsOutput instance

Get detail data for the AWS Proton pipeline service role.

GetEnvironment

Name => Str

Each argument is described in detail in: Paws::Proton::GetEnvironment

Returns: a Paws::Proton::GetEnvironmentOutput instance

Get detail data for an environment.

GetEnvironmentAccountConnection

Id => Str

Each argument is described in detail in: Paws::Proton::GetEnvironmentAccountConnection

Returns: a Paws::Proton::GetEnvironmentAccountConnectionOutput instance

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

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

GetEnvironmentTemplate

Name => Str

Each argument is described in detail in: Paws::Proton::GetEnvironmentTemplate

Returns: a Paws::Proton::GetEnvironmentTemplateOutput instance

Get detail data for an environment template.

GetEnvironmentTemplateVersion

MajorVersion => Str
MinorVersion => Str
TemplateName => Str

Each argument is described in detail in: Paws::Proton::GetEnvironmentTemplateVersion

Returns: a Paws::Proton::GetEnvironmentTemplateVersionOutput instance

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

GetService

Name => Str

Each argument is described in detail in: Paws::Proton::GetService

Returns: a Paws::Proton::GetServiceOutput instance

Get detail data for a service.

GetServiceInstance

Name => Str
ServiceName => Str

Each argument is described in detail in: Paws::Proton::GetServiceInstance

Returns: a Paws::Proton::GetServiceInstanceOutput instance

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

GetServiceTemplate

Name => Str

Each argument is described in detail in: Paws::Proton::GetServiceTemplate

Returns: a Paws::Proton::GetServiceTemplateOutput instance

Get detail data for a service template.

GetServiceTemplateVersion

MajorVersion => Str
MinorVersion => Str
TemplateName => Str

Each argument is described in detail in: Paws::Proton::GetServiceTemplateVersion

Returns: a Paws::Proton::GetServiceTemplateVersionOutput instance

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

ListEnvironmentAccountConnections

RequestedBy => Str
[EnvironmentName => Str]
[MaxResults => Int]
[NextToken => Str]
[Statuses => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Proton::ListEnvironmentAccountConnections

Returns: a Paws::Proton::ListEnvironmentAccountConnectionsOutput instance

View a list of environment account connections.

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

ListEnvironments

[EnvironmentTemplates => ArrayRef[Paws::Proton::EnvironmentTemplateFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListEnvironments

Returns: a Paws::Proton::ListEnvironmentsOutput instance

List environments with detail data summaries.

ListEnvironmentTemplates

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListEnvironmentTemplates

Returns: a Paws::Proton::ListEnvironmentTemplatesOutput instance

List environment templates.

ListEnvironmentTemplateVersions

TemplateName => Str
[MajorVersion => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListEnvironmentTemplateVersions

Returns: a Paws::Proton::ListEnvironmentTemplateVersionsOutput instance

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

ListServiceInstances

[MaxResults => Int]
[NextToken => Str]
[ServiceName => Str]

Each argument is described in detail in: Paws::Proton::ListServiceInstances

Returns: a Paws::Proton::ListServiceInstancesOutput instance

List service instances with summaries of detail data.

ListServices

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListServices

Returns: a Paws::Proton::ListServicesOutput instance

List services with summaries of detail data.

ListServiceTemplates

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListServiceTemplates

Returns: a Paws::Proton::ListServiceTemplatesOutput instance

List service templates with detail data.

ListServiceTemplateVersions

TemplateName => Str
[MajorVersion => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListServiceTemplateVersions

Returns: a Paws::Proton::ListServiceTemplateVersionsOutput instance

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

ListTagsForResource

ResourceArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Proton::ListTagsForResource

Returns: a Paws::Proton::ListTagsForResourceOutput instance

List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide (https://docs.aws.amazon.com/proton/latest/adminguide/resources.html) or AWS Proton User Guide (https://docs.aws.amazon.com/proton/latest/userguide/resources.html).

RejectEnvironmentAccountConnection

Id => Str

Each argument is described in detail in: Paws::Proton::RejectEnvironmentAccountConnection

Returns: a Paws::Proton::RejectEnvironmentAccountConnectionOutput instance

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

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

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

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

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::Proton::Tag]

Each argument is described in detail in: Paws::Proton::TagResource

Returns: a Paws::Proton::TagResourceOutput instance

Tag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide (https://docs.aws.amazon.com/proton/latest/adminguide/resources.html) or AWS Proton User Guide (https://docs.aws.amazon.com/proton/latest/userguide/resources.html).

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Proton::UntagResource

Returns: a Paws::Proton::UntagResourceOutput instance

Remove a tag from a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administration Guide (https://docs.aws.amazon.com/proton/latest/adminguide/resources.html) or AWS Proton User Guide (https://docs.aws.amazon.com/proton/latest/userguide/resources.html).

UpdateAccountSettings

[PipelineServiceRoleArn => Str]

Each argument is described in detail in: Paws::Proton::UpdateAccountSettings

Returns: a Paws::Proton::UpdateAccountSettingsOutput instance

Update the AWS Proton pipeline service account settings.

UpdateEnvironment

DeploymentType => Str
Name => Str
[Description => Str]
[EnvironmentAccountConnectionId => Str]
[ProtonServiceRoleArn => Str]
[Spec => Str]
[TemplateMajorVersion => Str]
[TemplateMinorVersion => Str]

Each argument is described in detail in: Paws::Proton::UpdateEnvironment

Returns: a Paws::Proton::UpdateEnvironmentOutput instance

Update an environment.

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

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

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

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

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

NONE

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

CURRENT_VERSION

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

MINOR_VERSION

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

MAJOR_VERSION

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

UpdateEnvironmentAccountConnection

Id => Str
RoleArn => Str

Each argument is described in detail in: Paws::Proton::UpdateEnvironmentAccountConnection

Returns: a Paws::Proton::UpdateEnvironmentAccountConnectionOutput instance

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

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

UpdateEnvironmentTemplate

Name => Str
[Description => Str]
[DisplayName => Str]

Each argument is described in detail in: Paws::Proton::UpdateEnvironmentTemplate

Returns: a Paws::Proton::UpdateEnvironmentTemplateOutput instance

Update an environment template.

UpdateEnvironmentTemplateVersion

MajorVersion => Str
MinorVersion => Str
TemplateName => Str
[Description => Str]
[Status => Str]

Each argument is described in detail in: Paws::Proton::UpdateEnvironmentTemplateVersion

Returns: a Paws::Proton::UpdateEnvironmentTemplateVersionOutput instance

Update a major or minor version of an environment template.

UpdateService

Name => Str
[Description => Str]
[Spec => Str]

Each argument is described in detail in: Paws::Proton::UpdateService

Returns: a Paws::Proton::UpdateServiceOutput instance

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

Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.

Use the description parameter to modify the description.

Edit the spec parameter to add or delete instances.

UpdateServiceInstance

DeploymentType => Str
Name => Str
ServiceName => Str
[Spec => Str]
[TemplateMajorVersion => Str]
[TemplateMinorVersion => Str]

Each argument is described in detail in: Paws::Proton::UpdateServiceInstance

Returns: a Paws::Proton::UpdateServiceInstanceOutput instance

Update a service instance.

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

NONE

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

CURRENT_VERSION

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

MINOR_VERSION

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

MAJOR_VERSION

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

UpdateServicePipeline

DeploymentType => Str
ServiceName => Str
Spec => Str
[TemplateMajorVersion => Str]
[TemplateMinorVersion => Str]

Each argument is described in detail in: Paws::Proton::UpdateServicePipeline

Returns: a Paws::Proton::UpdateServicePipelineOutput instance

Update the service pipeline.

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

NONE

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

CURRENT_VERSION

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

MINOR_VERSION

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

MAJOR_VERSION

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

UpdateServiceTemplate

Name => Str
[Description => Str]
[DisplayName => Str]

Each argument is described in detail in: Paws::Proton::UpdateServiceTemplate

Returns: a Paws::Proton::UpdateServiceTemplateOutput instance

Update a service template.

UpdateServiceTemplateVersion

MajorVersion => Str
MinorVersion => Str
TemplateName => Str
[CompatibleEnvironmentTemplates => ArrayRef[Paws::Proton::CompatibleEnvironmentTemplateInput]]
[Description => Str]
[Status => Str]

Each argument is described in detail in: Paws::Proton::UpdateServiceTemplateVersion

Returns: a Paws::Proton::UpdateServiceTemplateVersionOutput instance

Update a major or minor version of a service template.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllEnvironmentAccountConnections(sub { },RequestedBy => Str, [EnvironmentName => Str, MaxResults => Int, NextToken => Str, Statuses => ArrayRef[Str|Undef]])

ListAllEnvironmentAccountConnections(RequestedBy => Str, [EnvironmentName => Str, MaxResults => Int, NextToken => Str, Statuses => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - environmentAccountConnections, passing the object as the first parameter, and the string 'environmentAccountConnections' as the second parameter 

If not, it will return a a Paws::Proton::ListEnvironmentAccountConnectionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllEnvironments(sub { },[EnvironmentTemplates => ArrayRef[Paws::Proton::EnvironmentTemplateFilter], MaxResults => Int, NextToken => Str])

ListAllEnvironments([EnvironmentTemplates => ArrayRef[Paws::Proton::EnvironmentTemplateFilter], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - environments, passing the object as the first parameter, and the string 'environments' as the second parameter 

If not, it will return a a Paws::Proton::ListEnvironmentsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllEnvironmentTemplates(sub { },[MaxResults => Int, NextToken => Str])

ListAllEnvironmentTemplates([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - templates, passing the object as the first parameter, and the string 'templates' as the second parameter 

If not, it will return a a Paws::Proton::ListEnvironmentTemplatesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllEnvironmentTemplateVersions(sub { },TemplateName => Str, [MajorVersion => Str, MaxResults => Int, NextToken => Str])

ListAllEnvironmentTemplateVersions(TemplateName => Str, [MajorVersion => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - templateVersions, passing the object as the first parameter, and the string 'templateVersions' as the second parameter 

If not, it will return a a Paws::Proton::ListEnvironmentTemplateVersionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllServiceInstances(sub { },[MaxResults => Int, NextToken => Str, ServiceName => Str])

ListAllServiceInstances([MaxResults => Int, NextToken => Str, ServiceName => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - serviceInstances, passing the object as the first parameter, and the string 'serviceInstances' as the second parameter 

If not, it will return a a Paws::Proton::ListServiceInstancesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllServices(sub { },[MaxResults => Int, NextToken => Str])

ListAllServices([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - services, passing the object as the first parameter, and the string 'services' as the second parameter 

If not, it will return a a Paws::Proton::ListServicesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllServiceTemplates(sub { },[MaxResults => Int, NextToken => Str])

ListAllServiceTemplates([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - templates, passing the object as the first parameter, and the string 'templates' as the second parameter 

If not, it will return a a Paws::Proton::ListServiceTemplatesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllServiceTemplateVersions(sub { },TemplateName => Str, [MajorVersion => Str, MaxResults => Int, NextToken => Str])

ListAllServiceTemplateVersions(TemplateName => Str, [MajorVersion => Str, MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - templateVersions, passing the object as the first parameter, and the string 'templateVersions' as the second parameter 

If not, it will return a a Paws::Proton::ListServiceTemplateVersionsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTagsForResource(sub { },ResourceArn => Str, [MaxResults => Int, NextToken => Str])

ListAllTagsForResource(ResourceArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - tags, passing the object as the first parameter, and the string 'tags' as the second parameter 

If not, it will return a a Paws::Proton::ListTagsForResourceOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues