AcceptEnvironmentAccountConnection

$result = $client->acceptEnvironmentAccountConnection([/* ... */]);
$promise = $client->acceptEnvironmentAccountConnectionAsync([/* ... */]);

In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, 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 Proton User guide.

Parameter Syntax

$result = $client->acceptEnvironmentAccountConnection([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentAccountConnection' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'environmentAccountId' => '<string>',
        'environmentName' => '<string>',
        'id' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'managementAccountId' => '<string>',
        'requestedAt' => <DateTime>,
        'roleArn' => '<string>',
        'status' => 'PENDING|CONNECTED|REJECTED',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CancelComponentDeployment

$result = $client->cancelComponentDeployment([/* ... */]);
$promise = $client->cancelComponentDeploymentAsync([/* ... */]);

Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).

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

Parameter Syntax

$result = $client->cancelComponentDeployment([
    'componentName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'component' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastModifiedAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
        'serviceSpec' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CancelEnvironmentDeployment

$result = $client->cancelEnvironmentDeployment([/* ... */]);
$promise = $client->cancelEnvironmentDeploymentAsync([/* ... */]);

Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS. For more information, see Update an environment in the Proton User guide.

The following list includes potential cancellation scenarios.

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

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

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

Parameter Syntax

$result = $client->cancelEnvironmentDeployment([
    'environmentName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentAccountConnectionId' => '<string>',
        'environmentAccountId' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'protonServiceRoleArn' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'provisioningRepository' => [
            'arn' => '<string>',
            'branch' => '<string>',
            'name' => '<string>',
            'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        ],
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CancelServiceInstanceDeployment

$result = $client->cancelServiceInstanceDeployment([/* ... */]);
$promise = $client->cancelServiceInstanceDeploymentAsync([/* ... */]);

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

The following list includes potential cancellation scenarios.

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

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

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

Parameter Syntax

$result = $client->cancelServiceInstanceDeployment([
    'serviceInstanceName' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceInstance' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceName' => '<string>',
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CancelServicePipelineDeployment

$result = $client->cancelServicePipelineDeployment([/* ... */]);
$promise = $client->cancelServicePipelineDeploymentAsync([/* ... */]);

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

The following list includes potential cancellation scenarios.

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

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

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

Parameter Syntax

$result = $client->cancelServicePipelineDeployment([
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'pipeline' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateComponent

$result = $client->createComponent([/* ... */]);
$promise = $client->createComponentAsync([/* ... */]);

Create an Proton component. A component is an infrastructure extension for a service instance.

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

Parameter Syntax

$result = $client->createComponent([
    'clientToken' => '<string>',
    'description' => '<string>',
    'environmentName' => '<string>',
    'manifest' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'serviceInstanceName' => '<string>',
    'serviceName' => '<string>',
    'serviceSpec' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'templateFile' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'component' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastModifiedAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
        'serviceSpec' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.

You can provision environments using the following methods:

• Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.

• Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.

For more information, see Environments and Provisioning methods in the Proton User Guide.

Parameter Syntax

$result = $client->createEnvironment([
    'codebuildRoleArn' => '<string>',
    'componentRoleArn' => '<string>',
    'description' => '<string>',
    'environmentAccountConnectionId' => '<string>',
    'name' => '<string>', // REQUIRED
    'protonServiceRoleArn' => '<string>',
    'provisioningRepository' => [
        'branch' => '<string>', // REQUIRED
        'name' => '<string>', // REQUIRED
        'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
    ],
    'spec' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'templateMajorVersion' => '<string>', // REQUIRED
    'templateMinorVersion' => '<string>',
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentAccountConnectionId' => '<string>',
        'environmentAccountId' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'protonServiceRoleArn' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'provisioningRepository' => [
            'arn' => '<string>',
            'branch' => '<string>',
            'name' => '<string>',
            'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        ],
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateEnvironmentAccountConnection

$result = $client->createEnvironmentAccountConnection([/* ... */]);
$promise = $client->createEnvironmentAccountConnectionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createEnvironmentAccountConnection([
    'clientToken' => '<string>',
    'codebuildRoleArn' => '<string>',
    'componentRoleArn' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'managementAccountId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'environmentAccountConnection' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'environmentAccountId' => '<string>',
        'environmentName' => '<string>',
        'id' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'managementAccountId' => '<string>',
        'requestedAt' => <DateTime>,
        'roleArn' => '<string>',
        'status' => 'PENDING|CONNECTED|REJECTED',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

InternalServerException:

The request failed to register with the service.

CreateEnvironmentTemplate

$result = $client->createEnvironmentTemplate([/* ... */]);
$promise = $client->createEnvironmentTemplateAsync([/* ... */]);

Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide.

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

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

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

Parameter Syntax

$result = $client->createEnvironmentTemplate([
    'description' => '<string>',
    'displayName' => '<string>',
    'encryptionKey' => '<string>',
    'name' => '<string>', // REQUIRED
    'provisioning' => 'CUSTOMER_MANAGED',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'environmentTemplate' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'displayName' => '<string>',
        'encryptionKey' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'recommendedVersion' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

InternalServerException:

The request failed to register with the service.

CreateEnvironmentTemplateVersion

$result = $client->createEnvironmentTemplateVersion([/* ... */]);
$promise = $client->createEnvironmentTemplateVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createEnvironmentTemplateVersion([
    'clientToken' => '<string>',
    'description' => '<string>',
    'majorVersion' => '<string>',
    'source' => [ // REQUIRED
        's3' => [
            'bucket' => '<string>', // REQUIRED
            'key' => '<string>', // REQUIRED
        ],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentTemplateVersion' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'majorVersion' => '<string>',
        'minorVersion' => '<string>',
        'recommendedMinorVersion' => '<string>',
        'schema' => '<string>',
        'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
        'statusMessage' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateRepository

$result = $client->createRepository([/* ... */]);
$promise = $client->createRepositoryAsync([/* ... */]);

Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed provisioning, or synced templates). When you create a repository link, Proton creates a service-linked role for you.

For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton User Guide.

Parameter Syntax

$result = $client->createRepository([
    'connectionArn' => '<string>', // REQUIRED
    'encryptionKey' => '<string>',
    'name' => '<string>', // REQUIRED
    'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'arn' => '<string>',
        'connectionArn' => '<string>',
        'encryptionKey' => '<string>',
        'name' => '<string>',
        'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

InternalServerException:

The request failed to register with the service.

CreateService

$result = $client->createService([/* ... */]);
$promise = $client->createServiceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createService([
    'branchName' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'repositoryConnectionArn' => '<string>',
    'repositoryId' => '<string>',
    'spec' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'templateMajorVersion' => '<string>', // REQUIRED
    'templateMinorVersion' => '<string>',
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'service' => [
        'arn' => '<string>',
        'branchName' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'pipeline' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'deploymentStatusMessage' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastDeploymentAttemptedAt' => <DateTime>,
            'lastDeploymentSucceededAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'spec' => '<string>',
            'templateMajorVersion' => '<string>',
            'templateMinorVersion' => '<string>',
            'templateName' => '<string>',
        ],
        'repositoryConnectionArn' => '<string>',
        'repositoryId' => '<string>',
        'spec' => '<string>',
        'status' => '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>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateServiceInstance

$result = $client->createServiceInstance([/* ... */]);
$promise = $client->createServiceInstanceAsync([/* ... */]);

Create a service instance.

Parameter Syntax

$result = $client->createServiceInstance([
    'clientToken' => '<string>',
    'name' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
    'spec' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'templateMajorVersion' => '<string>',
    'templateMinorVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'serviceInstance' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceName' => '<string>',
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateServiceSyncConfig

$result = $client->createServiceSyncConfig([/* ... */]);
$promise = $client->createServiceSyncConfigAsync([/* ... */]);

Create the Proton Ops configuration file.

Parameter Syntax

$result = $client->createServiceSyncConfig([
    'branch' => '<string>', // REQUIRED
    'filePath' => '<string>', // REQUIRED
    'repositoryName' => '<string>', // REQUIRED
    'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceSyncConfig' => [
        'branch' => '<string>',
        'filePath' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'serviceName' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

InternalServerException:

The request failed to register with the service.

CreateServiceTemplate

$result = $client->createServiceTemplate([/* ... */]);
$promise = $client->createServiceTemplateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createServiceTemplate([
    'description' => '<string>',
    'displayName' => '<string>',
    'encryptionKey' => '<string>',
    'name' => '<string>', // REQUIRED
    'pipelineProvisioning' => 'CUSTOMER_MANAGED',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'serviceTemplate' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'displayName' => '<string>',
        'encryptionKey' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'pipelineProvisioning' => 'CUSTOMER_MANAGED',
        'recommendedVersion' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

InternalServerException:

The request failed to register with the service.

CreateServiceTemplateVersion

$result = $client->createServiceTemplateVersion([/* ... */]);
$promise = $client->createServiceTemplateVersionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createServiceTemplateVersion([
    'clientToken' => '<string>',
    'compatibleEnvironmentTemplates' => [ // REQUIRED
        [
            'majorVersion' => '<string>', // REQUIRED
            'templateName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'majorVersion' => '<string>',
    'source' => [ // REQUIRED
        's3' => [
            'bucket' => '<string>', // REQUIRED
            'key' => '<string>', // REQUIRED
        ],
    ],
    'supportedComponentSources' => ['<string>', ...],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceTemplateVersion' => [
        'arn' => '<string>',
        'compatibleEnvironmentTemplates' => [
            [
                'majorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'majorVersion' => '<string>',
        'minorVersion' => '<string>',
        'recommendedMinorVersion' => '<string>',
        'schema' => '<string>',
        'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
        'statusMessage' => '<string>',
        'supportedComponentSources' => ['<string>', ...],
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

CreateTemplateSyncConfig

$result = $client->createTemplateSyncConfig([/* ... */]);
$promise = $client->createTemplateSyncConfigAsync([/* ... */]);

Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton User Guide.

Parameter Syntax

$result = $client->createTemplateSyncConfig([
    'branch' => '<string>', // REQUIRED
    'repositoryName' => '<string>', // REQUIRED
    'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
    'subdirectory' => '<string>',
    'templateName' => '<string>', // REQUIRED
    'templateType' => 'ENVIRONMENT|SERVICE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'templateSyncConfig' => [
        'branch' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'subdirectory' => '<string>',
        'templateName' => '<string>',
        'templateType' => 'ENVIRONMENT|SERVICE',
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

A quota was exceeded. For more information, see Proton Quotas in the Proton User Guide.

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

InternalServerException:

The request failed to register with the service.

DeleteComponent

$result = $client->deleteComponent([/* ... */]);
$promise = $client->deleteComponentAsync([/* ... */]);

Delete an Proton component resource.

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

Parameter Syntax

$result = $client->deleteComponent([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'component' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastModifiedAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
        'serviceSpec' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteDeployment

$result = $client->deleteDeployment([/* ... */]);
$promise = $client->deleteDeploymentAsync([/* ... */]);

Delete the deployment.

Parameter Syntax

$result = $client->deleteDeployment([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deployment' => [
        'arn' => '<string>',
        'completedAt' => <DateTime>,
        'componentName' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'environmentName' => '<string>',
        'id' => '<string>',
        'initialState' => [
            'component' => [
                'serviceInstanceName' => '<string>',
                'serviceName' => '<string>',
                'serviceSpec' => '<string>',
                'templateFile' => '<string>',
            ],
            'environment' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'serviceInstance' => [
                'lastSuccessfulComponentDeploymentIds' => ['<string>', ...],
                'lastSuccessfulEnvironmentDeploymentId' => '<string>',
                'lastSuccessfulServicePipelineDeploymentId' => '<string>',
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'servicePipeline' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
        ],
        'lastAttemptedDeploymentId' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
        'targetArn' => '<string>',
        'targetResourceCreatedAt' => <DateTime>,
        'targetResourceType' => 'ENVIRONMENT|SERVICE_PIPELINE|SERVICE_INSTANCE|COMPONENT',
        'targetState' => [
            'component' => [
                'serviceInstanceName' => '<string>',
                'serviceName' => '<string>',
                'serviceSpec' => '<string>',
                'templateFile' => '<string>',
            ],
            'environment' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'serviceInstance' => [
                'lastSuccessfulComponentDeploymentIds' => ['<string>', ...],
                'lastSuccessfulEnvironmentDeploymentId' => '<string>',
                'lastSuccessfulServicePipelineDeploymentId' => '<string>',
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'servicePipeline' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

Delete an environment.

Parameter Syntax

$result = $client->deleteEnvironment([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentAccountConnectionId' => '<string>',
        'environmentAccountId' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'protonServiceRoleArn' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'provisioningRepository' => [
            'arn' => '<string>',
            'branch' => '<string>',
            'name' => '<string>',
            'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        ],
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteEnvironmentAccountConnection

$result = $client->deleteEnvironmentAccountConnection([/* ... */]);
$promise = $client->deleteEnvironmentAccountConnectionAsync([/* ... */]);

In an environment account, delete an environment account connection.

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

Parameter Syntax

$result = $client->deleteEnvironmentAccountConnection([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentAccountConnection' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'environmentAccountId' => '<string>',
        'environmentName' => '<string>',
        'id' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'managementAccountId' => '<string>',
        'requestedAt' => <DateTime>,
        'roleArn' => '<string>',
        'status' => 'PENDING|CONNECTED|REJECTED',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteEnvironmentTemplate

$result = $client->deleteEnvironmentTemplate([/* ... */]);
$promise = $client->deleteEnvironmentTemplateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteEnvironmentTemplate([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentTemplate' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'displayName' => '<string>',
        'encryptionKey' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'recommendedVersion' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteEnvironmentTemplateVersion

$result = $client->deleteEnvironmentTemplateVersion([/* ... */]);
$promise = $client->deleteEnvironmentTemplateVersionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteEnvironmentTemplateVersion([
    'majorVersion' => '<string>', // REQUIRED
    'minorVersion' => '<string>', // REQUIRED
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentTemplateVersion' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'majorVersion' => '<string>',
        'minorVersion' => '<string>',
        'recommendedMinorVersion' => '<string>',
        'schema' => '<string>',
        'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
        'statusMessage' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteRepository

$result = $client->deleteRepository([/* ... */]);
$promise = $client->deleteRepositoryAsync([/* ... */]);

De-register and unlink your repository.

Parameter Syntax

$result = $client->deleteRepository([
    'name' => '<string>', // REQUIRED
    'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'arn' => '<string>',
        'connectionArn' => '<string>',
        'encryptionKey' => '<string>',
        'name' => '<string>',
        'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteService

$result = $client->deleteService([/* ... */]);
$promise = $client->deleteServiceAsync([/* ... */]);

Delete a service, with its instances and pipeline.

Parameter Syntax

$result = $client->deleteService([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'service' => [
        'arn' => '<string>',
        'branchName' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'pipeline' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'deploymentStatusMessage' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastDeploymentAttemptedAt' => <DateTime>,
            'lastDeploymentSucceededAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'spec' => '<string>',
            'templateMajorVersion' => '<string>',
            'templateMinorVersion' => '<string>',
            'templateName' => '<string>',
        ],
        'repositoryConnectionArn' => '<string>',
        'repositoryId' => '<string>',
        'spec' => '<string>',
        'status' => '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>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteServiceSyncConfig

$result = $client->deleteServiceSyncConfig([/* ... */]);
$promise = $client->deleteServiceSyncConfigAsync([/* ... */]);

Delete the Proton Ops file.

Parameter Syntax

$result = $client->deleteServiceSyncConfig([
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceSyncConfig' => [
        'branch' => '<string>',
        'filePath' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'serviceName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteServiceTemplate

$result = $client->deleteServiceTemplate([/* ... */]);
$promise = $client->deleteServiceTemplateAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteServiceTemplate([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceTemplate' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'displayName' => '<string>',
        'encryptionKey' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'pipelineProvisioning' => 'CUSTOMER_MANAGED',
        'recommendedVersion' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteServiceTemplateVersion

$result = $client->deleteServiceTemplateVersion([/* ... */]);
$promise = $client->deleteServiceTemplateVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteServiceTemplateVersion([
    'majorVersion' => '<string>', // REQUIRED
    'minorVersion' => '<string>', // REQUIRED
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceTemplateVersion' => [
        'arn' => '<string>',
        'compatibleEnvironmentTemplates' => [
            [
                'majorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'majorVersion' => '<string>',
        'minorVersion' => '<string>',
        'recommendedMinorVersion' => '<string>',
        'schema' => '<string>',
        'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
        'statusMessage' => '<string>',
        'supportedComponentSources' => ['<string>', ...],
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

DeleteTemplateSyncConfig

$result = $client->deleteTemplateSyncConfig([/* ... */]);
$promise = $client->deleteTemplateSyncConfigAsync([/* ... */]);

Delete a template sync configuration.

Parameter Syntax

$result = $client->deleteTemplateSyncConfig([
    'templateName' => '<string>', // REQUIRED
    'templateType' => 'ENVIRONMENT|SERVICE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'templateSyncConfig' => [
        'branch' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'subdirectory' => '<string>',
        'templateName' => '<string>',
        'templateType' => 'ENVIRONMENT|SERVICE',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

The request couldn't be made due to a conflicting operation or resource.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetAccountSettings

$result = $client->getAccountSettings([/* ... */]);
$promise = $client->getAccountSettingsAsync([/* ... */]);

Get detail data for Proton account-wide settings.

Parameter Syntax

$result = $client->getAccountSettings([
]);

Parameter Details

Result Syntax

[
    'accountSettings' => [
        'pipelineCodebuildRoleArn' => '<string>',
        'pipelineProvisioningRepository' => [
            'arn' => '<string>',
            'branch' => '<string>',
            'name' => '<string>',
            'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        ],
        'pipelineServiceRoleArn' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetComponent

$result = $client->getComponent([/* ... */]);
$promise = $client->getComponentAsync([/* ... */]);

Get detailed data for a component.

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

Parameter Syntax

$result = $client->getComponent([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'component' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastModifiedAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
        'serviceSpec' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetDeployment

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Get detailed data for a deployment.

Parameter Syntax

$result = $client->getDeployment([
    'componentName' => '<string>',
    'environmentName' => '<string>',
    'id' => '<string>', // REQUIRED
    'serviceInstanceName' => '<string>',
    'serviceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deployment' => [
        'arn' => '<string>',
        'completedAt' => <DateTime>,
        'componentName' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'environmentName' => '<string>',
        'id' => '<string>',
        'initialState' => [
            'component' => [
                'serviceInstanceName' => '<string>',
                'serviceName' => '<string>',
                'serviceSpec' => '<string>',
                'templateFile' => '<string>',
            ],
            'environment' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'serviceInstance' => [
                'lastSuccessfulComponentDeploymentIds' => ['<string>', ...],
                'lastSuccessfulEnvironmentDeploymentId' => '<string>',
                'lastSuccessfulServicePipelineDeploymentId' => '<string>',
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'servicePipeline' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
        ],
        'lastAttemptedDeploymentId' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
        'targetArn' => '<string>',
        'targetResourceCreatedAt' => <DateTime>,
        'targetResourceType' => 'ENVIRONMENT|SERVICE_PIPELINE|SERVICE_INSTANCE|COMPONENT',
        'targetState' => [
            'component' => [
                'serviceInstanceName' => '<string>',
                'serviceName' => '<string>',
                'serviceSpec' => '<string>',
                'templateFile' => '<string>',
            ],
            'environment' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'serviceInstance' => [
                'lastSuccessfulComponentDeploymentIds' => ['<string>', ...],
                'lastSuccessfulEnvironmentDeploymentId' => '<string>',
                'lastSuccessfulServicePipelineDeploymentId' => '<string>',
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            'servicePipeline' => [
                'spec' => '<string>',
                'templateMajorVersion' => '<string>',
                'templateMinorVersion' => '<string>',
                'templateName' => '<string>',
            ],
        ],
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Get detailed data for an environment.

Parameter Syntax

$result = $client->getEnvironment([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environment' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'description' => '<string>',
        'environmentAccountConnectionId' => '<string>',
        'environmentAccountId' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'protonServiceRoleArn' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'provisioningRepository' => [
            'arn' => '<string>',
            'branch' => '<string>',
            'name' => '<string>',
            'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        ],
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetEnvironmentAccountConnection

$result = $client->getEnvironmentAccountConnection([/* ... */]);
$promise = $client->getEnvironmentAccountConnectionAsync([/* ... */]);

In an environment account, get the detailed data for an environment account connection.

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

Parameter Syntax

$result = $client->getEnvironmentAccountConnection([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentAccountConnection' => [
        'arn' => '<string>',
        'codebuildRoleArn' => '<string>',
        'componentRoleArn' => '<string>',
        'environmentAccountId' => '<string>',
        'environmentName' => '<string>',
        'id' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'managementAccountId' => '<string>',
        'requestedAt' => <DateTime>,
        'roleArn' => '<string>',
        'status' => 'PENDING|CONNECTED|REJECTED',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetEnvironmentTemplate

$result = $client->getEnvironmentTemplate([/* ... */]);
$promise = $client->getEnvironmentTemplateAsync([/* ... */]);

Get detailed data for an environment template.

Parameter Syntax

$result = $client->getEnvironmentTemplate([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentTemplate' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'displayName' => '<string>',
        'encryptionKey' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'provisioning' => 'CUSTOMER_MANAGED',
        'recommendedVersion' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetEnvironmentTemplateVersion

$result = $client->getEnvironmentTemplateVersion([/* ... */]);
$promise = $client->getEnvironmentTemplateVersionAsync([/* ... */]);

Get detailed data for a major or minor version of an environment template.

Parameter Syntax

$result = $client->getEnvironmentTemplateVersion([
    'majorVersion' => '<string>', // REQUIRED
    'minorVersion' => '<string>', // REQUIRED
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'environmentTemplateVersion' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'majorVersion' => '<string>',
        'minorVersion' => '<string>',
        'recommendedMinorVersion' => '<string>',
        'schema' => '<string>',
        'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
        'statusMessage' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetRepository

$result = $client->getRepository([/* ... */]);
$promise = $client->getRepositoryAsync([/* ... */]);

Get detail data for a linked repository.

Parameter Syntax

$result = $client->getRepository([
    'name' => '<string>', // REQUIRED
    'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'arn' => '<string>',
        'connectionArn' => '<string>',
        'encryptionKey' => '<string>',
        'name' => '<string>',
        'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetRepositorySyncStatus

$result = $client->getRepositorySyncStatus([/* ... */]);
$promise = $client->getRepositorySyncStatusAsync([/* ... */]);

Get the sync status of a repository used for Proton template sync. For more information about template sync, see .

Parameter Syntax

$result = $client->getRepositorySyncStatus([
    'branch' => '<string>', // REQUIRED
    'repositoryName' => '<string>', // REQUIRED
    'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
    'syncType' => 'TEMPLATE_SYNC|SERVICE_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'latestSync' => [
        'events' => [
            [
                'event' => '<string>',
                'externalId' => '<string>',
                'time' => <DateTime>,
                'type' => '<string>',
            ],
            // ...
        ],
        'startedAt' => <DateTime>,
        'status' => 'INITIATED|IN_PROGRESS|SUCCEEDED|FAILED|QUEUED',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetResourcesSummary

$result = $client->getResourcesSummary([/* ... */]);
$promise = $client->getResourcesSummaryAsync([/* ... */]);

Get counts of Proton resources.

For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it uses and it needs an update to become current.

The action returns staleness counts (counts of resources that are up-to-date, behind a template major version, or behind a template minor version), the total number of resources, and the number of resources that are in a failed state, grouped by resource type. Components, environments, and service templates return less information - see the components, environments, and serviceTemplates field descriptions.

For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.

For more information, see Proton dashboard in the Proton User Guide.

Parameter Syntax

$result = $client->getResourcesSummary([
]);

Parameter Details

Result Syntax

[
    'counts' => [
        'components' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
        'environmentTemplates' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
        'environments' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
        'pipelines' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
        'serviceInstances' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
        'serviceTemplates' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
        'services' => [
            'behindMajor' => <integer>,
            'behindMinor' => <integer>,
            'failed' => <integer>,
            'total' => <integer>,
            'upToDate' => <integer>,
        ],
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request failed to register with the service.

GetService

$result = $client->getService([/* ... */]);
$promise = $client->getServiceAsync([/* ... */]);

Get detailed data for a service.

Parameter Syntax

$result = $client->getService([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'service' => [
        'arn' => '<string>',
        'branchName' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'pipeline' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'deploymentStatusMessage' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastDeploymentAttemptedAt' => <DateTime>,
            'lastDeploymentSucceededAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'spec' => '<string>',
            'templateMajorVersion' => '<string>',
            'templateMinorVersion' => '<string>',
            'templateName' => '<string>',
        ],
        'repositoryConnectionArn' => '<string>',
        'repositoryId' => '<string>',
        'spec' => '<string>',
        'status' => '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>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetServiceInstance

$result = $client->getServiceInstance([/* ... */]);
$promise = $client->getServiceInstanceAsync([/* ... */]);

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

Parameter Syntax

$result = $client->getServiceInstance([
    'name' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceInstance' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
        'deploymentStatusMessage' => '<string>',
        'environmentName' => '<string>',
        'lastAttemptedDeploymentId' => '<string>',
        'lastClientRequestToken' => '<string>',
        'lastDeploymentAttemptedAt' => <DateTime>,
        'lastDeploymentSucceededAt' => <DateTime>,
        'lastSucceededDeploymentId' => '<string>',
        'name' => '<string>',
        'serviceName' => '<string>',
        'spec' => '<string>',
        'templateMajorVersion' => '<string>',
        'templateMinorVersion' => '<string>',
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetServiceInstanceSyncStatus

$result = $client->getServiceInstanceSyncStatus([/* ... */]);
$promise = $client->getServiceInstanceSyncStatusAsync([/* ... */]);

Get the status of the synced service instance.

Parameter Syntax

$result = $client->getServiceInstanceSyncStatus([
    'serviceInstanceName' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'desiredState' => [
        'branch' => '<string>',
        'directory' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'sha' => '<string>',
    ],
    'latestSuccessfulSync' => [
        'events' => [
            [
                'event' => '<string>',
                'externalId' => '<string>',
                'time' => <DateTime>,
                'type' => '<string>',
            ],
            // ...
        ],
        'initialRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
        'startedAt' => <DateTime>,
        'status' => 'INITIATED|IN_PROGRESS|SUCCEEDED|FAILED',
        'target' => '<string>',
        'targetRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
    ],
    'latestSync' => [
        'events' => [
            [
                'event' => '<string>',
                'externalId' => '<string>',
                'time' => <DateTime>,
                'type' => '<string>',
            ],
            // ...
        ],
        'initialRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
        'startedAt' => <DateTime>,
        'status' => 'INITIATED|IN_PROGRESS|SUCCEEDED|FAILED',
        'target' => '<string>',
        'targetRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetServiceSyncBlockerSummary

$result = $client->getServiceSyncBlockerSummary([/* ... */]);
$promise = $client->getServiceSyncBlockerSummaryAsync([/* ... */]);

Get detailed data for the service sync blocker summary.

Parameter Syntax

$result = $client->getServiceSyncBlockerSummary([
    'serviceInstanceName' => '<string>',
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceSyncBlockerSummary' => [
        'latestBlockers' => [
            [
                'contexts' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'createdAt' => <DateTime>,
                'createdReason' => '<string>',
                'id' => '<string>',
                'resolvedAt' => <DateTime>,
                'resolvedReason' => '<string>',
                'status' => 'ACTIVE|RESOLVED',
                'type' => 'AUTOMATED',
            ],
            // ...
        ],
        'serviceInstanceName' => '<string>',
        'serviceName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetServiceSyncConfig

$result = $client->getServiceSyncConfig([/* ... */]);
$promise = $client->getServiceSyncConfigAsync([/* ... */]);

Get detailed information for the service sync configuration.

Parameter Syntax

$result = $client->getServiceSyncConfig([
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceSyncConfig' => [
        'branch' => '<string>',
        'filePath' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'serviceName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetServiceTemplate

$result = $client->getServiceTemplate([/* ... */]);
$promise = $client->getServiceTemplateAsync([/* ... */]);

Get detailed data for a service template.

Parameter Syntax

$result = $client->getServiceTemplate([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceTemplate' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'displayName' => '<string>',
        'encryptionKey' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'name' => '<string>',
        'pipelineProvisioning' => 'CUSTOMER_MANAGED',
        'recommendedVersion' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetServiceTemplateVersion

$result = $client->getServiceTemplateVersion([/* ... */]);
$promise = $client->getServiceTemplateVersionAsync([/* ... */]);

Get detailed data for a major or minor version of a service template.

Parameter Syntax

$result = $client->getServiceTemplateVersion([
    'majorVersion' => '<string>', // REQUIRED
    'minorVersion' => '<string>', // REQUIRED
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'serviceTemplateVersion' => [
        'arn' => '<string>',
        'compatibleEnvironmentTemplates' => [
            [
                'majorVersion' => '<string>',
                'templateName' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'lastModifiedAt' => <DateTime>,
        'majorVersion' => '<string>',
        'minorVersion' => '<string>',
        'recommendedMinorVersion' => '<string>',
        'schema' => '<string>',
        'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
        'statusMessage' => '<string>',
        'supportedComponentSources' => ['<string>', ...],
        'templateName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetTemplateSyncConfig

$result = $client->getTemplateSyncConfig([/* ... */]);
$promise = $client->getTemplateSyncConfigAsync([/* ... */]);

Get detail data for a template sync configuration.

Parameter Syntax

$result = $client->getTemplateSyncConfig([
    'templateName' => '<string>', // REQUIRED
    'templateType' => 'ENVIRONMENT|SERVICE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'templateSyncConfig' => [
        'branch' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'subdirectory' => '<string>',
        'templateName' => '<string>',
        'templateType' => 'ENVIRONMENT|SERVICE',
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

GetTemplateSyncStatus

$result = $client->getTemplateSyncStatus([/* ... */]);
$promise = $client->getTemplateSyncStatusAsync([/* ... */]);

Get the status of a template sync.

Parameter Syntax

$result = $client->getTemplateSyncStatus([
    'templateName' => '<string>', // REQUIRED
    'templateType' => 'ENVIRONMENT|SERVICE', // REQUIRED
    'templateVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'desiredState' => [
        'branch' => '<string>',
        'directory' => '<string>',
        'repositoryName' => '<string>',
        'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        'sha' => '<string>',
    ],
    'latestSuccessfulSync' => [
        'events' => [
            [
                'event' => '<string>',
                'externalId' => '<string>',
                'time' => <DateTime>,
                'type' => '<string>',
            ],
            // ...
        ],
        'initialRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
        'startedAt' => <DateTime>,
        'status' => 'INITIATED|IN_PROGRESS|SUCCEEDED|FAILED',
        'target' => '<string>',
        'targetRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
    ],
    'latestSync' => [
        'events' => [
            [
                'event' => '<string>',
                'externalId' => '<string>',
                'time' => <DateTime>,
                'type' => '<string>',
            ],
            // ...
        ],
        'initialRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
        'startedAt' => <DateTime>,
        'status' => 'INITIATED|IN_PROGRESS|SUCCEEDED|FAILED',
        'target' => '<string>',
        'targetRevision' => [
            'branch' => '<string>',
            'directory' => '<string>',
            'repositoryName' => '<string>',
            'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
            'sha' => '<string>',
        ],
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListComponentOutputs

$result = $client->listComponentOutputs([/* ... */]);
$promise = $client->listComponentOutputsAsync([/* ... */]);

Get a list of component Infrastructure as Code (IaC) outputs.

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

Parameter Syntax

$result = $client->listComponentOutputs([
    'componentName' => '<string>', // REQUIRED
    'deploymentId' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'outputs' => [
        [
            'key' => '<string>',
            'valueString' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListComponentProvisionedResources

$result = $client->listComponentProvisionedResources([/* ... */]);
$promise = $client->listComponentProvisionedResourcesAsync([/* ... */]);

List provisioned resources for a component with details.

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

Parameter Syntax

$result = $client->listComponentProvisionedResources([
    'componentName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'provisionedResources' => [
        [
            'identifier' => '<string>',
            'name' => '<string>',
            'provisioningEngine' => 'CLOUDFORMATION|TERRAFORM',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListComponents

$result = $client->listComponents([/* ... */]);
$promise = $client->listComponentsAsync([/* ... */]);

List components with summary data. You can filter the result list by environment, service, or a single service instance.

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

Parameter Syntax

$result = $client->listComponents([
    'environmentName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceInstanceName' => '<string>',
    'serviceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'components' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'deploymentStatusMessage' => '<string>',
            'environmentName' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastDeploymentAttemptedAt' => <DateTime>,
            'lastDeploymentSucceededAt' => <DateTime>,
            'lastModifiedAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'name' => '<string>',
            'serviceInstanceName' => '<string>',
            'serviceName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request failed to register with the service.

ListDeployments

$result = $client->listDeployments([/* ... */]);
$promise = $client->listDeploymentsAsync([/* ... */]);

List deployments. You can filter the result list by environment, service, or a single service instance.

Parameter Syntax

$result = $client->listDeployments([
    'componentName' => '<string>',
    'environmentName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceInstanceName' => '<string>',
    'serviceName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deployments' => [
        [
            'arn' => '<string>',
            'completedAt' => <DateTime>,
            'componentName' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'environmentName' => '<string>',
            'id' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastModifiedAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'serviceInstanceName' => '<string>',
            'serviceName' => '<string>',
            'targetArn' => '<string>',
            'targetResourceCreatedAt' => <DateTime>,
            'targetResourceType' => 'ENVIRONMENT|SERVICE_PIPELINE|SERVICE_INSTANCE|COMPONENT',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListEnvironmentAccountConnections

$result = $client->listEnvironmentAccountConnections([/* ... */]);
$promise = $client->listEnvironmentAccountConnectionsAsync([/* ... */]);

View a list of environment account connections.

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

Parameter Syntax

$result = $client->listEnvironmentAccountConnections([
    'environmentName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'requestedBy' => 'MANAGEMENT_ACCOUNT|ENVIRONMENT_ACCOUNT', // REQUIRED
    'statuses' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'environmentAccountConnections' => [
        [
            'arn' => '<string>',
            'componentRoleArn' => '<string>',
            'environmentAccountId' => '<string>',
            'environmentName' => '<string>',
            'id' => '<string>',
            'lastModifiedAt' => <DateTime>,
            'managementAccountId' => '<string>',
            'requestedAt' => <DateTime>,
            'roleArn' => '<string>',
            'status' => 'PENDING|CONNECTED|REJECTED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request failed to register with the service.

ListEnvironmentOutputs

$result = $client->listEnvironmentOutputs([/* ... */]);
$promise = $client->listEnvironmentOutputsAsync([/* ... */]);

List the infrastructure as code outputs for your environment.

Parameter Syntax

$result = $client->listEnvironmentOutputs([
    'deploymentId' => '<string>',
    'environmentName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'outputs' => [
        [
            'key' => '<string>',
            'valueString' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListEnvironmentProvisionedResources

$result = $client->listEnvironmentProvisionedResources([/* ... */]);
$promise = $client->listEnvironmentProvisionedResourcesAsync([/* ... */]);

List the provisioned resources for your environment.

Parameter Syntax

$result = $client->listEnvironmentProvisionedResources([
    'environmentName' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'provisionedResources' => [
        [
            'identifier' => '<string>',
            'name' => '<string>',
            'provisioningEngine' => 'CLOUDFORMATION|TERRAFORM',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListEnvironmentTemplateVersions

$result = $client->listEnvironmentTemplateVersions([/* ... */]);
$promise = $client->listEnvironmentTemplateVersionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEnvironmentTemplateVersions([
    'majorVersion' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'templateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'templateVersions' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'lastModifiedAt' => <DateTime>,
            'majorVersion' => '<string>',
            'minorVersion' => '<string>',
            'recommendedMinorVersion' => '<string>',
            'status' => 'REGISTRATION_IN_PROGRESS|REGISTRATION_FAILED|DRAFT|PUBLISHED',
            'statusMessage' => '<string>',
            'templateName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListEnvironmentTemplates

$result = $client->listEnvironmentTemplates([/* ... */]);
$promise = $client->listEnvironmentTemplatesAsync([/* ... */]);

List environment templates.

Parameter Syntax

$result = $client->listEnvironmentTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'templates' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'displayName' => '<string>',
            'lastModifiedAt' => <DateTime>,
            'name' => '<string>',
            'provisioning' => 'CUSTOMER_MANAGED',
            'recommendedVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request failed to register with the service.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

List environments with detail data summaries.

Parameter Syntax

$result = $client->listEnvironments([
    'environmentTemplates' => [
        [
            'majorVersion' => '<string>', // REQUIRED
            'templateName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'environments' => [
        [
            'arn' => '<string>',
            'componentRoleArn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'deploymentStatusMessage' => '<string>',
            'description' => '<string>',
            'environmentAccountConnectionId' => '<string>',
            'environmentAccountId' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastDeploymentAttemptedAt' => <DateTime>,
            'lastDeploymentSucceededAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'name' => '<string>',
            'protonServiceRoleArn' => '<string>',
            'provisioning' => 'CUSTOMER_MANAGED',
            'templateMajorVersion' => '<string>',
            'templateMinorVersion' => '<string>',
            'templateName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListRepositories

$result = $client->listRepositories([/* ... */]);
$promise = $client->listRepositoriesAsync([/* ... */]);

List linked repositories with detail data.

Parameter Syntax

$result = $client->listRepositories([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'arn' => '<string>',
            'connectionArn' => '<string>',
            'name' => '<string>',
            'provider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListRepositorySyncDefinitions

$result = $client->listRepositorySyncDefinitions([/* ... */]);
$promise = $client->listRepositorySyncDefinitionsAsync([/* ... */]);

List repository sync definitions with detail data.

Parameter Syntax

$result = $client->listRepositorySyncDefinitions([
    'nextToken' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
    'repositoryProvider' => 'GITHUB|GITHUB_ENTERPRISE|BITBUCKET', // REQUIRED
    'syncType' => 'TEMPLATE_SYNC|SERVICE_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'syncDefinitions' => [
        [
            'branch' => '<string>',
            'directory' => '<string>',
            'parent' => '<string>',
            'target' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

The request failed to register with the service.

ListServiceInstanceOutputs

$result = $client->listServiceInstanceOutputs([/* ... */]);
$promise = $client->listServiceInstanceOutputsAsync([/* ... */]);

Get a list service of instance Infrastructure as Code (IaC) outputs.

Parameter Syntax

$result = $client->listServiceInstanceOutputs([
    'deploymentId' => '<string>',
    'nextToken' => '<string>',
    'serviceInstanceName' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'outputs' => [
        [
            'key' => '<string>',
            'valueString' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListServiceInstanceProvisionedResources

$result = $client->listServiceInstanceProvisionedResources([/* ... */]);
$promise = $client->listServiceInstanceProvisionedResourcesAsync([/* ... */]);

List provisioned resources for a service instance with details.

Parameter Syntax

$result = $client->listServiceInstanceProvisionedResources([
    'nextToken' => '<string>',
    'serviceInstanceName' => '<string>', // REQUIRED
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'provisionedResources' => [
        [
            'identifier' => '<string>',
            'name' => '<string>',
            'provisioningEngine' => 'CLOUDFORMATION|TERRAFORM',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListServiceInstances

$result = $client->listServiceInstances([/* ... */]);
$promise = $client->listServiceInstancesAsync([/* ... */]);

List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.

Parameter Syntax

$result = $client->listServiceInstances([
    'filters' => [
        [
            'key' => 'name|deploymentStatus|templateName|serviceName|deployedTemplateVersionStatus|environmentName|lastDeploymentAttemptedAtBefore|lastDeploymentAttemptedAtAfter|createdAtBefore|createdAtAfter',
            'value' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceName' => '<string>',
    'sortBy' => 'name|deploymentStatus|templateName|serviceName|environmentName|lastDeploymentAttemptedAt|createdAt',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'serviceInstances' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deploymentStatus' => 'IN_PROGRESS|FAILED|SUCCEEDED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETE_COMPLETE|CANCELLING|CANCELLED',
            'deploymentStatusMessage' => '<string>',
            'environmentName' => '<string>',
            'lastAttemptedDeploymentId' => '<string>',
            'lastDeploymentAttemptedAt' => <DateTime>,
            'lastDeploymentSucceededAt' => <DateTime>,
            'lastSucceededDeploymentId' => '<string>',
            'name' => '<string>',
            'serviceName' => '<string>',
            'templateMajorVersion' => '<string>',
            'templateMinorVersion' => '<string>',
            'templateName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input is invalid or an out-of-range value was supplied for the input parameter.

AccessDeniedException:

There isn't sufficient access for performing this action.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The requested resource wasn't found.

InternalServerException:

The request failed to register with the service.

ListServicePipelineOutputs

$result = $client->listServicePipelineOutputs([/* ... */]);
$promise = $client->listServicePipelineOutputsAsync([/* ... */]);

Get a list of service pipeline Infrastructure as Code (IaC) outputs.

Parameter Syntax

$result = $client->listServicePipelineOutputs([
    'deploymentId' => '<string>',
    'nextToken' => '<string>',
    'serviceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'outputs' => [
        [
            'key' => '<string>',
            'valueString' => '<string>',
        ],
        // ...
    ],
]

Result Details