@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSProton extends Object implements AWSProton
AWSProton. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic AcceptEnvironmentAccountConnectionResult acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest request)
AWSProtonIn a management account, an environment account connection request is accepted. When the environment account connection request is accepted, AWS Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
For more information, see Environment account connections in the AWS Proton Administrator guide.
acceptEnvironmentAccountConnection in interface AWSProtonpublic CancelEnvironmentDeploymentResult cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest request)
AWSProton
Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is
IN_PROGRESS. For more information, see Update an environment in the
AWS Proton Administrator 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.
cancelEnvironmentDeployment in interface AWSProtonpublic CancelServiceInstanceDeploymentResult cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest request)
AWSProton
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is
IN_PROGRESS. For more information, see Update a service instance in the AWS Proton Administrator
guide or the AWS
Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED and the cancellation attempt has no effect.
cancelServiceInstanceDeployment in interface AWSProtonpublic CancelServicePipelineDeploymentResult cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest request)
AWSProton
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is
IN_PROGRESS. For more information, see Update a service pipeline in the AWS Proton Administrator
guide or the AWS
Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED.
If the cancellation attempt fails, the resulting deployment state is FAILED.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting
deployment state is SUCCEEDED and the cancellation attempt has no effect.
cancelServicePipelineDeployment in interface AWSProtonpublic CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AWSProtonDeploy a new environment. An AWS Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services. For more information, see the Environments in the AWS Proton Administrator Guide.
createEnvironment in interface AWSProtonpublic CreateEnvironmentAccountConnectionResult createEnvironmentAccountConnection(CreateEnvironmentAccountConnectionRequest request)
AWSProtonCreate 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 AWS Proton Administrator guide.
createEnvironmentAccountConnection in interface AWSProtonpublic CreateEnvironmentTemplateResult createEnvironmentTemplate(CreateEnvironmentTemplateRequest request)
AWSProtonCreate an environment template for AWS Proton. For more information, see Environment Templates in the AWS Proton Administrator Guide.
You can create an environment template in one of the two following ways:
Register and publish a standard environment template that instructs AWS Proton to deploy and manage environment infrastructure.
Register and publish a customer managed environment template that connects AWS Proton to your existing
provisioned infrastructure that you manage. AWS Proton doesn't manage your existing provisioned
infrastructure. To create an environment template for customer provisioned and managed infrastructure, include
the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information,
see Register and publish an
environment template in the AWS Proton Administrator Guide.
createEnvironmentTemplate in interface AWSProtonpublic CreateEnvironmentTemplateVersionResult createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest request)
AWSProtonCreate 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.
createEnvironmentTemplateVersion in interface AWSProtonpublic CreateServiceResult createService(CreateServiceRequest request)
AWSProtonCreate an AWS Proton service. An AWS Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the AWS Proton Administrator Guide and Services in the AWS Proton User Guide.
createService in interface AWSProtonpublic CreateServiceTemplateResult createServiceTemplate(CreateServiceTemplateRequest request)
AWSProtonCreate a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from AWS Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. AWS Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the AWS Proton Administrator Guide.
createServiceTemplate in interface AWSProtonpublic CreateServiceTemplateVersionResult createServiceTemplateVersion(CreateServiceTemplateVersionRequest request)
AWSProtonCreate a new major or minor version of a service template. A major version of a service template is a version that isn't backwards compatible. A minor version of a service template is a version that's backwards compatible within its major version.
createServiceTemplateVersion in interface AWSProtonpublic DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
AWSProtonDelete an environment.
deleteEnvironment in interface AWSProtonpublic DeleteEnvironmentAccountConnectionResult deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest request)
AWSProtonIn an environment account, delete an environment account connection.
After you delete an environment account connection that’s in use by an AWS Proton environment, AWS Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.
For more information, see Environment account connections in the AWS Proton Administrator guide.
deleteEnvironmentAccountConnection in interface AWSProtonpublic DeleteEnvironmentTemplateResult deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest request)
AWSProtonIf no other major or minor versions of an environment template exist, delete the environment template.
deleteEnvironmentTemplate in interface AWSProtonpublic DeleteEnvironmentTemplateVersionResult deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest request)
AWSProton
If no other minor versions of an environment template exist, delete a major version of the environment template
if it's not the Recommended version. Delete the Recommended version of the environment
template if no other major versions or minor versions of the environment template exist. A major version of an
environment template is a version that's not backwards compatible.
Delete a minor version of an environment template if it isn't the Recommended version. Delete
a Recommended minor version of the environment template if no other minor versions of the
environment template exist. A minor version of an environment template is a version that's backwards compatible.
deleteEnvironmentTemplateVersion in interface AWSProtonpublic DeleteServiceResult deleteService(DeleteServiceRequest request)
AWSProtonDelete a service.
deleteService in interface AWSProtonpublic DeleteServiceTemplateResult deleteServiceTemplate(DeleteServiceTemplateRequest request)
AWSProtonIf no other major or minor versions of the service template exist, delete the service template.
deleteServiceTemplate in interface AWSProtonpublic DeleteServiceTemplateVersionResult deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest request)
AWSProton
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.
deleteServiceTemplateVersion in interface AWSProtonpublic GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)
AWSProtonGet detail data for the AWS Proton pipeline service role.
getAccountSettings in interface AWSProtonpublic GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
AWSProtonGet detail data for an environment.
getEnvironment in interface AWSProtonpublic GetEnvironmentAccountConnectionResult getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest request)
AWSProtonIn an environment account, view the detail data for an environment account connection.
For more information, see Environment account connections in the AWS Proton Administrator guide.
getEnvironmentAccountConnection in interface AWSProtonpublic GetEnvironmentTemplateResult getEnvironmentTemplate(GetEnvironmentTemplateRequest request)
AWSProtonGet detail data for an environment template.
getEnvironmentTemplate in interface AWSProtonpublic GetEnvironmentTemplateVersionResult getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest request)
AWSProtonView detail data for a major or minor version of an environment template.
getEnvironmentTemplateVersion in interface AWSProtonpublic GetServiceResult getService(GetServiceRequest request)
AWSProtonGet detail data for a service.
getService in interface AWSProtonpublic GetServiceInstanceResult getServiceInstance(GetServiceInstanceRequest request)
AWSProtonGet detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
getServiceInstance in interface AWSProtonpublic GetServiceTemplateResult getServiceTemplate(GetServiceTemplateRequest request)
AWSProtonGet detail data for a service template.
getServiceTemplate in interface AWSProtonpublic GetServiceTemplateVersionResult getServiceTemplateVersion(GetServiceTemplateVersionRequest request)
AWSProtonView detail data for a major or minor version of a service template.
getServiceTemplateVersion in interface AWSProtonpublic ListEnvironmentAccountConnectionsResult listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest request)
AWSProtonView a list of environment account connections.
For more information, see Environment account connections in the AWS Proton Administrator guide.
listEnvironmentAccountConnections in interface AWSProtonpublic ListEnvironmentTemplateVersionsResult listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest request)
AWSProtonList major or minor versions of an environment template with detail data.
listEnvironmentTemplateVersions in interface AWSProtonpublic ListEnvironmentTemplatesResult listEnvironmentTemplates(ListEnvironmentTemplatesRequest request)
AWSProtonList environment templates.
listEnvironmentTemplates in interface AWSProtonpublic ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
AWSProtonList environments with detail data summaries.
listEnvironments in interface AWSProtonpublic ListServiceInstancesResult listServiceInstances(ListServiceInstancesRequest request)
AWSProtonList service instances with summaries of detail data.
listServiceInstances in interface AWSProtonpublic ListServiceTemplateVersionsResult listServiceTemplateVersions(ListServiceTemplateVersionsRequest request)
AWSProtonList major or minor versions of a service template with detail data.
listServiceTemplateVersions in interface AWSProtonpublic ListServiceTemplatesResult listServiceTemplates(ListServiceTemplatesRequest request)
AWSProtonList service templates with detail data.
listServiceTemplates in interface AWSProtonpublic ListServicesResult listServices(ListServicesRequest request)
AWSProtonList services with summaries of detail data.
listServices in interface AWSProtonpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSProtonList tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
listTagsForResource in interface AWSProtonpublic RejectEnvironmentAccountConnectionResult rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest request)
AWSProtonIn a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.
You can’t reject an environment account connection that is connected to an environment.
For more information, see Environment account connections in the AWS Proton Administrator guide.
rejectEnvironmentAccountConnection in interface AWSProtonpublic TagResourceResult tagResource(TagResourceRequest request)
AWSProtonTag a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
tagResource in interface AWSProtonpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSProtonRemove a tag from a resource. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.
untagResource in interface AWSProtonpublic UpdateAccountSettingsResult updateAccountSettings(UpdateAccountSettingsRequest request)
AWSProtonUpdate the AWS Proton pipeline service account settings.
updateAccountSettings in interface AWSProtonpublic UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AWSProtonUpdate an environment.
If the environment is associated with an environment account connection, don't update or include the
protonServiceRoleArn parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include
the environmentAccountConnectionId parameter to update or connect to an environment account
connection.
You can update either the environmentAccountConnectionId or protonServiceRoleArn
parameter and value. You can’t update both.
There are four modes for updating an environment as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include minor or major version parameters when you use this
deployment-type.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).
updateEnvironment in interface AWSProtonpublic UpdateEnvironmentAccountConnectionResult updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest request)
AWSProtonIn an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the AWS Proton Administrator guide.
updateEnvironmentAccountConnection in interface AWSProtonpublic UpdateEnvironmentTemplateResult updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest request)
AWSProtonUpdate an environment template.
updateEnvironmentTemplate in interface AWSProtonpublic UpdateEnvironmentTemplateVersionResult updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest request)
AWSProtonUpdate a major or minor version of an environment template.
updateEnvironmentTemplateVersion in interface AWSProtonpublic UpdateServiceResult updateService(UpdateServiceRequest request)
AWSProtonEdit a service description or use a spec to add and delete service instances.
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the description parameter to modify the description.
Edit the spec parameter to add or delete instances.
updateService in interface AWSProtonpublic UpdateServiceInstanceResult updateServiceInstance(UpdateServiceInstanceRequest request)
AWSProtonUpdate a service instance.
There are four modes for updating a service instance as described in the following. The
deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include minor or major version parameters when you use this
deployment-type.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
updateServiceInstance in interface AWSProtonpublic UpdateServicePipelineResult updateServicePipeline(UpdateServicePipelineRequest request)
AWSProtonUpdate the service pipeline.
There are four modes for updating a service pipeline as described in the following. The
deploymentType field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested
parameters are updated. Don’t include minor or major version parameters when you use this
deployment-type.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
updateServicePipeline in interface AWSProtonpublic UpdateServiceTemplateResult updateServiceTemplate(UpdateServiceTemplateRequest request)
AWSProtonUpdate a service template.
updateServiceTemplate in interface AWSProtonpublic UpdateServiceTemplateVersionResult updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest request)
AWSProtonUpdate a major or minor version of a service template.
updateServiceTemplateVersion in interface AWSProtonpublic void shutdown()
AWSProtonpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSProtonResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSProtonrequest - The originally executed request.public AWSProtonWaiters waiters()