Interface ProtonClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the actions and data types for the Proton service.
The documentation for each action shows the Query API request parameters and the XML response.
Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the Amazon Web Services Command Line Interface User Guide.
The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to automate their application or service deployments.
Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the listed API operations.
When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are running on Proton, developers need permissions to the service create, list, update and delete API operations and the service instance list and update API operations.
To learn more about Proton, see the Proton User Guide.
Ensuring Idempotency
When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete. Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times. This means that you might create more resources than you intended.
Idempotency ensures that an API request action completes no more than one time. With an idempotent request, if the original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the result might contain updated information, such as the current creation status.
The following lists of APIs are grouped according to methods that ensure idempotency.
Idempotent create APIs with a client token
The API actions in this list support idempotency with the use of a client token. The corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request. We recommend that you don't reuse the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided by SDKs.
Given a request action that has succeeded:
If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If you retry the request using the same client token, but one or more of the parameters are different, the retry
throws a ValidationException
with an IdempotentParameterMismatch
error.
Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.
If the original resource is deleted and you retry the request, a new resource is created.
Idempotent create APIs with a client token:
-
CreateEnvironmentTemplateVersion
-
CreateServiceTemplateVersion
-
CreateEnvironmentAccountConnection
Idempotent create APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, and the original resource hasn't been modified, the retry succeeds without performing any further actions other than returning the original resource detail data in the response.
If the original resource has been modified, the retry throws a ConflictException
.
If you retry with different input parameters, the retry throws a ValidationException
with an
IdempotentParameterMismatch
error.
Idempotent create APIs:
-
CreateEnvironmentTemplate
-
CreateServiceTemplate
-
CreateEnvironment
-
CreateService
Idempotent delete APIs
Given a request action that has succeeded:
When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.
If you retry and the resource doesn't exist, the response is empty.
In both cases, the retry succeeds.
Idempotent delete APIs:
-
DeleteEnvironmentTemplate
-
DeleteEnvironmentTemplateVersion
-
DeleteServiceTemplate
-
DeleteServiceTemplateVersion
-
DeleteEnvironmentAccountConnection
Asynchronous idempotent delete APIs
Given a request action that has succeeded:
If you retry the request with an API from this group, if the original request delete operation status is
DELETE_IN_PROGRESS
, the retry returns the resource detail data in the response without performing any
further actions.
If the original request delete operation is complete, a retry returns an empty response.
Asynchronous idempotent delete APIs:
-
DeleteEnvironment
-
DeleteService
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptEnvironmentAccountConnection
(Consumer<AcceptEnvironmentAccountConnectionRequest.Builder> acceptEnvironmentAccountConnectionRequest) In a management account, an environment account connection request is accepted.acceptEnvironmentAccountConnection
(AcceptEnvironmentAccountConnectionRequest acceptEnvironmentAccountConnectionRequest) In a management account, an environment account connection request is accepted.static ProtonClientBuilder
builder()
Create a builder that can be used to configure and create aProtonClient
.cancelComponentDeployment
(Consumer<CancelComponentDeploymentRequest.Builder> cancelComponentDeploymentRequest) Attempts to cancel a component deployment (for a component that is in theIN_PROGRESS
deployment status).cancelComponentDeployment
(CancelComponentDeploymentRequest cancelComponentDeploymentRequest) Attempts to cancel a component deployment (for a component that is in theIN_PROGRESS
deployment status).cancelEnvironmentDeployment
(Consumer<CancelEnvironmentDeploymentRequest.Builder> cancelEnvironmentDeploymentRequest) Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment isIN_PROGRESS
.cancelEnvironmentDeployment
(CancelEnvironmentDeploymentRequest cancelEnvironmentDeploymentRequest) Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment isIN_PROGRESS
.cancelServiceInstanceDeployment
(Consumer<CancelServiceInstanceDeploymentRequest.Builder> cancelServiceInstanceDeploymentRequest) Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment isIN_PROGRESS
.cancelServiceInstanceDeployment
(CancelServiceInstanceDeploymentRequest cancelServiceInstanceDeploymentRequest) Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment isIN_PROGRESS
.cancelServicePipelineDeployment
(Consumer<CancelServicePipelineDeploymentRequest.Builder> cancelServicePipelineDeploymentRequest) Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment isIN_PROGRESS
.cancelServicePipelineDeployment
(CancelServicePipelineDeploymentRequest cancelServicePipelineDeploymentRequest) Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment isIN_PROGRESS
.static ProtonClient
create()
Create aProtonClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateComponentResponse
createComponent
(Consumer<CreateComponentRequest.Builder> createComponentRequest) Create an Proton component.default CreateComponentResponse
createComponent
(CreateComponentRequest createComponentRequest) Create an Proton component.default CreateEnvironmentResponse
createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Deploy a new environment.default CreateEnvironmentResponse
createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Deploy a new environment.createEnvironmentAccountConnection
(Consumer<CreateEnvironmentAccountConnectionRequest.Builder> createEnvironmentAccountConnectionRequest) 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.createEnvironmentAccountConnection
(CreateEnvironmentAccountConnectionRequest createEnvironmentAccountConnectionRequest) 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.createEnvironmentTemplate
(Consumer<CreateEnvironmentTemplateRequest.Builder> createEnvironmentTemplateRequest) Create an environment template for Proton.createEnvironmentTemplate
(CreateEnvironmentTemplateRequest createEnvironmentTemplateRequest) Create an environment template for Proton.createEnvironmentTemplateVersion
(Consumer<CreateEnvironmentTemplateVersionRequest.Builder> createEnvironmentTemplateVersionRequest) Create a new major or minor version of an environment template.createEnvironmentTemplateVersion
(CreateEnvironmentTemplateVersionRequest createEnvironmentTemplateVersionRequest) Create a new major or minor version of an environment template.default CreateRepositoryResponse
createRepository
(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Create and register a link to a repository.default CreateRepositoryResponse
createRepository
(CreateRepositoryRequest createRepositoryRequest) Create and register a link to a repository.default CreateServiceResponse
createService
(Consumer<CreateServiceRequest.Builder> createServiceRequest) Create an Proton service.default CreateServiceResponse
createService
(CreateServiceRequest createServiceRequest) Create an Proton service.default CreateServiceInstanceResponse
createServiceInstance
(Consumer<CreateServiceInstanceRequest.Builder> createServiceInstanceRequest) Create a service instance.default CreateServiceInstanceResponse
createServiceInstance
(CreateServiceInstanceRequest createServiceInstanceRequest) Create a service instance.default CreateServiceSyncConfigResponse
createServiceSyncConfig
(Consumer<CreateServiceSyncConfigRequest.Builder> createServiceSyncConfigRequest) Create the Proton Ops configuration file.default CreateServiceSyncConfigResponse
createServiceSyncConfig
(CreateServiceSyncConfigRequest createServiceSyncConfigRequest) Create the Proton Ops configuration file.default CreateServiceTemplateResponse
createServiceTemplate
(Consumer<CreateServiceTemplateRequest.Builder> createServiceTemplateRequest) Create a service template.default CreateServiceTemplateResponse
createServiceTemplate
(CreateServiceTemplateRequest createServiceTemplateRequest) Create a service template.createServiceTemplateVersion
(Consumer<CreateServiceTemplateVersionRequest.Builder> createServiceTemplateVersionRequest) Create a new major or minor version of a service template.createServiceTemplateVersion
(CreateServiceTemplateVersionRequest createServiceTemplateVersionRequest) Create a new major or minor version of a service template.default CreateTemplateSyncConfigResponse
createTemplateSyncConfig
(Consumer<CreateTemplateSyncConfigRequest.Builder> createTemplateSyncConfigRequest) Set up a template to create new template versions automatically by tracking a linked repository.default CreateTemplateSyncConfigResponse
createTemplateSyncConfig
(CreateTemplateSyncConfigRequest createTemplateSyncConfigRequest) Set up a template to create new template versions automatically by tracking a linked repository.default DeleteComponentResponse
deleteComponent
(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) Delete an Proton component resource.default DeleteComponentResponse
deleteComponent
(DeleteComponentRequest deleteComponentRequest) Delete an Proton component resource.default DeleteDeploymentResponse
deleteDeployment
(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest) Delete the deployment.default DeleteDeploymentResponse
deleteDeployment
(DeleteDeploymentRequest deleteDeploymentRequest) Delete the deployment.default DeleteEnvironmentResponse
deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Delete an environment.default DeleteEnvironmentResponse
deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Delete an environment.deleteEnvironmentAccountConnection
(Consumer<DeleteEnvironmentAccountConnectionRequest.Builder> deleteEnvironmentAccountConnectionRequest) In an environment account, delete an environment account connection.deleteEnvironmentAccountConnection
(DeleteEnvironmentAccountConnectionRequest deleteEnvironmentAccountConnectionRequest) In an environment account, delete an environment account connection.deleteEnvironmentTemplate
(Consumer<DeleteEnvironmentTemplateRequest.Builder> deleteEnvironmentTemplateRequest) If no other major or minor versions of an environment template exist, delete the environment template.deleteEnvironmentTemplate
(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest) If no other major or minor versions of an environment template exist, delete the environment template.deleteEnvironmentTemplateVersion
(Consumer<DeleteEnvironmentTemplateVersionRequest.Builder> deleteEnvironmentTemplateVersionRequest) If no other minor versions of an environment template exist, delete a major version of the environment template if it's not theRecommended
version.deleteEnvironmentTemplateVersion
(DeleteEnvironmentTemplateVersionRequest deleteEnvironmentTemplateVersionRequest) If no other minor versions of an environment template exist, delete a major version of the environment template if it's not theRecommended
version.default DeleteRepositoryResponse
deleteRepository
(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) De-register and unlink your repository.default DeleteRepositoryResponse
deleteRepository
(DeleteRepositoryRequest deleteRepositoryRequest) De-register and unlink your repository.default DeleteServiceResponse
deleteService
(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) Delete a service, with its instances and pipeline.default DeleteServiceResponse
deleteService
(DeleteServiceRequest deleteServiceRequest) Delete a service, with its instances and pipeline.default DeleteServiceSyncConfigResponse
deleteServiceSyncConfig
(Consumer<DeleteServiceSyncConfigRequest.Builder> deleteServiceSyncConfigRequest) Delete the Proton Ops file.default DeleteServiceSyncConfigResponse
deleteServiceSyncConfig
(DeleteServiceSyncConfigRequest deleteServiceSyncConfigRequest) Delete the Proton Ops file.default DeleteServiceTemplateResponse
deleteServiceTemplate
(Consumer<DeleteServiceTemplateRequest.Builder> deleteServiceTemplateRequest) If no other major or minor versions of the service template exist, delete the service template.default DeleteServiceTemplateResponse
deleteServiceTemplate
(DeleteServiceTemplateRequest deleteServiceTemplateRequest) If no other major or minor versions of the service template exist, delete the service template.deleteServiceTemplateVersion
(Consumer<DeleteServiceTemplateVersionRequest.Builder> deleteServiceTemplateVersionRequest) If no other minor versions of a service template exist, delete a major version of the service template if it's not theRecommended
version.deleteServiceTemplateVersion
(DeleteServiceTemplateVersionRequest deleteServiceTemplateVersionRequest) If no other minor versions of a service template exist, delete a major version of the service template if it's not theRecommended
version.default DeleteTemplateSyncConfigResponse
deleteTemplateSyncConfig
(Consumer<DeleteTemplateSyncConfigRequest.Builder> deleteTemplateSyncConfigRequest) Delete a template sync configuration.default DeleteTemplateSyncConfigResponse
deleteTemplateSyncConfig
(DeleteTemplateSyncConfigRequest deleteTemplateSyncConfigRequest) Delete a template sync configuration.default GetAccountSettingsResponse
getAccountSettings
(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) Get detail data for Proton account-wide settings.default GetAccountSettingsResponse
getAccountSettings
(GetAccountSettingsRequest getAccountSettingsRequest) Get detail data for Proton account-wide settings.default GetComponentResponse
getComponent
(Consumer<GetComponentRequest.Builder> getComponentRequest) Get detailed data for a component.default GetComponentResponse
getComponent
(GetComponentRequest getComponentRequest) Get detailed data for a component.default GetDeploymentResponse
getDeployment
(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) Get detailed data for a deployment.default GetDeploymentResponse
getDeployment
(GetDeploymentRequest getDeploymentRequest) Get detailed data for a deployment.default GetEnvironmentResponse
getEnvironment
(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Get detailed data for an environment.default GetEnvironmentResponse
getEnvironment
(GetEnvironmentRequest getEnvironmentRequest) Get detailed data for an environment.getEnvironmentAccountConnection
(Consumer<GetEnvironmentAccountConnectionRequest.Builder> getEnvironmentAccountConnectionRequest) In an environment account, get the detailed data for an environment account connection.getEnvironmentAccountConnection
(GetEnvironmentAccountConnectionRequest getEnvironmentAccountConnectionRequest) In an environment account, get the detailed data for an environment account connection.default GetEnvironmentTemplateResponse
getEnvironmentTemplate
(Consumer<GetEnvironmentTemplateRequest.Builder> getEnvironmentTemplateRequest) Get detailed data for an environment template.default GetEnvironmentTemplateResponse
getEnvironmentTemplate
(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest) Get detailed data for an environment template.getEnvironmentTemplateVersion
(Consumer<GetEnvironmentTemplateVersionRequest.Builder> getEnvironmentTemplateVersionRequest) Get detailed data for a major or minor version of an environment template.getEnvironmentTemplateVersion
(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest) Get detailed data for a major or minor version of an environment template.default GetRepositoryResponse
getRepository
(Consumer<GetRepositoryRequest.Builder> getRepositoryRequest) Get detail data for a linked repository.default GetRepositoryResponse
getRepository
(GetRepositoryRequest getRepositoryRequest) Get detail data for a linked repository.default GetRepositorySyncStatusResponse
getRepositorySyncStatus
(Consumer<GetRepositorySyncStatusRequest.Builder> getRepositorySyncStatusRequest) Get the sync status of a repository used for Proton template sync.default GetRepositorySyncStatusResponse
getRepositorySyncStatus
(GetRepositorySyncStatusRequest getRepositorySyncStatusRequest) Get the sync status of a repository used for Proton template sync.default GetResourcesSummaryResponse
getResourcesSummary
(Consumer<GetResourcesSummaryRequest.Builder> getResourcesSummaryRequest) Get counts of Proton resources.default GetResourcesSummaryResponse
getResourcesSummary
(GetResourcesSummaryRequest getResourcesSummaryRequest) Get counts of Proton resources.default GetServiceResponse
getService
(Consumer<GetServiceRequest.Builder> getServiceRequest) Get detailed data for a service.default GetServiceResponse
getService
(GetServiceRequest getServiceRequest) Get detailed data for a service.default GetServiceInstanceResponse
getServiceInstance
(Consumer<GetServiceInstanceRequest.Builder> getServiceInstanceRequest) Get detailed data for a service instance.default GetServiceInstanceResponse
getServiceInstance
(GetServiceInstanceRequest getServiceInstanceRequest) Get detailed data for a service instance.getServiceInstanceSyncStatus
(Consumer<GetServiceInstanceSyncStatusRequest.Builder> getServiceInstanceSyncStatusRequest) Get the status of the synced service instance.getServiceInstanceSyncStatus
(GetServiceInstanceSyncStatusRequest getServiceInstanceSyncStatusRequest) Get the status of the synced service instance.getServiceSyncBlockerSummary
(Consumer<GetServiceSyncBlockerSummaryRequest.Builder> getServiceSyncBlockerSummaryRequest) Get detailed data for the service sync blocker summary.getServiceSyncBlockerSummary
(GetServiceSyncBlockerSummaryRequest getServiceSyncBlockerSummaryRequest) Get detailed data for the service sync blocker summary.default GetServiceSyncConfigResponse
getServiceSyncConfig
(Consumer<GetServiceSyncConfigRequest.Builder> getServiceSyncConfigRequest) Get detailed information for the service sync configuration.default GetServiceSyncConfigResponse
getServiceSyncConfig
(GetServiceSyncConfigRequest getServiceSyncConfigRequest) Get detailed information for the service sync configuration.default GetServiceTemplateResponse
getServiceTemplate
(Consumer<GetServiceTemplateRequest.Builder> getServiceTemplateRequest) Get detailed data for a service template.default GetServiceTemplateResponse
getServiceTemplate
(GetServiceTemplateRequest getServiceTemplateRequest) Get detailed data for a service template.getServiceTemplateVersion
(Consumer<GetServiceTemplateVersionRequest.Builder> getServiceTemplateVersionRequest) Get detailed data for a major or minor version of a service template.getServiceTemplateVersion
(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest) Get detailed data for a major or minor version of a service template.default GetTemplateSyncConfigResponse
getTemplateSyncConfig
(Consumer<GetTemplateSyncConfigRequest.Builder> getTemplateSyncConfigRequest) Get detail data for a template sync configuration.default GetTemplateSyncConfigResponse
getTemplateSyncConfig
(GetTemplateSyncConfigRequest getTemplateSyncConfigRequest) Get detail data for a template sync configuration.default GetTemplateSyncStatusResponse
getTemplateSyncStatus
(Consumer<GetTemplateSyncStatusRequest.Builder> getTemplateSyncStatusRequest) Get the status of a template sync.default GetTemplateSyncStatusResponse
getTemplateSyncStatus
(GetTemplateSyncStatusRequest getTemplateSyncStatusRequest) Get the status of a template sync.default ListComponentOutputsResponse
listComponentOutputs
(Consumer<ListComponentOutputsRequest.Builder> listComponentOutputsRequest) Get a list of component Infrastructure as Code (IaC) outputs.default ListComponentOutputsResponse
listComponentOutputs
(ListComponentOutputsRequest listComponentOutputsRequest) Get a list of component Infrastructure as Code (IaC) outputs.default ListComponentOutputsIterable
listComponentOutputsPaginator
(Consumer<ListComponentOutputsRequest.Builder> listComponentOutputsRequest) This is a variant oflistComponentOutputs(software.amazon.awssdk.services.proton.model.ListComponentOutputsRequest)
operation.default ListComponentOutputsIterable
listComponentOutputsPaginator
(ListComponentOutputsRequest listComponentOutputsRequest) This is a variant oflistComponentOutputs(software.amazon.awssdk.services.proton.model.ListComponentOutputsRequest)
operation.listComponentProvisionedResources
(Consumer<ListComponentProvisionedResourcesRequest.Builder> listComponentProvisionedResourcesRequest) List provisioned resources for a component with details.listComponentProvisionedResources
(ListComponentProvisionedResourcesRequest listComponentProvisionedResourcesRequest) List provisioned resources for a component with details.listComponentProvisionedResourcesPaginator
(Consumer<ListComponentProvisionedResourcesRequest.Builder> listComponentProvisionedResourcesRequest) This is a variant oflistComponentProvisionedResources(software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesRequest)
operation.listComponentProvisionedResourcesPaginator
(ListComponentProvisionedResourcesRequest listComponentProvisionedResourcesRequest) This is a variant oflistComponentProvisionedResources(software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesRequest)
operation.default ListComponentsResponse
listComponents
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) List components with summary data.default ListComponentsResponse
listComponents
(ListComponentsRequest listComponentsRequest) List components with summary data.default ListComponentsIterable
listComponentsPaginator
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.proton.model.ListComponentsRequest)
operation.default ListComponentsIterable
listComponentsPaginator
(ListComponentsRequest listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.proton.model.ListComponentsRequest)
operation.default ListDeploymentsResponse
listDeployments
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) List deployments.default ListDeploymentsResponse
listDeployments
(ListDeploymentsRequest listDeploymentsRequest) List deployments.default ListDeploymentsIterable
listDeploymentsPaginator
(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.proton.model.ListDeploymentsRequest)
operation.default ListDeploymentsIterable
listDeploymentsPaginator
(ListDeploymentsRequest listDeploymentsRequest) This is a variant oflistDeployments(software.amazon.awssdk.services.proton.model.ListDeploymentsRequest)
operation.listEnvironmentAccountConnections
(Consumer<ListEnvironmentAccountConnectionsRequest.Builder> listEnvironmentAccountConnectionsRequest) View a list of environment account connections.listEnvironmentAccountConnections
(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest) View a list of environment account connections.listEnvironmentAccountConnectionsPaginator
(Consumer<ListEnvironmentAccountConnectionsRequest.Builder> listEnvironmentAccountConnectionsRequest) This is a variant oflistEnvironmentAccountConnections(software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsRequest)
operation.listEnvironmentAccountConnectionsPaginator
(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest) This is a variant oflistEnvironmentAccountConnections(software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsRequest)
operation.default ListEnvironmentOutputsResponse
listEnvironmentOutputs
(Consumer<ListEnvironmentOutputsRequest.Builder> listEnvironmentOutputsRequest) List the infrastructure as code outputs for your environment.default ListEnvironmentOutputsResponse
listEnvironmentOutputs
(ListEnvironmentOutputsRequest listEnvironmentOutputsRequest) List the infrastructure as code outputs for your environment.default ListEnvironmentOutputsIterable
listEnvironmentOutputsPaginator
(Consumer<ListEnvironmentOutputsRequest.Builder> listEnvironmentOutputsRequest) This is a variant oflistEnvironmentOutputs(software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsRequest)
operation.default ListEnvironmentOutputsIterable
listEnvironmentOutputsPaginator
(ListEnvironmentOutputsRequest listEnvironmentOutputsRequest) This is a variant oflistEnvironmentOutputs(software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsRequest)
operation.listEnvironmentProvisionedResources
(Consumer<ListEnvironmentProvisionedResourcesRequest.Builder> listEnvironmentProvisionedResourcesRequest) List the provisioned resources for your environment.listEnvironmentProvisionedResources
(ListEnvironmentProvisionedResourcesRequest listEnvironmentProvisionedResourcesRequest) List the provisioned resources for your environment.listEnvironmentProvisionedResourcesPaginator
(Consumer<ListEnvironmentProvisionedResourcesRequest.Builder> listEnvironmentProvisionedResourcesRequest) This is a variant oflistEnvironmentProvisionedResources(software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesRequest)
operation.listEnvironmentProvisionedResourcesPaginator
(ListEnvironmentProvisionedResourcesRequest listEnvironmentProvisionedResourcesRequest) This is a variant oflistEnvironmentProvisionedResources(software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesRequest)
operation.default ListEnvironmentsResponse
listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) List environments with detail data summaries.default ListEnvironmentsResponse
listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) List environments with detail data summaries.default ListEnvironmentsIterable
listEnvironmentsPaginator
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.proton.model.ListEnvironmentsRequest)
operation.default ListEnvironmentsIterable
listEnvironmentsPaginator
(ListEnvironmentsRequest listEnvironmentsRequest) This is a variant oflistEnvironments(software.amazon.awssdk.services.proton.model.ListEnvironmentsRequest)
operation.default ListEnvironmentTemplatesResponse
listEnvironmentTemplates
(Consumer<ListEnvironmentTemplatesRequest.Builder> listEnvironmentTemplatesRequest) List environment templates.default ListEnvironmentTemplatesResponse
listEnvironmentTemplates
(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest) List environment templates.default ListEnvironmentTemplatesIterable
listEnvironmentTemplatesPaginator
(Consumer<ListEnvironmentTemplatesRequest.Builder> listEnvironmentTemplatesRequest) This is a variant oflistEnvironmentTemplates(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesRequest)
operation.default ListEnvironmentTemplatesIterable
listEnvironmentTemplatesPaginator
(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest) This is a variant oflistEnvironmentTemplates(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesRequest)
operation.listEnvironmentTemplateVersions
(Consumer<ListEnvironmentTemplateVersionsRequest.Builder> listEnvironmentTemplateVersionsRequest) List major or minor versions of an environment template with detail data.listEnvironmentTemplateVersions
(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest) List major or minor versions of an environment template with detail data.listEnvironmentTemplateVersionsPaginator
(Consumer<ListEnvironmentTemplateVersionsRequest.Builder> listEnvironmentTemplateVersionsRequest) This is a variant oflistEnvironmentTemplateVersions(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsRequest)
operation.listEnvironmentTemplateVersionsPaginator
(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest) This is a variant oflistEnvironmentTemplateVersions(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsRequest)
operation.default ListRepositoriesResponse
listRepositories
(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) List linked repositories with detail data.default ListRepositoriesResponse
listRepositories
(ListRepositoriesRequest listRepositoriesRequest) List linked repositories with detail data.default ListRepositoriesIterable
listRepositoriesPaginator
(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) This is a variant oflistRepositories(software.amazon.awssdk.services.proton.model.ListRepositoriesRequest)
operation.default ListRepositoriesIterable
listRepositoriesPaginator
(ListRepositoriesRequest listRepositoriesRequest) This is a variant oflistRepositories(software.amazon.awssdk.services.proton.model.ListRepositoriesRequest)
operation.listRepositorySyncDefinitions
(Consumer<ListRepositorySyncDefinitionsRequest.Builder> listRepositorySyncDefinitionsRequest) List repository sync definitions with detail data.listRepositorySyncDefinitions
(ListRepositorySyncDefinitionsRequest listRepositorySyncDefinitionsRequest) List repository sync definitions with detail data.listRepositorySyncDefinitionsPaginator
(Consumer<ListRepositorySyncDefinitionsRequest.Builder> listRepositorySyncDefinitionsRequest) This is a variant oflistRepositorySyncDefinitions(software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsRequest)
operation.listRepositorySyncDefinitionsPaginator
(ListRepositorySyncDefinitionsRequest listRepositorySyncDefinitionsRequest) This is a variant oflistRepositorySyncDefinitions(software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsRequest)
operation.listServiceInstanceOutputs
(Consumer<ListServiceInstanceOutputsRequest.Builder> listServiceInstanceOutputsRequest) Get a list service of instance Infrastructure as Code (IaC) outputs.listServiceInstanceOutputs
(ListServiceInstanceOutputsRequest listServiceInstanceOutputsRequest) Get a list service of instance Infrastructure as Code (IaC) outputs.listServiceInstanceOutputsPaginator
(Consumer<ListServiceInstanceOutputsRequest.Builder> listServiceInstanceOutputsRequest) This is a variant oflistServiceInstanceOutputs(software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsRequest)
operation.listServiceInstanceOutputsPaginator
(ListServiceInstanceOutputsRequest listServiceInstanceOutputsRequest) This is a variant oflistServiceInstanceOutputs(software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsRequest)
operation.listServiceInstanceProvisionedResources
(Consumer<ListServiceInstanceProvisionedResourcesRequest.Builder> listServiceInstanceProvisionedResourcesRequest) List provisioned resources for a service instance with details.listServiceInstanceProvisionedResources
(ListServiceInstanceProvisionedResourcesRequest listServiceInstanceProvisionedResourcesRequest) List provisioned resources for a service instance with details.listServiceInstanceProvisionedResourcesPaginator
(Consumer<ListServiceInstanceProvisionedResourcesRequest.Builder> listServiceInstanceProvisionedResourcesRequest) listServiceInstanceProvisionedResourcesPaginator
(ListServiceInstanceProvisionedResourcesRequest listServiceInstanceProvisionedResourcesRequest) default ListServiceInstancesResponse
listServiceInstances
(Consumer<ListServiceInstancesRequest.Builder> listServiceInstancesRequest) List service instances with summary data.default ListServiceInstancesResponse
listServiceInstances
(ListServiceInstancesRequest listServiceInstancesRequest) List service instances with summary data.default ListServiceInstancesIterable
listServiceInstancesPaginator
(Consumer<ListServiceInstancesRequest.Builder> listServiceInstancesRequest) This is a variant oflistServiceInstances(software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest)
operation.default ListServiceInstancesIterable
listServiceInstancesPaginator
(ListServiceInstancesRequest listServiceInstancesRequest) This is a variant oflistServiceInstances(software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest)
operation.listServicePipelineOutputs
(Consumer<ListServicePipelineOutputsRequest.Builder> listServicePipelineOutputsRequest) Get a list of service pipeline Infrastructure as Code (IaC) outputs.listServicePipelineOutputs
(ListServicePipelineOutputsRequest listServicePipelineOutputsRequest) Get a list of service pipeline Infrastructure as Code (IaC) outputs.listServicePipelineOutputsPaginator
(Consumer<ListServicePipelineOutputsRequest.Builder> listServicePipelineOutputsRequest) This is a variant oflistServicePipelineOutputs(software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsRequest)
operation.listServicePipelineOutputsPaginator
(ListServicePipelineOutputsRequest listServicePipelineOutputsRequest) This is a variant oflistServicePipelineOutputs(software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsRequest)
operation.listServicePipelineProvisionedResources
(Consumer<ListServicePipelineProvisionedResourcesRequest.Builder> listServicePipelineProvisionedResourcesRequest) List provisioned resources for a service and pipeline with details.listServicePipelineProvisionedResources
(ListServicePipelineProvisionedResourcesRequest listServicePipelineProvisionedResourcesRequest) List provisioned resources for a service and pipeline with details.listServicePipelineProvisionedResourcesPaginator
(Consumer<ListServicePipelineProvisionedResourcesRequest.Builder> listServicePipelineProvisionedResourcesRequest) listServicePipelineProvisionedResourcesPaginator
(ListServicePipelineProvisionedResourcesRequest listServicePipelineProvisionedResourcesRequest) default ListServicesResponse
listServices
(Consumer<ListServicesRequest.Builder> listServicesRequest) List services with summaries of detail data.default ListServicesResponse
listServices
(ListServicesRequest listServicesRequest) List services with summaries of detail data.default ListServicesIterable
listServicesPaginator
(Consumer<ListServicesRequest.Builder> listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.proton.model.ListServicesRequest)
operation.default ListServicesIterable
listServicesPaginator
(ListServicesRequest listServicesRequest) This is a variant oflistServices(software.amazon.awssdk.services.proton.model.ListServicesRequest)
operation.default ListServiceTemplatesResponse
listServiceTemplates
(Consumer<ListServiceTemplatesRequest.Builder> listServiceTemplatesRequest) List service templates with detail data.default ListServiceTemplatesResponse
listServiceTemplates
(ListServiceTemplatesRequest listServiceTemplatesRequest) List service templates with detail data.default ListServiceTemplatesIterable
listServiceTemplatesPaginator
(Consumer<ListServiceTemplatesRequest.Builder> listServiceTemplatesRequest) This is a variant oflistServiceTemplates(software.amazon.awssdk.services.proton.model.ListServiceTemplatesRequest)
operation.default ListServiceTemplatesIterable
listServiceTemplatesPaginator
(ListServiceTemplatesRequest listServiceTemplatesRequest) This is a variant oflistServiceTemplates(software.amazon.awssdk.services.proton.model.ListServiceTemplatesRequest)
operation.listServiceTemplateVersions
(Consumer<ListServiceTemplateVersionsRequest.Builder> listServiceTemplateVersionsRequest) List major or minor versions of a service template with detail data.listServiceTemplateVersions
(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest) List major or minor versions of a service template with detail data.listServiceTemplateVersionsPaginator
(Consumer<ListServiceTemplateVersionsRequest.Builder> listServiceTemplateVersionsRequest) This is a variant oflistServiceTemplateVersions(software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsRequest)
operation.listServiceTemplateVersionsPaginator
(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest) This is a variant oflistServiceTemplateVersions(software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List tags for a resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a resource.default ListTagsForResourceIterable
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.proton.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.proton.model.ListTagsForResourceRequest)
operation.notifyResourceDeploymentStatusChange
(Consumer<NotifyResourceDeploymentStatusChangeRequest.Builder> notifyResourceDeploymentStatusChangeRequest) Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.notifyResourceDeploymentStatusChange
(NotifyResourceDeploymentStatusChangeRequest notifyResourceDeploymentStatusChangeRequest) Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.rejectEnvironmentAccountConnection
(Consumer<RejectEnvironmentAccountConnectionRequest.Builder> rejectEnvironmentAccountConnectionRequest) In a management account, reject an environment account connection from another environment account.rejectEnvironmentAccountConnection
(RejectEnvironmentAccountConnectionRequest rejectEnvironmentAccountConnectionRequest) In a management account, reject an environment account connection from another environment account.default ProtonServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tag a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Tag a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove a customer tag from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Remove a customer tag from a resource.default UpdateAccountSettingsResponse
updateAccountSettings
(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) Update Proton settings that are used for multiple services in the Amazon Web Services account.default UpdateAccountSettingsResponse
updateAccountSettings
(UpdateAccountSettingsRequest updateAccountSettingsRequest) Update Proton settings that are used for multiple services in the Amazon Web Services account.default UpdateComponentResponse
updateComponent
(Consumer<UpdateComponentRequest.Builder> updateComponentRequest) Update a component.default UpdateComponentResponse
updateComponent
(UpdateComponentRequest updateComponentRequest) Update a component.default UpdateEnvironmentResponse
updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Update an environment.default UpdateEnvironmentResponse
updateEnvironment
(UpdateEnvironmentRequest updateEnvironmentRequest) Update an environment.updateEnvironmentAccountConnection
(Consumer<UpdateEnvironmentAccountConnectionRequest.Builder> updateEnvironmentAccountConnectionRequest) In an environment account, update an environment account connection to use a new IAM role.updateEnvironmentAccountConnection
(UpdateEnvironmentAccountConnectionRequest updateEnvironmentAccountConnectionRequest) In an environment account, update an environment account connection to use a new IAM role.updateEnvironmentTemplate
(Consumer<UpdateEnvironmentTemplateRequest.Builder> updateEnvironmentTemplateRequest) Update an environment template.updateEnvironmentTemplate
(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest) Update an environment template.updateEnvironmentTemplateVersion
(Consumer<UpdateEnvironmentTemplateVersionRequest.Builder> updateEnvironmentTemplateVersionRequest) Update a major or minor version of an environment template.updateEnvironmentTemplateVersion
(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest) Update a major or minor version of an environment template.default UpdateServiceResponse
updateService
(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) Edit a service description or use a spec to add and delete service instances.default UpdateServiceResponse
updateService
(UpdateServiceRequest updateServiceRequest) Edit a service description or use a spec to add and delete service instances.default UpdateServiceInstanceResponse
updateServiceInstance
(Consumer<UpdateServiceInstanceRequest.Builder> updateServiceInstanceRequest) Update a service instance.default UpdateServiceInstanceResponse
updateServiceInstance
(UpdateServiceInstanceRequest updateServiceInstanceRequest) Update a service instance.default UpdateServicePipelineResponse
updateServicePipeline
(Consumer<UpdateServicePipelineRequest.Builder> updateServicePipelineRequest) Update the service pipeline.default UpdateServicePipelineResponse
updateServicePipeline
(UpdateServicePipelineRequest updateServicePipelineRequest) Update the service pipeline.default UpdateServiceSyncBlockerResponse
updateServiceSyncBlocker
(Consumer<UpdateServiceSyncBlockerRequest.Builder> updateServiceSyncBlockerRequest) Update the service sync blocker by resolving it.default UpdateServiceSyncBlockerResponse
updateServiceSyncBlocker
(UpdateServiceSyncBlockerRequest updateServiceSyncBlockerRequest) Update the service sync blocker by resolving it.default UpdateServiceSyncConfigResponse
updateServiceSyncConfig
(Consumer<UpdateServiceSyncConfigRequest.Builder> updateServiceSyncConfigRequest) Update the Proton Ops config file.default UpdateServiceSyncConfigResponse
updateServiceSyncConfig
(UpdateServiceSyncConfigRequest updateServiceSyncConfigRequest) Update the Proton Ops config file.default UpdateServiceTemplateResponse
updateServiceTemplate
(Consumer<UpdateServiceTemplateRequest.Builder> updateServiceTemplateRequest) Update a service template.default UpdateServiceTemplateResponse
updateServiceTemplate
(UpdateServiceTemplateRequest updateServiceTemplateRequest) Update a service template.updateServiceTemplateVersion
(Consumer<UpdateServiceTemplateVersionRequest.Builder> updateServiceTemplateVersionRequest) Update a major or minor version of a service template.updateServiceTemplateVersion
(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest) Update a major or minor version of a service template.default UpdateTemplateSyncConfigResponse
updateTemplateSyncConfig
(Consumer<UpdateTemplateSyncConfigRequest.Builder> updateTemplateSyncConfigRequest) Update template sync configuration parameters, except for thetemplateName
andtemplateType
.default UpdateTemplateSyncConfigResponse
updateTemplateSyncConfig
(UpdateTemplateSyncConfigRequest updateTemplateSyncConfigRequest) Update template sync configuration parameters, except for thetemplateName
andtemplateType
.default ProtonWaiter
waiter()
Create an instance ofProtonWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptEnvironmentAccountConnection
default AcceptEnvironmentAccountConnectionResponse acceptEnvironmentAccountConnection(AcceptEnvironmentAccountConnectionRequest acceptEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
acceptEnvironmentAccountConnectionRequest
-- Returns:
- Result of the AcceptEnvironmentAccountConnection operation returned by the service.
- See Also:
-
acceptEnvironmentAccountConnection
default AcceptEnvironmentAccountConnectionResponse acceptEnvironmentAccountConnection(Consumer<AcceptEnvironmentAccountConnectionRequest.Builder> acceptEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
AcceptEnvironmentAccountConnectionRequest.Builder
avoiding the need to create one manually viaAcceptEnvironmentAccountConnectionRequest.builder()
- Parameters:
acceptEnvironmentAccountConnectionRequest
- AConsumer
that will call methods onAcceptEnvironmentAccountConnectionRequest.Builder
to create a request.- Returns:
- Result of the AcceptEnvironmentAccountConnection operation returned by the service.
- See Also:
-
cancelComponentDeployment
default CancelComponentDeploymentResponse cancelComponentDeployment(CancelComponentDeploymentRequest cancelComponentDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
cancelComponentDeploymentRequest
-- Returns:
- Result of the CancelComponentDeployment operation returned by the service.
- See Also:
-
cancelComponentDeployment
default CancelComponentDeploymentResponse cancelComponentDeployment(Consumer<CancelComponentDeploymentRequest.Builder> cancelComponentDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CancelComponentDeploymentRequest.Builder
avoiding the need to create one manually viaCancelComponentDeploymentRequest.builder()
- Parameters:
cancelComponentDeploymentRequest
- AConsumer
that will call methods onCancelComponentDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CancelComponentDeployment operation returned by the service.
- See Also:
-
cancelEnvironmentDeployment
default CancelEnvironmentDeploymentResponse cancelEnvironmentDeployment(CancelEnvironmentDeploymentRequest cancelEnvironmentDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
cancelEnvironmentDeploymentRequest
-- Returns:
- Result of the CancelEnvironmentDeployment operation returned by the service.
- See Also:
-
-
cancelEnvironmentDeployment
default CancelEnvironmentDeploymentResponse cancelEnvironmentDeployment(Consumer<CancelEnvironmentDeploymentRequest.Builder> cancelEnvironmentDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CancelEnvironmentDeploymentRequest.Builder
avoiding the need to create one manually viaCancelEnvironmentDeploymentRequest.builder()
- Parameters:
cancelEnvironmentDeploymentRequest
- AConsumer
that will call methods onCancelEnvironmentDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CancelEnvironmentDeployment operation returned by the service.
- See Also:
-
-
cancelServiceInstanceDeployment
default CancelServiceInstanceDeploymentResponse cancelServiceInstanceDeployment(CancelServiceInstanceDeploymentRequest cancelServiceInstanceDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
cancelServiceInstanceDeploymentRequest
-- Returns:
- Result of the CancelServiceInstanceDeployment operation returned by the service.
- See Also:
-
-
cancelServiceInstanceDeployment
default CancelServiceInstanceDeploymentResponse cancelServiceInstanceDeployment(Consumer<CancelServiceInstanceDeploymentRequest.Builder> cancelServiceInstanceDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CancelServiceInstanceDeploymentRequest.Builder
avoiding the need to create one manually viaCancelServiceInstanceDeploymentRequest.builder()
- Parameters:
cancelServiceInstanceDeploymentRequest
- AConsumer
that will call methods onCancelServiceInstanceDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CancelServiceInstanceDeployment operation returned by the service.
- See Also:
-
-
cancelServicePipelineDeployment
default CancelServicePipelineDeploymentResponse cancelServicePipelineDeployment(CancelServicePipelineDeploymentRequest cancelServicePipelineDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
cancelServicePipelineDeploymentRequest
-- Returns:
- Result of the CancelServicePipelineDeployment operation returned by the service.
- See Also:
-
-
cancelServicePipelineDeployment
default CancelServicePipelineDeploymentResponse cancelServicePipelineDeployment(Consumer<CancelServicePipelineDeploymentRequest.Builder> cancelServicePipelineDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CancelServicePipelineDeploymentRequest.Builder
avoiding the need to create one manually viaCancelServicePipelineDeploymentRequest.builder()
- Parameters:
cancelServicePipelineDeploymentRequest
- AConsumer
that will call methods onCancelServicePipelineDeploymentRequest.Builder
to create a request.- Returns:
- Result of the CancelServicePipelineDeployment operation returned by the service.
- See Also:
-
-
createComponent
default CreateComponentResponse createComponent(CreateComponentRequest createComponentRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createComponentRequest
-- Returns:
- Result of the CreateComponent operation returned by the service.
- See Also:
-
createComponent
default CreateComponentResponse createComponent(Consumer<CreateComponentRequest.Builder> createComponentRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateComponentRequest.Builder
avoiding the need to create one manually viaCreateComponentRequest.builder()
- Parameters:
createComponentRequest
- AConsumer
that will call methods onCreateComponentRequest.Builder
to create a request.- Returns:
- Result of the CreateComponent operation returned by the service.
- See Also:
-
createEnvironment
default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createEnvironmentRequest
-- Returns:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
-
createEnvironment
default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentRequest.builder()
- Parameters:
createEnvironmentRequest
- AConsumer
that will call methods onCreateEnvironmentRequest.Builder
to create a request.- Returns:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
-
createEnvironmentAccountConnection
default CreateEnvironmentAccountConnectionResponse createEnvironmentAccountConnection(CreateEnvironmentAccountConnectionRequest createEnvironmentAccountConnectionRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createEnvironmentAccountConnectionRequest
-- Returns:
- Result of the CreateEnvironmentAccountConnection operation returned by the service.
- See Also:
-
createEnvironmentAccountConnection
default CreateEnvironmentAccountConnectionResponse createEnvironmentAccountConnection(Consumer<CreateEnvironmentAccountConnectionRequest.Builder> createEnvironmentAccountConnectionRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateEnvironmentAccountConnectionRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentAccountConnectionRequest.builder()
- Parameters:
createEnvironmentAccountConnectionRequest
- AConsumer
that will call methods onCreateEnvironmentAccountConnectionRequest.Builder
to create a request.- Returns:
- Result of the CreateEnvironmentAccountConnection operation returned by the service.
- See Also:
-
createEnvironmentTemplate
default CreateEnvironmentTemplateResponse createEnvironmentTemplate(CreateEnvironmentTemplateRequest createEnvironmentTemplateRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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 toCUSTOMER_MANAGED
. For more information, see Register and publish an environment template in the Proton User Guide.
- Parameters:
createEnvironmentTemplateRequest
-- Returns:
- Result of the CreateEnvironmentTemplate operation returned by the service.
- See Also:
-
-
createEnvironmentTemplate
default CreateEnvironmentTemplateResponse createEnvironmentTemplate(Consumer<CreateEnvironmentTemplateRequest.Builder> createEnvironmentTemplateRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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 toCUSTOMER_MANAGED
. For more information, see Register and publish an environment template in the Proton User Guide.
This is a convenience which creates an instance of the
CreateEnvironmentTemplateRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentTemplateRequest.builder()
- Parameters:
createEnvironmentTemplateRequest
- AConsumer
that will call methods onCreateEnvironmentTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateEnvironmentTemplate operation returned by the service.
- See Also:
-
-
createEnvironmentTemplateVersion
default CreateEnvironmentTemplateVersionResponse createEnvironmentTemplateVersion(CreateEnvironmentTemplateVersionRequest createEnvironmentTemplateVersionRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createEnvironmentTemplateVersionRequest
-- Returns:
- Result of the CreateEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
createEnvironmentTemplateVersion
default CreateEnvironmentTemplateVersionResponse createEnvironmentTemplateVersion(Consumer<CreateEnvironmentTemplateVersionRequest.Builder> createEnvironmentTemplateVersionRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateEnvironmentTemplateVersionRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentTemplateVersionRequest.builder()
- Parameters:
createEnvironmentTemplateVersionRequest
- AConsumer
that will call methods onCreateEnvironmentTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
createRepository
default CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createRepositoryRequest
-- Returns:
- Result of the CreateRepository operation returned by the service.
- See Also:
-
createRepository
default CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateRepositoryRequest.Builder
avoiding the need to create one manually viaCreateRepositoryRequest.builder()
- Parameters:
createRepositoryRequest
- AConsumer
that will call methods onCreateRepositoryRequest.Builder
to create a request.- Returns:
- Result of the CreateRepository operation returned by the service.
- See Also:
-
createService
default CreateServiceResponse createService(CreateServiceRequest createServiceRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createServiceRequest
-- Returns:
- Result of the CreateService operation returned by the service.
- See Also:
-
createService
default CreateServiceResponse createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateServiceRequest.Builder
avoiding the need to create one manually viaCreateServiceRequest.builder()
- Parameters:
createServiceRequest
- AConsumer
that will call methods onCreateServiceRequest.Builder
to create a request.- Returns:
- Result of the CreateService operation returned by the service.
- See Also:
-
createServiceInstance
default CreateServiceInstanceResponse createServiceInstance(CreateServiceInstanceRequest createServiceInstanceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Create a service instance.
- Parameters:
createServiceInstanceRequest
-- Returns:
- Result of the CreateServiceInstance operation returned by the service.
- See Also:
-
createServiceInstance
default CreateServiceInstanceResponse createServiceInstance(Consumer<CreateServiceInstanceRequest.Builder> createServiceInstanceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Create a service instance.
This is a convenience which creates an instance of the
CreateServiceInstanceRequest.Builder
avoiding the need to create one manually viaCreateServiceInstanceRequest.builder()
- Parameters:
createServiceInstanceRequest
- AConsumer
that will call methods onCreateServiceInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateServiceInstance operation returned by the service.
- See Also:
-
createServiceSyncConfig
default CreateServiceSyncConfigResponse createServiceSyncConfig(CreateServiceSyncConfigRequest createServiceSyncConfigRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Create the Proton Ops configuration file.
- Parameters:
createServiceSyncConfigRequest
-- Returns:
- Result of the CreateServiceSyncConfig operation returned by the service.
- See Also:
-
createServiceSyncConfig
default CreateServiceSyncConfigResponse createServiceSyncConfig(Consumer<CreateServiceSyncConfigRequest.Builder> createServiceSyncConfigRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Create the Proton Ops configuration file.
This is a convenience which creates an instance of the
CreateServiceSyncConfigRequest.Builder
avoiding the need to create one manually viaCreateServiceSyncConfigRequest.builder()
- Parameters:
createServiceSyncConfigRequest
- AConsumer
that will call methods onCreateServiceSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateServiceSyncConfig operation returned by the service.
- See Also:
-
createServiceTemplate
default CreateServiceTemplateResponse createServiceTemplate(CreateServiceTemplateRequest createServiceTemplateRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createServiceTemplateRequest
-- Returns:
- Result of the CreateServiceTemplate operation returned by the service.
- See Also:
-
createServiceTemplate
default CreateServiceTemplateResponse createServiceTemplate(Consumer<CreateServiceTemplateRequest.Builder> createServiceTemplateRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateServiceTemplateRequest.Builder
avoiding the need to create one manually viaCreateServiceTemplateRequest.builder()
- Parameters:
createServiceTemplateRequest
- AConsumer
that will call methods onCreateServiceTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateServiceTemplate operation returned by the service.
- See Also:
-
createServiceTemplateVersion
default CreateServiceTemplateVersionResponse createServiceTemplateVersion(CreateServiceTemplateVersionRequest createServiceTemplateVersionRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createServiceTemplateVersionRequest
-- Returns:
- Result of the CreateServiceTemplateVersion operation returned by the service.
- See Also:
-
createServiceTemplateVersion
default CreateServiceTemplateVersionResponse createServiceTemplateVersion(Consumer<CreateServiceTemplateVersionRequest.Builder> createServiceTemplateVersionRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateServiceTemplateVersionRequest.Builder
avoiding the need to create one manually viaCreateServiceTemplateVersionRequest.builder()
- Parameters:
createServiceTemplateVersionRequest
- AConsumer
that will call methods onCreateServiceTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateServiceTemplateVersion operation returned by the service.
- See Also:
-
createTemplateSyncConfig
default CreateTemplateSyncConfigResponse createTemplateSyncConfig(CreateTemplateSyncConfigRequest createTemplateSyncConfigRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
createTemplateSyncConfigRequest
-- Returns:
- Result of the CreateTemplateSyncConfig operation returned by the service.
- See Also:
-
createTemplateSyncConfig
default CreateTemplateSyncConfigResponse createTemplateSyncConfig(Consumer<CreateTemplateSyncConfigRequest.Builder> createTemplateSyncConfigRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
CreateTemplateSyncConfigRequest.Builder
avoiding the need to create one manually viaCreateTemplateSyncConfigRequest.builder()
- Parameters:
createTemplateSyncConfigRequest
- AConsumer
that will call methods onCreateTemplateSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the CreateTemplateSyncConfig operation returned by the service.
- See Also:
-
deleteComponent
default DeleteComponentResponse deleteComponent(DeleteComponentRequest deleteComponentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
- Parameters:
deleteComponentRequest
-- Returns:
- Result of the DeleteComponent operation returned by the service.
- See Also:
-
deleteComponent
default DeleteComponentResponse deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete an Proton component resource.
For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
DeleteComponentRequest.Builder
avoiding the need to create one manually viaDeleteComponentRequest.builder()
- Parameters:
deleteComponentRequest
- AConsumer
that will call methods onDeleteComponentRequest.Builder
to create a request.- Returns:
- Result of the DeleteComponent operation returned by the service.
- See Also:
-
deleteDeployment
default DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete the deployment.
- Parameters:
deleteDeploymentRequest
-- Returns:
- Result of the DeleteDeployment operation returned by the service.
- See Also:
-
deleteDeployment
default DeleteDeploymentResponse deleteDeployment(Consumer<DeleteDeploymentRequest.Builder> deleteDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete the deployment.
This is a convenience which creates an instance of the
DeleteDeploymentRequest.Builder
avoiding the need to create one manually viaDeleteDeploymentRequest.builder()
- Parameters:
deleteDeploymentRequest
- AConsumer
that will call methods onDeleteDeploymentRequest.Builder
to create a request.- Returns:
- Result of the DeleteDeployment operation returned by the service.
- See Also:
-
deleteEnvironment
default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete an environment.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteEnvironment
default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete an environment.
This is a convenience which creates an instance of the
DeleteEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentRequest.builder()
- Parameters:
deleteEnvironmentRequest
- AConsumer
that will call methods onDeleteEnvironmentRequest.Builder
to create a request.- Returns:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteEnvironmentAccountConnection
default DeleteEnvironmentAccountConnectionResponse deleteEnvironmentAccountConnection(DeleteEnvironmentAccountConnectionRequest deleteEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
deleteEnvironmentAccountConnectionRequest
-- Returns:
- Result of the DeleteEnvironmentAccountConnection operation returned by the service.
- See Also:
-
deleteEnvironmentAccountConnection
default DeleteEnvironmentAccountConnectionResponse deleteEnvironmentAccountConnection(Consumer<DeleteEnvironmentAccountConnectionRequest.Builder> deleteEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
DeleteEnvironmentAccountConnectionRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentAccountConnectionRequest.builder()
- Parameters:
deleteEnvironmentAccountConnectionRequest
- AConsumer
that will call methods onDeleteEnvironmentAccountConnectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteEnvironmentAccountConnection operation returned by the service.
- See Also:
-
deleteEnvironmentTemplate
default DeleteEnvironmentTemplateResponse deleteEnvironmentTemplate(DeleteEnvironmentTemplateRequest deleteEnvironmentTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException If no other major or minor versions of an environment template exist, delete the environment template.
- Parameters:
deleteEnvironmentTemplateRequest
-- Returns:
- Result of the DeleteEnvironmentTemplate operation returned by the service.
- See Also:
-
deleteEnvironmentTemplate
default DeleteEnvironmentTemplateResponse deleteEnvironmentTemplate(Consumer<DeleteEnvironmentTemplateRequest.Builder> deleteEnvironmentTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException If no other major or minor versions of an environment template exist, delete the environment template.
This is a convenience which creates an instance of the
DeleteEnvironmentTemplateRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentTemplateRequest.builder()
- Parameters:
deleteEnvironmentTemplateRequest
- AConsumer
that will call methods onDeleteEnvironmentTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteEnvironmentTemplate operation returned by the service.
- See Also:
-
deleteEnvironmentTemplateVersion
default DeleteEnvironmentTemplateVersionResponse deleteEnvironmentTemplateVersion(DeleteEnvironmentTemplateVersionRequest deleteEnvironmentTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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 theRecommended
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 aRecommended
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.- Parameters:
deleteEnvironmentTemplateVersionRequest
-- Returns:
- Result of the DeleteEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
deleteEnvironmentTemplateVersion
default DeleteEnvironmentTemplateVersionResponse deleteEnvironmentTemplateVersion(Consumer<DeleteEnvironmentTemplateVersionRequest.Builder> deleteEnvironmentTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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 theRecommended
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 aRecommended
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.
This is a convenience which creates an instance of the
DeleteEnvironmentTemplateVersionRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentTemplateVersionRequest.builder()
- Parameters:
deleteEnvironmentTemplateVersionRequest
- AConsumer
that will call methods onDeleteEnvironmentTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException De-register and unlink your repository.
- Parameters:
deleteRepositoryRequest
-- Returns:
- Result of the DeleteRepository operation returned by the service.
- See Also:
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException De-register and unlink your repository.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryRequest.builder()
- Parameters:
deleteRepositoryRequest
- AConsumer
that will call methods onDeleteRepositoryRequest.Builder
to create a request.- Returns:
- Result of the DeleteRepository operation returned by the service.
- See Also:
-
deleteService
default DeleteServiceResponse deleteService(DeleteServiceRequest deleteServiceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete a service, with its instances and pipeline.
You can't delete a service if it has any service instances that have components attached to them.
For more information about components, see Proton components in the Proton User Guide.
- Parameters:
deleteServiceRequest
-- Returns:
- Result of the DeleteService operation returned by the service.
- See Also:
-
deleteService
default DeleteServiceResponse deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete a service, with its instances and pipeline.
You can't delete a service if it has any service instances that have components attached to them.
For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
DeleteServiceRequest.Builder
avoiding the need to create one manually viaDeleteServiceRequest.builder()
- Parameters:
deleteServiceRequest
- AConsumer
that will call methods onDeleteServiceRequest.Builder
to create a request.- Returns:
- Result of the DeleteService operation returned by the service.
- See Also:
-
deleteServiceSyncConfig
default DeleteServiceSyncConfigResponse deleteServiceSyncConfig(DeleteServiceSyncConfigRequest deleteServiceSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete the Proton Ops file.
- Parameters:
deleteServiceSyncConfigRequest
-- Returns:
- Result of the DeleteServiceSyncConfig operation returned by the service.
- See Also:
-
deleteServiceSyncConfig
default DeleteServiceSyncConfigResponse deleteServiceSyncConfig(Consumer<DeleteServiceSyncConfigRequest.Builder> deleteServiceSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete the Proton Ops file.
This is a convenience which creates an instance of the
DeleteServiceSyncConfigRequest.Builder
avoiding the need to create one manually viaDeleteServiceSyncConfigRequest.builder()
- Parameters:
deleteServiceSyncConfigRequest
- AConsumer
that will call methods onDeleteServiceSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteServiceSyncConfig operation returned by the service.
- See Also:
-
deleteServiceTemplate
default DeleteServiceTemplateResponse deleteServiceTemplate(DeleteServiceTemplateRequest deleteServiceTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException If no other major or minor versions of the service template exist, delete the service template.
- Parameters:
deleteServiceTemplateRequest
-- Returns:
- Result of the DeleteServiceTemplate operation returned by the service.
- See Also:
-
deleteServiceTemplate
default DeleteServiceTemplateResponse deleteServiceTemplate(Consumer<DeleteServiceTemplateRequest.Builder> deleteServiceTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException If no other major or minor versions of the service template exist, delete the service template.
This is a convenience which creates an instance of the
DeleteServiceTemplateRequest.Builder
avoiding the need to create one manually viaDeleteServiceTemplateRequest.builder()
- Parameters:
deleteServiceTemplateRequest
- AConsumer
that will call methods onDeleteServiceTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteServiceTemplate operation returned by the service.
- See Also:
-
deleteServiceTemplateVersion
default DeleteServiceTemplateVersionResponse deleteServiceTemplateVersion(DeleteServiceTemplateVersionRequest deleteServiceTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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 theRecommended
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 aRecommended
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.- Parameters:
deleteServiceTemplateVersionRequest
-- Returns:
- Result of the DeleteServiceTemplateVersion operation returned by the service.
- See Also:
-
deleteServiceTemplateVersion
default DeleteServiceTemplateVersionResponse deleteServiceTemplateVersion(Consumer<DeleteServiceTemplateVersionRequest.Builder> deleteServiceTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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 theRecommended
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 aRecommended
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.
This is a convenience which creates an instance of the
DeleteServiceTemplateVersionRequest.Builder
avoiding the need to create one manually viaDeleteServiceTemplateVersionRequest.builder()
- Parameters:
deleteServiceTemplateVersionRequest
- AConsumer
that will call methods onDeleteServiceTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteServiceTemplateVersion operation returned by the service.
- See Also:
-
deleteTemplateSyncConfig
default DeleteTemplateSyncConfigResponse deleteTemplateSyncConfig(DeleteTemplateSyncConfigRequest deleteTemplateSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete a template sync configuration.
- Parameters:
deleteTemplateSyncConfigRequest
-- Returns:
- Result of the DeleteTemplateSyncConfig operation returned by the service.
- See Also:
-
deleteTemplateSyncConfig
default DeleteTemplateSyncConfigResponse deleteTemplateSyncConfig(Consumer<DeleteTemplateSyncConfigRequest.Builder> deleteTemplateSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Delete a template sync configuration.
This is a convenience which creates an instance of the
DeleteTemplateSyncConfigRequest.Builder
avoiding the need to create one manually viaDeleteTemplateSyncConfigRequest.builder()
- Parameters:
deleteTemplateSyncConfigRequest
- AConsumer
that will call methods onDeleteTemplateSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the DeleteTemplateSyncConfig operation returned by the service.
- See Also:
-
getAccountSettings
default GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detail data for Proton account-wide settings.
- Parameters:
getAccountSettingsRequest
-- Returns:
- Result of the GetAccountSettings operation returned by the service.
- See Also:
-
getAccountSettings
default GetAccountSettingsResponse getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detail data for Proton account-wide settings.
This is a convenience which creates an instance of the
GetAccountSettingsRequest.Builder
avoiding the need to create one manually viaGetAccountSettingsRequest.builder()
- Parameters:
getAccountSettingsRequest
- AConsumer
that will call methods onGetAccountSettingsRequest.Builder
to create a request.- Returns:
- Result of the GetAccountSettings operation returned by the service.
- See Also:
-
getComponent
default GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide.
- Parameters:
getComponentRequest
-- Returns:
- Result of the GetComponent operation returned by the service.
- See Also:
-
getComponent
default GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a component.
For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
GetComponentRequest.Builder
avoiding the need to create one manually viaGetComponentRequest.builder()
- Parameters:
getComponentRequest
- AConsumer
that will call methods onGetComponentRequest.Builder
to create a request.- Returns:
- Result of the GetComponent operation returned by the service.
- See Also:
-
getDeployment
default GetDeploymentResponse getDeployment(GetDeploymentRequest getDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a deployment.
- Parameters:
getDeploymentRequest
-- Returns:
- Result of the GetDeployment operation returned by the service.
- See Also:
-
getDeployment
default GetDeploymentResponse getDeployment(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a deployment.
This is a convenience which creates an instance of the
GetDeploymentRequest.Builder
avoiding the need to create one manually viaGetDeploymentRequest.builder()
- Parameters:
getDeploymentRequest
- AConsumer
that will call methods onGetDeploymentRequest.Builder
to create a request.- Returns:
- Result of the GetDeployment operation returned by the service.
- See Also:
-
getEnvironment
default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for an environment.
- Parameters:
getEnvironmentRequest
-- Returns:
- Result of the GetEnvironment operation returned by the service.
- See Also:
-
getEnvironment
default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for an environment.
This is a convenience which creates an instance of the
GetEnvironmentRequest.Builder
avoiding the need to create one manually viaGetEnvironmentRequest.builder()
- Parameters:
getEnvironmentRequest
- AConsumer
that will call methods onGetEnvironmentRequest.Builder
to create a request.- Returns:
- Result of the GetEnvironment operation returned by the service.
- See Also:
-
getEnvironmentAccountConnection
default GetEnvironmentAccountConnectionResponse getEnvironmentAccountConnection(GetEnvironmentAccountConnectionRequest getEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
getEnvironmentAccountConnectionRequest
-- Returns:
- Result of the GetEnvironmentAccountConnection operation returned by the service.
- See Also:
-
getEnvironmentAccountConnection
default GetEnvironmentAccountConnectionResponse getEnvironmentAccountConnection(Consumer<GetEnvironmentAccountConnectionRequest.Builder> getEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
GetEnvironmentAccountConnectionRequest.Builder
avoiding the need to create one manually viaGetEnvironmentAccountConnectionRequest.builder()
- Parameters:
getEnvironmentAccountConnectionRequest
- AConsumer
that will call methods onGetEnvironmentAccountConnectionRequest.Builder
to create a request.- Returns:
- Result of the GetEnvironmentAccountConnection operation returned by the service.
- See Also:
-
getEnvironmentTemplate
default GetEnvironmentTemplateResponse getEnvironmentTemplate(GetEnvironmentTemplateRequest getEnvironmentTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for an environment template.
- Parameters:
getEnvironmentTemplateRequest
-- Returns:
- Result of the GetEnvironmentTemplate operation returned by the service.
- See Also:
-
getEnvironmentTemplate
default GetEnvironmentTemplateResponse getEnvironmentTemplate(Consumer<GetEnvironmentTemplateRequest.Builder> getEnvironmentTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for an environment template.
This is a convenience which creates an instance of the
GetEnvironmentTemplateRequest.Builder
avoiding the need to create one manually viaGetEnvironmentTemplateRequest.builder()
- Parameters:
getEnvironmentTemplateRequest
- AConsumer
that will call methods onGetEnvironmentTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetEnvironmentTemplate operation returned by the service.
- See Also:
-
getEnvironmentTemplateVersion
default GetEnvironmentTemplateVersionResponse getEnvironmentTemplateVersion(GetEnvironmentTemplateVersionRequest getEnvironmentTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a major or minor version of an environment template.
- Parameters:
getEnvironmentTemplateVersionRequest
-- Returns:
- Result of the GetEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
getEnvironmentTemplateVersion
default GetEnvironmentTemplateVersionResponse getEnvironmentTemplateVersion(Consumer<GetEnvironmentTemplateVersionRequest.Builder> getEnvironmentTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a major or minor version of an environment template.
This is a convenience which creates an instance of the
GetEnvironmentTemplateVersionRequest.Builder
avoiding the need to create one manually viaGetEnvironmentTemplateVersionRequest.builder()
- Parameters:
getEnvironmentTemplateVersionRequest
- AConsumer
that will call methods onGetEnvironmentTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the GetEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
getRepository
default GetRepositoryResponse getRepository(GetRepositoryRequest getRepositoryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detail data for a linked repository.
- Parameters:
getRepositoryRequest
-- Returns:
- Result of the GetRepository operation returned by the service.
- See Also:
-
getRepository
default GetRepositoryResponse getRepository(Consumer<GetRepositoryRequest.Builder> getRepositoryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detail data for a linked repository.
This is a convenience which creates an instance of the
GetRepositoryRequest.Builder
avoiding the need to create one manually viaGetRepositoryRequest.builder()
- Parameters:
getRepositoryRequest
- AConsumer
that will call methods onGetRepositoryRequest.Builder
to create a request.- Returns:
- Result of the GetRepository operation returned by the service.
- See Also:
-
getRepositorySyncStatus
default GetRepositorySyncStatusResponse getRepositorySyncStatus(GetRepositorySyncStatusRequest getRepositorySyncStatusRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).
For more information about ABAC, see ABAC in the Proton User Guide.
- Parameters:
getRepositorySyncStatusRequest
-- Returns:
- Result of the GetRepositorySyncStatus operation returned by the service.
- See Also:
-
getRepositorySyncStatus
default GetRepositorySyncStatusResponse getRepositorySyncStatus(Consumer<GetRepositorySyncStatusRequest.Builder> getRepositorySyncStatusRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).
For more information about ABAC, see ABAC in the Proton User Guide.
This is a convenience which creates an instance of the
GetRepositorySyncStatusRequest.Builder
avoiding the need to create one manually viaGetRepositorySyncStatusRequest.builder()
- Parameters:
getRepositorySyncStatusRequest
- AConsumer
that will call methods onGetRepositorySyncStatusRequest.Builder
to create a request.- Returns:
- Result of the GetRepositorySyncStatus operation returned by the service.
- See Also:
-
getResourcesSummary
default GetResourcesSummaryResponse getResourcesSummary(GetResourcesSummaryRequest getResourcesSummaryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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
, andserviceTemplates
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.
- Parameters:
getResourcesSummaryRequest
-- Returns:
- Result of the GetResourcesSummary operation returned by the service.
- See Also:
-
getResourcesSummary
default GetResourcesSummaryResponse getResourcesSummary(Consumer<GetResourcesSummaryRequest.Builder> getResourcesSummaryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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
, andserviceTemplates
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.
This is a convenience which creates an instance of the
GetResourcesSummaryRequest.Builder
avoiding the need to create one manually viaGetResourcesSummaryRequest.builder()
- Parameters:
getResourcesSummaryRequest
- AConsumer
that will call methods onGetResourcesSummaryRequest.Builder
to create a request.- Returns:
- Result of the GetResourcesSummary operation returned by the service.
- See Also:
-
getService
default GetServiceResponse getService(GetServiceRequest getServiceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a service.
- Parameters:
getServiceRequest
-- Returns:
- Result of the GetService operation returned by the service.
- See Also:
-
getService
default GetServiceResponse getService(Consumer<GetServiceRequest.Builder> getServiceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a service.
This is a convenience which creates an instance of the
GetServiceRequest.Builder
avoiding the need to create one manually viaGetServiceRequest.builder()
- Parameters:
getServiceRequest
- AConsumer
that will call methods onGetServiceRequest.Builder
to create a request.- Returns:
- Result of the GetService operation returned by the service.
- See Also:
-
getServiceInstance
default GetServiceInstanceResponse getServiceInstance(GetServiceInstanceRequest getServiceInstanceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
- Parameters:
getServiceInstanceRequest
-- Returns:
- Result of the GetServiceInstance operation returned by the service.
- See Also:
-
getServiceInstance
default GetServiceInstanceResponse getServiceInstance(Consumer<GetServiceInstanceRequest.Builder> getServiceInstanceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
This is a convenience which creates an instance of the
GetServiceInstanceRequest.Builder
avoiding the need to create one manually viaGetServiceInstanceRequest.builder()
- Parameters:
getServiceInstanceRequest
- AConsumer
that will call methods onGetServiceInstanceRequest.Builder
to create a request.- Returns:
- Result of the GetServiceInstance operation returned by the service.
- See Also:
-
getServiceInstanceSyncStatus
default GetServiceInstanceSyncStatusResponse getServiceInstanceSyncStatus(GetServiceInstanceSyncStatusRequest getServiceInstanceSyncStatusRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get the status of the synced service instance.
- Parameters:
getServiceInstanceSyncStatusRequest
-- Returns:
- Result of the GetServiceInstanceSyncStatus operation returned by the service.
- See Also:
-
getServiceInstanceSyncStatus
default GetServiceInstanceSyncStatusResponse getServiceInstanceSyncStatus(Consumer<GetServiceInstanceSyncStatusRequest.Builder> getServiceInstanceSyncStatusRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get the status of the synced service instance.
This is a convenience which creates an instance of the
GetServiceInstanceSyncStatusRequest.Builder
avoiding the need to create one manually viaGetServiceInstanceSyncStatusRequest.builder()
- Parameters:
getServiceInstanceSyncStatusRequest
- AConsumer
that will call methods onGetServiceInstanceSyncStatusRequest.Builder
to create a request.- Returns:
- Result of the GetServiceInstanceSyncStatus operation returned by the service.
- See Also:
-
getServiceSyncBlockerSummary
default GetServiceSyncBlockerSummaryResponse getServiceSyncBlockerSummary(GetServiceSyncBlockerSummaryRequest getServiceSyncBlockerSummaryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for the service sync blocker summary.
- Parameters:
getServiceSyncBlockerSummaryRequest
-- Returns:
- Result of the GetServiceSyncBlockerSummary operation returned by the service.
- See Also:
-
getServiceSyncBlockerSummary
default GetServiceSyncBlockerSummaryResponse getServiceSyncBlockerSummary(Consumer<GetServiceSyncBlockerSummaryRequest.Builder> getServiceSyncBlockerSummaryRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for the service sync blocker summary.
This is a convenience which creates an instance of the
GetServiceSyncBlockerSummaryRequest.Builder
avoiding the need to create one manually viaGetServiceSyncBlockerSummaryRequest.builder()
- Parameters:
getServiceSyncBlockerSummaryRequest
- AConsumer
that will call methods onGetServiceSyncBlockerSummaryRequest.Builder
to create a request.- Returns:
- Result of the GetServiceSyncBlockerSummary operation returned by the service.
- See Also:
-
getServiceSyncConfig
default GetServiceSyncConfigResponse getServiceSyncConfig(GetServiceSyncConfigRequest getServiceSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed information for the service sync configuration.
- Parameters:
getServiceSyncConfigRequest
-- Returns:
- Result of the GetServiceSyncConfig operation returned by the service.
- See Also:
-
getServiceSyncConfig
default GetServiceSyncConfigResponse getServiceSyncConfig(Consumer<GetServiceSyncConfigRequest.Builder> getServiceSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed information for the service sync configuration.
This is a convenience which creates an instance of the
GetServiceSyncConfigRequest.Builder
avoiding the need to create one manually viaGetServiceSyncConfigRequest.builder()
- Parameters:
getServiceSyncConfigRequest
- AConsumer
that will call methods onGetServiceSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the GetServiceSyncConfig operation returned by the service.
- See Also:
-
getServiceTemplate
default GetServiceTemplateResponse getServiceTemplate(GetServiceTemplateRequest getServiceTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a service template.
- Parameters:
getServiceTemplateRequest
-- Returns:
- Result of the GetServiceTemplate operation returned by the service.
- See Also:
-
getServiceTemplate
default GetServiceTemplateResponse getServiceTemplate(Consumer<GetServiceTemplateRequest.Builder> getServiceTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a service template.
This is a convenience which creates an instance of the
GetServiceTemplateRequest.Builder
avoiding the need to create one manually viaGetServiceTemplateRequest.builder()
- Parameters:
getServiceTemplateRequest
- AConsumer
that will call methods onGetServiceTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetServiceTemplate operation returned by the service.
- See Also:
-
getServiceTemplateVersion
default GetServiceTemplateVersionResponse getServiceTemplateVersion(GetServiceTemplateVersionRequest getServiceTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a major or minor version of a service template.
- Parameters:
getServiceTemplateVersionRequest
-- Returns:
- Result of the GetServiceTemplateVersion operation returned by the service.
- See Also:
-
getServiceTemplateVersion
default GetServiceTemplateVersionResponse getServiceTemplateVersion(Consumer<GetServiceTemplateVersionRequest.Builder> getServiceTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detailed data for a major or minor version of a service template.
This is a convenience which creates an instance of the
GetServiceTemplateVersionRequest.Builder
avoiding the need to create one manually viaGetServiceTemplateVersionRequest.builder()
- Parameters:
getServiceTemplateVersionRequest
- AConsumer
that will call methods onGetServiceTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the GetServiceTemplateVersion operation returned by the service.
- See Also:
-
getTemplateSyncConfig
default GetTemplateSyncConfigResponse getTemplateSyncConfig(GetTemplateSyncConfigRequest getTemplateSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detail data for a template sync configuration.
- Parameters:
getTemplateSyncConfigRequest
-- Returns:
- Result of the GetTemplateSyncConfig operation returned by the service.
- See Also:
-
getTemplateSyncConfig
default GetTemplateSyncConfigResponse getTemplateSyncConfig(Consumer<GetTemplateSyncConfigRequest.Builder> getTemplateSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get detail data for a template sync configuration.
This is a convenience which creates an instance of the
GetTemplateSyncConfigRequest.Builder
avoiding the need to create one manually viaGetTemplateSyncConfigRequest.builder()
- Parameters:
getTemplateSyncConfigRequest
- AConsumer
that will call methods onGetTemplateSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the GetTemplateSyncConfig operation returned by the service.
- See Also:
-
getTemplateSyncStatus
default GetTemplateSyncStatusResponse getTemplateSyncStatus(GetTemplateSyncStatusRequest getTemplateSyncStatusRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get the status of a template sync.
- Parameters:
getTemplateSyncStatusRequest
-- Returns:
- Result of the GetTemplateSyncStatus operation returned by the service.
- See Also:
-
getTemplateSyncStatus
default GetTemplateSyncStatusResponse getTemplateSyncStatus(Consumer<GetTemplateSyncStatusRequest.Builder> getTemplateSyncStatusRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get the status of a template sync.
This is a convenience which creates an instance of the
GetTemplateSyncStatusRequest.Builder
avoiding the need to create one manually viaGetTemplateSyncStatusRequest.builder()
- Parameters:
getTemplateSyncStatusRequest
- AConsumer
that will call methods onGetTemplateSyncStatusRequest.Builder
to create a request.- Returns:
- Result of the GetTemplateSyncStatus operation returned by the service.
- See Also:
-
listComponentOutputs
default ListComponentOutputsResponse listComponentOutputs(ListComponentOutputsRequest listComponentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide.
- Parameters:
listComponentOutputsRequest
-- Returns:
- Result of the ListComponentOutputs operation returned by the service.
- See Also:
-
listComponentOutputs
default ListComponentOutputsResponse listComponentOutputs(Consumer<ListComponentOutputsRequest.Builder> listComponentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get a list of component Infrastructure as Code (IaC) outputs.
For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
ListComponentOutputsRequest.Builder
avoiding the need to create one manually viaListComponentOutputsRequest.builder()
- Parameters:
listComponentOutputsRequest
- AConsumer
that will call methods onListComponentOutputsRequest.Builder
to create a request.- Returns:
- Result of the ListComponentOutputs operation returned by the service.
- See Also:
-
listComponentOutputsPaginator
default ListComponentOutputsIterable listComponentOutputsPaginator(ListComponentOutputsRequest listComponentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listComponentOutputs(software.amazon.awssdk.services.proton.model.ListComponentOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListComponentOutputsIterable responses = client.listComponentOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListComponentOutputsIterable responses = client .listComponentOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListComponentOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListComponentOutputsIterable responses = client.listComponentOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponentOutputs(software.amazon.awssdk.services.proton.model.ListComponentOutputsRequest)
operation.- Parameters:
listComponentOutputsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentOutputsPaginator
default ListComponentOutputsIterable listComponentOutputsPaginator(Consumer<ListComponentOutputsRequest.Builder> listComponentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listComponentOutputs(software.amazon.awssdk.services.proton.model.ListComponentOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListComponentOutputsIterable responses = client.listComponentOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListComponentOutputsIterable responses = client .listComponentOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListComponentOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListComponentOutputsIterable responses = client.listComponentOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponentOutputs(software.amazon.awssdk.services.proton.model.ListComponentOutputsRequest)
operation.
This is a convenience which creates an instance of the
ListComponentOutputsRequest.Builder
avoiding the need to create one manually viaListComponentOutputsRequest.builder()
- Parameters:
listComponentOutputsRequest
- AConsumer
that will call methods onListComponentOutputsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentProvisionedResources
default ListComponentProvisionedResourcesResponse listComponentProvisionedResources(ListComponentProvisionedResourcesRequest listComponentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide.
- Parameters:
listComponentProvisionedResourcesRequest
-- Returns:
- Result of the ListComponentProvisionedResources operation returned by the service.
- See Also:
-
listComponentProvisionedResources
default ListComponentProvisionedResourcesResponse listComponentProvisionedResources(Consumer<ListComponentProvisionedResourcesRequest.Builder> listComponentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List provisioned resources for a component with details.
For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
ListComponentProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListComponentProvisionedResourcesRequest.builder()
- Parameters:
listComponentProvisionedResourcesRequest
- AConsumer
that will call methods onListComponentProvisionedResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListComponentProvisionedResources operation returned by the service.
- See Also:
-
listComponentProvisionedResourcesPaginator
default ListComponentProvisionedResourcesIterable listComponentProvisionedResourcesPaginator(ListComponentProvisionedResourcesRequest listComponentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listComponentProvisionedResources(software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListComponentProvisionedResourcesIterable responses = client.listComponentProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListComponentProvisionedResourcesIterable responses = client .listComponentProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListComponentProvisionedResourcesIterable responses = client.listComponentProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponentProvisionedResources(software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesRequest)
operation.- Parameters:
listComponentProvisionedResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentProvisionedResourcesPaginator
default ListComponentProvisionedResourcesIterable listComponentProvisionedResourcesPaginator(Consumer<ListComponentProvisionedResourcesRequest.Builder> listComponentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listComponentProvisionedResources(software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListComponentProvisionedResourcesIterable responses = client.listComponentProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListComponentProvisionedResourcesIterable responses = client .listComponentProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListComponentProvisionedResourcesIterable responses = client.listComponentProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponentProvisionedResources(software.amazon.awssdk.services.proton.model.ListComponentProvisionedResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListComponentProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListComponentProvisionedResourcesRequest.builder()
- Parameters:
listComponentProvisionedResourcesRequest
- AConsumer
that will call methods onListComponentProvisionedResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponents
default ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
- Parameters:
listComponentsRequest
-- Returns:
- Result of the ListComponents operation returned by the service.
- See Also:
-
listComponents
default ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException 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.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- Result of the ListComponents operation returned by the service.
- See Also:
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listComponents(software.amazon.awssdk.services.proton.model.ListComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponents(software.amazon.awssdk.services.proton.model.ListComponentsRequest)
operation.- Parameters:
listComponentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listComponents(software.amazon.awssdk.services.proton.model.ListComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponents(software.amazon.awssdk.services.proton.model.ListComponentsRequest)
operation.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDeployments
default ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List deployments. You can filter the result list by environment, service, or a single service instance.
- Parameters:
listDeploymentsRequest
-- Returns:
- Result of the ListDeployments operation returned by the service.
- See Also:
-
listDeployments
default ListDeploymentsResponse listDeployments(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List deployments. You can filter the result list by environment, service, or a single service instance.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- Result of the ListDeployments operation returned by the service.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(ListDeploymentsRequest listDeploymentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listDeployments(software.amazon.awssdk.services.proton.model.ListDeploymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.proton.model.ListDeploymentsRequest)
operation.- Parameters:
listDeploymentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDeploymentsPaginator
default ListDeploymentsIterable listDeploymentsPaginator(Consumer<ListDeploymentsRequest.Builder> listDeploymentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listDeployments(software.amazon.awssdk.services.proton.model.ListDeploymentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListDeploymentsIterable responses = client .listDeploymentsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListDeploymentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListDeploymentsIterable responses = client.listDeploymentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDeployments(software.amazon.awssdk.services.proton.model.ListDeploymentsRequest)
operation.
This is a convenience which creates an instance of the
ListDeploymentsRequest.Builder
avoiding the need to create one manually viaListDeploymentsRequest.builder()
- Parameters:
listDeploymentsRequest
- AConsumer
that will call methods onListDeploymentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentAccountConnections
default ListEnvironmentAccountConnectionsResponse listEnvironmentAccountConnections(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException View a list of environment account connections.
For more information, see Environment account connections in the Proton User guide.
- Parameters:
listEnvironmentAccountConnectionsRequest
-- Returns:
- Result of the ListEnvironmentAccountConnections operation returned by the service.
- See Also:
-
listEnvironmentAccountConnections
default ListEnvironmentAccountConnectionsResponse listEnvironmentAccountConnections(Consumer<ListEnvironmentAccountConnectionsRequest.Builder> listEnvironmentAccountConnectionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException View a list of environment account connections.
For more information, see Environment account connections in the Proton User guide.
This is a convenience which creates an instance of the
ListEnvironmentAccountConnectionsRequest.Builder
avoiding the need to create one manually viaListEnvironmentAccountConnectionsRequest.builder()
- Parameters:
listEnvironmentAccountConnectionsRequest
- AConsumer
that will call methods onListEnvironmentAccountConnectionsRequest.Builder
to create a request.- Returns:
- Result of the ListEnvironmentAccountConnections operation returned by the service.
- See Also:
-
listEnvironmentAccountConnectionsPaginator
default ListEnvironmentAccountConnectionsIterable listEnvironmentAccountConnectionsPaginator(ListEnvironmentAccountConnectionsRequest listEnvironmentAccountConnectionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentAccountConnections(software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentAccountConnectionsIterable responses = client.listEnvironmentAccountConnectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentAccountConnectionsIterable responses = client .listEnvironmentAccountConnectionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentAccountConnectionsIterable responses = client.listEnvironmentAccountConnectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentAccountConnections(software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsRequest)
operation.- Parameters:
listEnvironmentAccountConnectionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentAccountConnectionsPaginator
default ListEnvironmentAccountConnectionsIterable listEnvironmentAccountConnectionsPaginator(Consumer<ListEnvironmentAccountConnectionsRequest.Builder> listEnvironmentAccountConnectionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentAccountConnections(software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentAccountConnectionsIterable responses = client.listEnvironmentAccountConnectionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentAccountConnectionsIterable responses = client .listEnvironmentAccountConnectionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentAccountConnectionsIterable responses = client.listEnvironmentAccountConnectionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentAccountConnections(software.amazon.awssdk.services.proton.model.ListEnvironmentAccountConnectionsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentAccountConnectionsRequest.Builder
avoiding the need to create one manually viaListEnvironmentAccountConnectionsRequest.builder()
- Parameters:
listEnvironmentAccountConnectionsRequest
- AConsumer
that will call methods onListEnvironmentAccountConnectionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentOutputs
default ListEnvironmentOutputsResponse listEnvironmentOutputs(ListEnvironmentOutputsRequest listEnvironmentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List the infrastructure as code outputs for your environment.
- Parameters:
listEnvironmentOutputsRequest
-- Returns:
- Result of the ListEnvironmentOutputs operation returned by the service.
- See Also:
-
listEnvironmentOutputs
default ListEnvironmentOutputsResponse listEnvironmentOutputs(Consumer<ListEnvironmentOutputsRequest.Builder> listEnvironmentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List the infrastructure as code outputs for your environment.
This is a convenience which creates an instance of the
ListEnvironmentOutputsRequest.Builder
avoiding the need to create one manually viaListEnvironmentOutputsRequest.builder()
- Parameters:
listEnvironmentOutputsRequest
- AConsumer
that will call methods onListEnvironmentOutputsRequest.Builder
to create a request.- Returns:
- Result of the ListEnvironmentOutputs operation returned by the service.
- See Also:
-
listEnvironmentOutputsPaginator
default ListEnvironmentOutputsIterable listEnvironmentOutputsPaginator(ListEnvironmentOutputsRequest listEnvironmentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentOutputs(software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentOutputsIterable responses = client.listEnvironmentOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentOutputsIterable responses = client .listEnvironmentOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentOutputsIterable responses = client.listEnvironmentOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentOutputs(software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsRequest)
operation.- Parameters:
listEnvironmentOutputsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentOutputsPaginator
default ListEnvironmentOutputsIterable listEnvironmentOutputsPaginator(Consumer<ListEnvironmentOutputsRequest.Builder> listEnvironmentOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentOutputs(software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentOutputsIterable responses = client.listEnvironmentOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentOutputsIterable responses = client .listEnvironmentOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentOutputsIterable responses = client.listEnvironmentOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentOutputs(software.amazon.awssdk.services.proton.model.ListEnvironmentOutputsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentOutputsRequest.Builder
avoiding the need to create one manually viaListEnvironmentOutputsRequest.builder()
- Parameters:
listEnvironmentOutputsRequest
- AConsumer
that will call methods onListEnvironmentOutputsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentProvisionedResources
default ListEnvironmentProvisionedResourcesResponse listEnvironmentProvisionedResources(ListEnvironmentProvisionedResourcesRequest listEnvironmentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List the provisioned resources for your environment.
- Parameters:
listEnvironmentProvisionedResourcesRequest
-- Returns:
- Result of the ListEnvironmentProvisionedResources operation returned by the service.
- See Also:
-
listEnvironmentProvisionedResources
default ListEnvironmentProvisionedResourcesResponse listEnvironmentProvisionedResources(Consumer<ListEnvironmentProvisionedResourcesRequest.Builder> listEnvironmentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List the provisioned resources for your environment.
This is a convenience which creates an instance of the
ListEnvironmentProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListEnvironmentProvisionedResourcesRequest.builder()
- Parameters:
listEnvironmentProvisionedResourcesRequest
- AConsumer
that will call methods onListEnvironmentProvisionedResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListEnvironmentProvisionedResources operation returned by the service.
- See Also:
-
listEnvironmentProvisionedResourcesPaginator
default ListEnvironmentProvisionedResourcesIterable listEnvironmentProvisionedResourcesPaginator(ListEnvironmentProvisionedResourcesRequest listEnvironmentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentProvisionedResources(software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentProvisionedResourcesIterable responses = client.listEnvironmentProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentProvisionedResourcesIterable responses = client .listEnvironmentProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentProvisionedResourcesIterable responses = client.listEnvironmentProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentProvisionedResources(software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesRequest)
operation.- Parameters:
listEnvironmentProvisionedResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentProvisionedResourcesPaginator
default ListEnvironmentProvisionedResourcesIterable listEnvironmentProvisionedResourcesPaginator(Consumer<ListEnvironmentProvisionedResourcesRequest.Builder> listEnvironmentProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentProvisionedResources(software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentProvisionedResourcesIterable responses = client.listEnvironmentProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentProvisionedResourcesIterable responses = client .listEnvironmentProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentProvisionedResourcesIterable responses = client.listEnvironmentProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentProvisionedResources(software.amazon.awssdk.services.proton.model.ListEnvironmentProvisionedResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListEnvironmentProvisionedResourcesRequest.builder()
- Parameters:
listEnvironmentProvisionedResourcesRequest
- AConsumer
that will call methods onListEnvironmentProvisionedResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentTemplateVersions
default ListEnvironmentTemplateVersionsResponse listEnvironmentTemplateVersions(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List major or minor versions of an environment template with detail data.
- Parameters:
listEnvironmentTemplateVersionsRequest
-- Returns:
- Result of the ListEnvironmentTemplateVersions operation returned by the service.
- See Also:
-
listEnvironmentTemplateVersions
default ListEnvironmentTemplateVersionsResponse listEnvironmentTemplateVersions(Consumer<ListEnvironmentTemplateVersionsRequest.Builder> listEnvironmentTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List major or minor versions of an environment template with detail data.
This is a convenience which creates an instance of the
ListEnvironmentTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListEnvironmentTemplateVersionsRequest.builder()
- Parameters:
listEnvironmentTemplateVersionsRequest
- AConsumer
that will call methods onListEnvironmentTemplateVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListEnvironmentTemplateVersions operation returned by the service.
- See Also:
-
listEnvironmentTemplateVersionsPaginator
default ListEnvironmentTemplateVersionsIterable listEnvironmentTemplateVersionsPaginator(ListEnvironmentTemplateVersionsRequest listEnvironmentTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentTemplateVersions(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplateVersionsIterable responses = client.listEnvironmentTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplateVersionsIterable responses = client .listEnvironmentTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplateVersionsIterable responses = client.listEnvironmentTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentTemplateVersions(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsRequest)
operation.- Parameters:
listEnvironmentTemplateVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentTemplateVersionsPaginator
default ListEnvironmentTemplateVersionsIterable listEnvironmentTemplateVersionsPaginator(Consumer<ListEnvironmentTemplateVersionsRequest.Builder> listEnvironmentTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentTemplateVersions(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplateVersionsIterable responses = client.listEnvironmentTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplateVersionsIterable responses = client .listEnvironmentTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplateVersionsIterable responses = client.listEnvironmentTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentTemplateVersions(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListEnvironmentTemplateVersionsRequest.builder()
- Parameters:
listEnvironmentTemplateVersionsRequest
- AConsumer
that will call methods onListEnvironmentTemplateVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentTemplates
default ListEnvironmentTemplatesResponse listEnvironmentTemplates(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List environment templates.
- Parameters:
listEnvironmentTemplatesRequest
-- Returns:
- Result of the ListEnvironmentTemplates operation returned by the service.
- See Also:
-
listEnvironmentTemplates
default ListEnvironmentTemplatesResponse listEnvironmentTemplates(Consumer<ListEnvironmentTemplatesRequest.Builder> listEnvironmentTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List environment templates.
This is a convenience which creates an instance of the
ListEnvironmentTemplatesRequest.Builder
avoiding the need to create one manually viaListEnvironmentTemplatesRequest.builder()
- Parameters:
listEnvironmentTemplatesRequest
- AConsumer
that will call methods onListEnvironmentTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListEnvironmentTemplates operation returned by the service.
- See Also:
-
listEnvironmentTemplatesPaginator
default ListEnvironmentTemplatesIterable listEnvironmentTemplatesPaginator(ListEnvironmentTemplatesRequest listEnvironmentTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentTemplates(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplatesIterable responses = client.listEnvironmentTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplatesIterable responses = client .listEnvironmentTemplatesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplatesIterable responses = client.listEnvironmentTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentTemplates(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesRequest)
operation.- Parameters:
listEnvironmentTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentTemplatesPaginator
default ListEnvironmentTemplatesIterable listEnvironmentTemplatesPaginator(Consumer<ListEnvironmentTemplatesRequest.Builder> listEnvironmentTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironmentTemplates(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplatesIterable responses = client.listEnvironmentTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplatesIterable responses = client .listEnvironmentTemplatesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentTemplatesIterable responses = client.listEnvironmentTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironmentTemplates(software.amazon.awssdk.services.proton.model.ListEnvironmentTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentTemplatesRequest.Builder
avoiding the need to create one manually viaListEnvironmentTemplatesRequest.builder()
- Parameters:
listEnvironmentTemplatesRequest
- AConsumer
that will call methods onListEnvironmentTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List environments with detail data summaries.
- Parameters:
listEnvironmentsRequest
-- Returns:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironments
default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List environments with detail data summaries.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironments(software.amazon.awssdk.services.proton.model.ListEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentsIterable responses = client .listEnvironmentsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.proton.model.ListEnvironmentsRequest)
operation.- Parameters:
listEnvironmentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEnvironmentsPaginator
default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listEnvironments(software.amazon.awssdk.services.proton.model.ListEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListEnvironmentsIterable responses = client .listEnvironmentsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEnvironments(software.amazon.awssdk.services.proton.model.ListEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the
ListEnvironmentsRequest.Builder
avoiding the need to create one manually viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRepositories
default ListRepositoriesResponse listRepositories(ListRepositoriesRequest listRepositoriesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List linked repositories with detail data.
- Parameters:
listRepositoriesRequest
-- Returns:
- Result of the ListRepositories operation returned by the service.
- See Also:
-
listRepositories
default ListRepositoriesResponse listRepositories(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List linked repositories with detail data.
This is a convenience which creates an instance of the
ListRepositoriesRequest.Builder
avoiding the need to create one manually viaListRepositoriesRequest.builder()
- Parameters:
listRepositoriesRequest
- AConsumer
that will call methods onListRepositoriesRequest.Builder
to create a request.- Returns:
- Result of the ListRepositories operation returned by the service.
- See Also:
-
listRepositoriesPaginator
default ListRepositoriesIterable listRepositoriesPaginator(ListRepositoriesRequest listRepositoriesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listRepositories(software.amazon.awssdk.services.proton.model.ListRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListRepositoriesIterable responses = client.listRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListRepositoriesIterable responses = client .listRepositoriesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListRepositoriesIterable responses = client.listRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.proton.model.ListRepositoriesRequest)
operation.- Parameters:
listRepositoriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRepositoriesPaginator
default ListRepositoriesIterable listRepositoriesPaginator(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listRepositories(software.amazon.awssdk.services.proton.model.ListRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListRepositoriesIterable responses = client.listRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListRepositoriesIterable responses = client .listRepositoriesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListRepositoriesIterable responses = client.listRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.proton.model.ListRepositoriesRequest)
operation.
This is a convenience which creates an instance of the
ListRepositoriesRequest.Builder
avoiding the need to create one manually viaListRepositoriesRequest.builder()
- Parameters:
listRepositoriesRequest
- AConsumer
that will call methods onListRepositoriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRepositorySyncDefinitions
default ListRepositorySyncDefinitionsResponse listRepositorySyncDefinitions(ListRepositorySyncDefinitionsRequest listRepositorySyncDefinitionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List repository sync definitions with detail data.
- Parameters:
listRepositorySyncDefinitionsRequest
-- Returns:
- Result of the ListRepositorySyncDefinitions operation returned by the service.
- See Also:
-
listRepositorySyncDefinitions
default ListRepositorySyncDefinitionsResponse listRepositorySyncDefinitions(Consumer<ListRepositorySyncDefinitionsRequest.Builder> listRepositorySyncDefinitionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List repository sync definitions with detail data.
This is a convenience which creates an instance of the
ListRepositorySyncDefinitionsRequest.Builder
avoiding the need to create one manually viaListRepositorySyncDefinitionsRequest.builder()
- Parameters:
listRepositorySyncDefinitionsRequest
- AConsumer
that will call methods onListRepositorySyncDefinitionsRequest.Builder
to create a request.- Returns:
- Result of the ListRepositorySyncDefinitions operation returned by the service.
- See Also:
-
listRepositorySyncDefinitionsPaginator
default ListRepositorySyncDefinitionsIterable listRepositorySyncDefinitionsPaginator(ListRepositorySyncDefinitionsRequest listRepositorySyncDefinitionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listRepositorySyncDefinitions(software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListRepositorySyncDefinitionsIterable responses = client.listRepositorySyncDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListRepositorySyncDefinitionsIterable responses = client .listRepositorySyncDefinitionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListRepositorySyncDefinitionsIterable responses = client.listRepositorySyncDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositorySyncDefinitions(software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsRequest)
operation.- Parameters:
listRepositorySyncDefinitionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listRepositorySyncDefinitionsPaginator
default ListRepositorySyncDefinitionsIterable listRepositorySyncDefinitionsPaginator(Consumer<ListRepositorySyncDefinitionsRequest.Builder> listRepositorySyncDefinitionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listRepositorySyncDefinitions(software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListRepositorySyncDefinitionsIterable responses = client.listRepositorySyncDefinitionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListRepositorySyncDefinitionsIterable responses = client .listRepositorySyncDefinitionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListRepositorySyncDefinitionsIterable responses = client.listRepositorySyncDefinitionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRepositorySyncDefinitions(software.amazon.awssdk.services.proton.model.ListRepositorySyncDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
ListRepositorySyncDefinitionsRequest.Builder
avoiding the need to create one manually viaListRepositorySyncDefinitionsRequest.builder()
- Parameters:
listRepositorySyncDefinitionsRequest
- AConsumer
that will call methods onListRepositorySyncDefinitionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceInstanceOutputs
default ListServiceInstanceOutputsResponse listServiceInstanceOutputs(ListServiceInstanceOutputsRequest listServiceInstanceOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get a list service of instance Infrastructure as Code (IaC) outputs.
- Parameters:
listServiceInstanceOutputsRequest
-- Returns:
- Result of the ListServiceInstanceOutputs operation returned by the service.
- See Also:
-
listServiceInstanceOutputs
default ListServiceInstanceOutputsResponse listServiceInstanceOutputs(Consumer<ListServiceInstanceOutputsRequest.Builder> listServiceInstanceOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get a list service of instance Infrastructure as Code (IaC) outputs.
This is a convenience which creates an instance of the
ListServiceInstanceOutputsRequest.Builder
avoiding the need to create one manually viaListServiceInstanceOutputsRequest.builder()
- Parameters:
listServiceInstanceOutputsRequest
- AConsumer
that will call methods onListServiceInstanceOutputsRequest.Builder
to create a request.- Returns:
- Result of the ListServiceInstanceOutputs operation returned by the service.
- See Also:
-
listServiceInstanceOutputsPaginator
default ListServiceInstanceOutputsIterable listServiceInstanceOutputsPaginator(ListServiceInstanceOutputsRequest listServiceInstanceOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceInstanceOutputs(software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceOutputsIterable responses = client.listServiceInstanceOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceInstanceOutputsIterable responses = client .listServiceInstanceOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceOutputsIterable responses = client.listServiceInstanceOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceInstanceOutputs(software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsRequest)
operation.- Parameters:
listServiceInstanceOutputsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceInstanceOutputsPaginator
default ListServiceInstanceOutputsIterable listServiceInstanceOutputsPaginator(Consumer<ListServiceInstanceOutputsRequest.Builder> listServiceInstanceOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceInstanceOutputs(software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceOutputsIterable responses = client.listServiceInstanceOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceInstanceOutputsIterable responses = client .listServiceInstanceOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceOutputsIterable responses = client.listServiceInstanceOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceInstanceOutputs(software.amazon.awssdk.services.proton.model.ListServiceInstanceOutputsRequest)
operation.
This is a convenience which creates an instance of the
ListServiceInstanceOutputsRequest.Builder
avoiding the need to create one manually viaListServiceInstanceOutputsRequest.builder()
- Parameters:
listServiceInstanceOutputsRequest
- AConsumer
that will call methods onListServiceInstanceOutputsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceInstanceProvisionedResources
default ListServiceInstanceProvisionedResourcesResponse listServiceInstanceProvisionedResources(ListServiceInstanceProvisionedResourcesRequest listServiceInstanceProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List provisioned resources for a service instance with details.
- Parameters:
listServiceInstanceProvisionedResourcesRequest
-- Returns:
- Result of the ListServiceInstanceProvisionedResources operation returned by the service.
- See Also:
-
listServiceInstanceProvisionedResources
default ListServiceInstanceProvisionedResourcesResponse listServiceInstanceProvisionedResources(Consumer<ListServiceInstanceProvisionedResourcesRequest.Builder> listServiceInstanceProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List provisioned resources for a service instance with details.
This is a convenience which creates an instance of the
ListServiceInstanceProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListServiceInstanceProvisionedResourcesRequest.builder()
- Parameters:
listServiceInstanceProvisionedResourcesRequest
- AConsumer
that will call methods onListServiceInstanceProvisionedResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListServiceInstanceProvisionedResources operation returned by the service.
- See Also:
-
listServiceInstanceProvisionedResourcesPaginator
default ListServiceInstanceProvisionedResourcesIterable listServiceInstanceProvisionedResourcesPaginator(ListServiceInstanceProvisionedResourcesRequest listServiceInstanceProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceInstanceProvisionedResources(software.amazon.awssdk.services.proton.model.ListServiceInstanceProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceProvisionedResourcesIterable responses = client.listServiceInstanceProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceInstanceProvisionedResourcesIterable responses = client .listServiceInstanceProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceInstanceProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceProvisionedResourcesIterable responses = client.listServiceInstanceProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceInstanceProvisionedResources(software.amazon.awssdk.services.proton.model.ListServiceInstanceProvisionedResourcesRequest)
operation.- Parameters:
listServiceInstanceProvisionedResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceInstanceProvisionedResourcesPaginator
default ListServiceInstanceProvisionedResourcesIterable listServiceInstanceProvisionedResourcesPaginator(Consumer<ListServiceInstanceProvisionedResourcesRequest.Builder> listServiceInstanceProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceInstanceProvisionedResources(software.amazon.awssdk.services.proton.model.ListServiceInstanceProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceProvisionedResourcesIterable responses = client.listServiceInstanceProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceInstanceProvisionedResourcesIterable responses = client .listServiceInstanceProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceInstanceProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceInstanceProvisionedResourcesIterable responses = client.listServiceInstanceProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceInstanceProvisionedResources(software.amazon.awssdk.services.proton.model.ListServiceInstanceProvisionedResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListServiceInstanceProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListServiceInstanceProvisionedResourcesRequest.builder()
- Parameters:
listServiceInstanceProvisionedResourcesRequest
- AConsumer
that will call methods onListServiceInstanceProvisionedResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceInstances
default ListServiceInstancesResponse listServiceInstances(ListServiceInstancesRequest listServiceInstancesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
- Parameters:
listServiceInstancesRequest
-- Returns:
- Result of the ListServiceInstances operation returned by the service.
- See Also:
-
listServiceInstances
default ListServiceInstancesResponse listServiceInstances(Consumer<ListServiceInstancesRequest.Builder> listServiceInstancesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.
This is a convenience which creates an instance of the
ListServiceInstancesRequest.Builder
avoiding the need to create one manually viaListServiceInstancesRequest.builder()
- Parameters:
listServiceInstancesRequest
- AConsumer
that will call methods onListServiceInstancesRequest.Builder
to create a request.- Returns:
- Result of the ListServiceInstances operation returned by the service.
- See Also:
-
listServiceInstancesPaginator
default ListServiceInstancesIterable listServiceInstancesPaginator(ListServiceInstancesRequest listServiceInstancesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceInstances(software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceInstancesIterable responses = client.listServiceInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceInstancesIterable responses = client .listServiceInstancesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceInstancesIterable responses = client.listServiceInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceInstances(software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest)
operation.- Parameters:
listServiceInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceInstancesPaginator
default ListServiceInstancesIterable listServiceInstancesPaginator(Consumer<ListServiceInstancesRequest.Builder> listServiceInstancesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceInstances(software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceInstancesIterable responses = client.listServiceInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceInstancesIterable responses = client .listServiceInstancesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceInstancesIterable responses = client.listServiceInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceInstances(software.amazon.awssdk.services.proton.model.ListServiceInstancesRequest)
operation.
This is a convenience which creates an instance of the
ListServiceInstancesRequest.Builder
avoiding the need to create one manually viaListServiceInstancesRequest.builder()
- Parameters:
listServiceInstancesRequest
- AConsumer
that will call methods onListServiceInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicePipelineOutputs
default ListServicePipelineOutputsResponse listServicePipelineOutputs(ListServicePipelineOutputsRequest listServicePipelineOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get a list of service pipeline Infrastructure as Code (IaC) outputs.
- Parameters:
listServicePipelineOutputsRequest
-- Returns:
- Result of the ListServicePipelineOutputs operation returned by the service.
- See Also:
-
listServicePipelineOutputs
default ListServicePipelineOutputsResponse listServicePipelineOutputs(Consumer<ListServicePipelineOutputsRequest.Builder> listServicePipelineOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Get a list of service pipeline Infrastructure as Code (IaC) outputs.
This is a convenience which creates an instance of the
ListServicePipelineOutputsRequest.Builder
avoiding the need to create one manually viaListServicePipelineOutputsRequest.builder()
- Parameters:
listServicePipelineOutputsRequest
- AConsumer
that will call methods onListServicePipelineOutputsRequest.Builder
to create a request.- Returns:
- Result of the ListServicePipelineOutputs operation returned by the service.
- See Also:
-
listServicePipelineOutputsPaginator
default ListServicePipelineOutputsIterable listServicePipelineOutputsPaginator(ListServicePipelineOutputsRequest listServicePipelineOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServicePipelineOutputs(software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineOutputsIterable responses = client.listServicePipelineOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServicePipelineOutputsIterable responses = client .listServicePipelineOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineOutputsIterable responses = client.listServicePipelineOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServicePipelineOutputs(software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsRequest)
operation.- Parameters:
listServicePipelineOutputsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicePipelineOutputsPaginator
default ListServicePipelineOutputsIterable listServicePipelineOutputsPaginator(Consumer<ListServicePipelineOutputsRequest.Builder> listServicePipelineOutputsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServicePipelineOutputs(software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineOutputsIterable responses = client.listServicePipelineOutputsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServicePipelineOutputsIterable responses = client .listServicePipelineOutputsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineOutputsIterable responses = client.listServicePipelineOutputsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServicePipelineOutputs(software.amazon.awssdk.services.proton.model.ListServicePipelineOutputsRequest)
operation.
This is a convenience which creates an instance of the
ListServicePipelineOutputsRequest.Builder
avoiding the need to create one manually viaListServicePipelineOutputsRequest.builder()
- Parameters:
listServicePipelineOutputsRequest
- AConsumer
that will call methods onListServicePipelineOutputsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicePipelineProvisionedResources
default ListServicePipelineProvisionedResourcesResponse listServicePipelineProvisionedResources(ListServicePipelineProvisionedResourcesRequest listServicePipelineProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List provisioned resources for a service and pipeline with details.
- Parameters:
listServicePipelineProvisionedResourcesRequest
-- Returns:
- Result of the ListServicePipelineProvisionedResources operation returned by the service.
- See Also:
-
listServicePipelineProvisionedResources
default ListServicePipelineProvisionedResourcesResponse listServicePipelineProvisionedResources(Consumer<ListServicePipelineProvisionedResourcesRequest.Builder> listServicePipelineProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List provisioned resources for a service and pipeline with details.
This is a convenience which creates an instance of the
ListServicePipelineProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListServicePipelineProvisionedResourcesRequest.builder()
- Parameters:
listServicePipelineProvisionedResourcesRequest
- AConsumer
that will call methods onListServicePipelineProvisionedResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListServicePipelineProvisionedResources operation returned by the service.
- See Also:
-
listServicePipelineProvisionedResourcesPaginator
default ListServicePipelineProvisionedResourcesIterable listServicePipelineProvisionedResourcesPaginator(ListServicePipelineProvisionedResourcesRequest listServicePipelineProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServicePipelineProvisionedResources(software.amazon.awssdk.services.proton.model.ListServicePipelineProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineProvisionedResourcesIterable responses = client.listServicePipelineProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServicePipelineProvisionedResourcesIterable responses = client .listServicePipelineProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServicePipelineProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineProvisionedResourcesIterable responses = client.listServicePipelineProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServicePipelineProvisionedResources(software.amazon.awssdk.services.proton.model.ListServicePipelineProvisionedResourcesRequest)
operation.- Parameters:
listServicePipelineProvisionedResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicePipelineProvisionedResourcesPaginator
default ListServicePipelineProvisionedResourcesIterable listServicePipelineProvisionedResourcesPaginator(Consumer<ListServicePipelineProvisionedResourcesRequest.Builder> listServicePipelineProvisionedResourcesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServicePipelineProvisionedResources(software.amazon.awssdk.services.proton.model.ListServicePipelineProvisionedResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineProvisionedResourcesIterable responses = client.listServicePipelineProvisionedResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServicePipelineProvisionedResourcesIterable responses = client .listServicePipelineProvisionedResourcesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServicePipelineProvisionedResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServicePipelineProvisionedResourcesIterable responses = client.listServicePipelineProvisionedResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServicePipelineProvisionedResources(software.amazon.awssdk.services.proton.model.ListServicePipelineProvisionedResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListServicePipelineProvisionedResourcesRequest.Builder
avoiding the need to create one manually viaListServicePipelineProvisionedResourcesRequest.builder()
- Parameters:
listServicePipelineProvisionedResourcesRequest
- AConsumer
that will call methods onListServicePipelineProvisionedResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceTemplateVersions
default ListServiceTemplateVersionsResponse listServiceTemplateVersions(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List major or minor versions of a service template with detail data.
- Parameters:
listServiceTemplateVersionsRequest
-- Returns:
- Result of the ListServiceTemplateVersions operation returned by the service.
- See Also:
-
listServiceTemplateVersions
default ListServiceTemplateVersionsResponse listServiceTemplateVersions(Consumer<ListServiceTemplateVersionsRequest.Builder> listServiceTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List major or minor versions of a service template with detail data.
This is a convenience which creates an instance of the
ListServiceTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListServiceTemplateVersionsRequest.builder()
- Parameters:
listServiceTemplateVersionsRequest
- AConsumer
that will call methods onListServiceTemplateVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListServiceTemplateVersions operation returned by the service.
- See Also:
-
listServiceTemplateVersionsPaginator
default ListServiceTemplateVersionsIterable listServiceTemplateVersionsPaginator(ListServiceTemplateVersionsRequest listServiceTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceTemplateVersions(software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplateVersionsIterable responses = client.listServiceTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceTemplateVersionsIterable responses = client .listServiceTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplateVersionsIterable responses = client.listServiceTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceTemplateVersions(software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsRequest)
operation.- Parameters:
listServiceTemplateVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceTemplateVersionsPaginator
default ListServiceTemplateVersionsIterable listServiceTemplateVersionsPaginator(Consumer<ListServiceTemplateVersionsRequest.Builder> listServiceTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceTemplateVersions(software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplateVersionsIterable responses = client.listServiceTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceTemplateVersionsIterable responses = client .listServiceTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplateVersionsIterable responses = client.listServiceTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceTemplateVersions(software.amazon.awssdk.services.proton.model.ListServiceTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListServiceTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListServiceTemplateVersionsRequest.builder()
- Parameters:
listServiceTemplateVersionsRequest
- AConsumer
that will call methods onListServiceTemplateVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceTemplates
default ListServiceTemplatesResponse listServiceTemplates(ListServiceTemplatesRequest listServiceTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List service templates with detail data.
- Parameters:
listServiceTemplatesRequest
-- Returns:
- Result of the ListServiceTemplates operation returned by the service.
- See Also:
-
listServiceTemplates
default ListServiceTemplatesResponse listServiceTemplates(Consumer<ListServiceTemplatesRequest.Builder> listServiceTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List service templates with detail data.
This is a convenience which creates an instance of the
ListServiceTemplatesRequest.Builder
avoiding the need to create one manually viaListServiceTemplatesRequest.builder()
- Parameters:
listServiceTemplatesRequest
- AConsumer
that will call methods onListServiceTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListServiceTemplates operation returned by the service.
- See Also:
-
listServiceTemplatesPaginator
default ListServiceTemplatesIterable listServiceTemplatesPaginator(ListServiceTemplatesRequest listServiceTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceTemplates(software.amazon.awssdk.services.proton.model.ListServiceTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplatesIterable responses = client.listServiceTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceTemplatesIterable responses = client .listServiceTemplatesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplatesIterable responses = client.listServiceTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceTemplates(software.amazon.awssdk.services.proton.model.ListServiceTemplatesRequest)
operation.- Parameters:
listServiceTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServiceTemplatesPaginator
default ListServiceTemplatesIterable listServiceTemplatesPaginator(Consumer<ListServiceTemplatesRequest.Builder> listServiceTemplatesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServiceTemplates(software.amazon.awssdk.services.proton.model.ListServiceTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplatesIterable responses = client.listServiceTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServiceTemplatesIterable responses = client .listServiceTemplatesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServiceTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServiceTemplatesIterable responses = client.listServiceTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServiceTemplates(software.amazon.awssdk.services.proton.model.ListServiceTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListServiceTemplatesRequest.Builder
avoiding the need to create one manually viaListServiceTemplatesRequest.builder()
- Parameters:
listServiceTemplatesRequest
- AConsumer
that will call methods onListServiceTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServices
default ListServicesResponse listServices(ListServicesRequest listServicesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List services with summaries of detail data.
- Parameters:
listServicesRequest
-- Returns:
- Result of the ListServices operation returned by the service.
- See Also:
-
listServices
default ListServicesResponse listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List services with summaries of detail data.
This is a convenience which creates an instance of the
ListServicesRequest.Builder
avoiding the need to create one manually viaListServicesRequest.builder()
- Parameters:
listServicesRequest
- AConsumer
that will call methods onListServicesRequest.Builder
to create a request.- Returns:
- Result of the ListServices operation returned by the service.
- See Also:
-
listServicesPaginator
default ListServicesIterable listServicesPaginator(ListServicesRequest listServicesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServices(software.amazon.awssdk.services.proton.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.proton.model.ListServicesRequest)
operation.- Parameters:
listServicesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listServicesPaginator
default ListServicesIterable listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) throws ValidationException, AccessDeniedException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listServices(software.amazon.awssdk.services.proton.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.proton.model.ListServicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.proton.model.ListServicesRequest)
operation.
This is a convenience which creates an instance of the
ListServicesRequest.Builder
avoiding the need to create one manually viaListServicesRequest.builder()
- Parameters:
listServicesRequest
- AConsumer
that will call methods onListServicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException List tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listTagsForResource(software.amazon.awssdk.services.proton.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.proton.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.proton.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException This is a variant of
listTagsForResource(software.amazon.awssdk.services.proton.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.proton.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.proton.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.proton.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.proton.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.proton.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
notifyResourceDeploymentStatusChange
default NotifyResourceDeploymentStatusChangeResponse notifyResourceDeploymentStatusChange(NotifyResourceDeploymentStatusChangeRequest notifyResourceDeploymentStatusChangeRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide.
- Parameters:
notifyResourceDeploymentStatusChangeRequest
-- Returns:
- Result of the NotifyResourceDeploymentStatusChange operation returned by the service.
- See Also:
-
notifyResourceDeploymentStatusChange
default NotifyResourceDeploymentStatusChangeResponse notifyResourceDeploymentStatusChange(Consumer<NotifyResourceDeploymentStatusChangeRequest.Builder> notifyResourceDeploymentStatusChangeRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
For more information, see Self-managed provisioning in the Proton User Guide.
This is a convenience which creates an instance of the
NotifyResourceDeploymentStatusChangeRequest.Builder
avoiding the need to create one manually viaNotifyResourceDeploymentStatusChangeRequest.builder()
- Parameters:
notifyResourceDeploymentStatusChangeRequest
- AConsumer
that will call methods onNotifyResourceDeploymentStatusChangeRequest.Builder
to create a request.- Returns:
- Result of the NotifyResourceDeploymentStatusChange operation returned by the service.
- See Also:
-
rejectEnvironmentAccountConnection
default RejectEnvironmentAccountConnectionResponse rejectEnvironmentAccountConnection(RejectEnvironmentAccountConnectionRequest rejectEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you can't accept or use the rejected environment account connection.
You can’t reject an environment account connection that's connected to an environment.
For more information, see Environment account connections in the Proton User guide.
- Parameters:
rejectEnvironmentAccountConnectionRequest
-- Returns:
- Result of the RejectEnvironmentAccountConnection operation returned by the service.
- See Also:
-
rejectEnvironmentAccountConnection
default RejectEnvironmentAccountConnectionResponse rejectEnvironmentAccountConnection(Consumer<RejectEnvironmentAccountConnectionRequest.Builder> rejectEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you can't accept or use the rejected environment account connection.
You can’t reject an environment account connection that's connected to an environment.
For more information, see Environment account connections in the Proton User guide.
This is a convenience which creates an instance of the
RejectEnvironmentAccountConnectionRequest.Builder
avoiding the need to create one manually viaRejectEnvironmentAccountConnectionRequest.builder()
- Parameters:
rejectEnvironmentAccountConnectionRequest
- AConsumer
that will call methods onRejectEnvironmentAccountConnectionRequest.Builder
to create a request.- Returns:
- Result of the RejectEnvironmentAccountConnection operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
For more information, see Proton resources and tagging in the Proton User Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAccountSettings
default UpdateAccountSettingsResponse updateAccountSettings(UpdateAccountSettingsRequest updateAccountSettingsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update Proton settings that are used for multiple services in the Amazon Web Services account.
- Parameters:
updateAccountSettingsRequest
-- Returns:
- Result of the UpdateAccountSettings operation returned by the service.
- See Also:
-
updateAccountSettings
default UpdateAccountSettingsResponse updateAccountSettings(Consumer<UpdateAccountSettingsRequest.Builder> updateAccountSettingsRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update Proton settings that are used for multiple services in the Amazon Web Services account.
This is a convenience which creates an instance of the
UpdateAccountSettingsRequest.Builder
avoiding the need to create one manually viaUpdateAccountSettingsRequest.builder()
- Parameters:
updateAccountSettingsRequest
- AConsumer
that will call methods onUpdateAccountSettingsRequest.Builder
to create a request.- Returns:
- Result of the UpdateAccountSettings operation returned by the service.
- See Also:
-
updateComponent
default UpdateComponentResponse updateComponent(UpdateComponentRequest updateComponentRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a component.
There are a few modes for updating a component. The
deploymentType
field defines the mode.You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is
IN_PROGRESS
.For more information about components, see Proton components in the Proton User Guide.
- Parameters:
updateComponentRequest
-- Returns:
- Result of the UpdateComponent operation returned by the service.
- See Also:
-
updateComponent
default UpdateComponentResponse updateComponent(Consumer<UpdateComponentRequest.Builder> updateComponentRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a component.
There are a few modes for updating a component. The
deploymentType
field defines the mode.You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is
IN_PROGRESS
.For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
UpdateComponentRequest.Builder
avoiding the need to create one manually viaUpdateComponentRequest.builder()
- Parameters:
updateComponentRequest
- AConsumer
that will call methods onUpdateComponentRequest.Builder
to create a request.- Returns:
- Result of the UpdateComponent operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update an environment.
If the environment is associated with an environment account connection, don't update or include the
protonServiceRoleArn
andprovisioningRepository
parameter to update or connect to an environment account connection.You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the
environmentAccountConnectionId
parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection.You can update either the
environmentAccountConnectionId
orprotonServiceRoleArn
parameter and value. You can’t update both.If the environment was configured for Amazon Web Services-managed provisioning, omit the
provisioningRepository
parameter.If the environment was configured for self-managed provisioning, specify the
provisioningRepository
parameter and omit theprotonServiceRoleArn
andenvironmentAccountConnectionId
parameters.For more information, see Environments and Provisioning methods in the Proton User Guide.
There are four modes for updating an environment. 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.
- Parameters:
updateEnvironmentRequest
-- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update an environment.
If the environment is associated with an environment account connection, don't update or include the
protonServiceRoleArn
andprovisioningRepository
parameter to update or connect to an environment account connection.You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the
environmentAccountConnectionId
parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection.You can update either the
environmentAccountConnectionId
orprotonServiceRoleArn
parameter and value. You can’t update both.If the environment was configured for Amazon Web Services-managed provisioning, omit the
provisioningRepository
parameter.If the environment was configured for self-managed provisioning, specify the
provisioningRepository
parameter and omit theprotonServiceRoleArn
andenvironmentAccountConnectionId
parameters.For more information, see Environments and Provisioning methods in the Proton User Guide.
There are four modes for updating an environment. 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.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentRequest.builder()
- Parameters:
updateEnvironmentRequest
- AConsumer
that will call methods onUpdateEnvironmentRequest.Builder
to create a request.- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
-
updateEnvironmentAccountConnection
default UpdateEnvironmentAccountConnectionResponse updateEnvironmentAccountConnection(UpdateEnvironmentAccountConnectionRequest updateEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton User guide.
- Parameters:
updateEnvironmentAccountConnectionRequest
-- Returns:
- Result of the UpdateEnvironmentAccountConnection operation returned by the service.
- See Also:
-
updateEnvironmentAccountConnection
default UpdateEnvironmentAccountConnectionResponse updateEnvironmentAccountConnection(Consumer<UpdateEnvironmentAccountConnectionRequest.Builder> updateEnvironmentAccountConnectionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton User guide.
This is a convenience which creates an instance of the
UpdateEnvironmentAccountConnectionRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentAccountConnectionRequest.builder()
- Parameters:
updateEnvironmentAccountConnectionRequest
- AConsumer
that will call methods onUpdateEnvironmentAccountConnectionRequest.Builder
to create a request.- Returns:
- Result of the UpdateEnvironmentAccountConnection operation returned by the service.
- See Also:
-
updateEnvironmentTemplate
default UpdateEnvironmentTemplateResponse updateEnvironmentTemplate(UpdateEnvironmentTemplateRequest updateEnvironmentTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update an environment template.
- Parameters:
updateEnvironmentTemplateRequest
-- Returns:
- Result of the UpdateEnvironmentTemplate operation returned by the service.
- See Also:
-
updateEnvironmentTemplate
default UpdateEnvironmentTemplateResponse updateEnvironmentTemplate(Consumer<UpdateEnvironmentTemplateRequest.Builder> updateEnvironmentTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update an environment template.
This is a convenience which creates an instance of the
UpdateEnvironmentTemplateRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentTemplateRequest.builder()
- Parameters:
updateEnvironmentTemplateRequest
- AConsumer
that will call methods onUpdateEnvironmentTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateEnvironmentTemplate operation returned by the service.
- See Also:
-
updateEnvironmentTemplateVersion
default UpdateEnvironmentTemplateVersionResponse updateEnvironmentTemplateVersion(UpdateEnvironmentTemplateVersionRequest updateEnvironmentTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a major or minor version of an environment template.
- Parameters:
updateEnvironmentTemplateVersionRequest
-- Returns:
- Result of the UpdateEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
updateEnvironmentTemplateVersion
default UpdateEnvironmentTemplateVersionResponse updateEnvironmentTemplateVersion(Consumer<UpdateEnvironmentTemplateVersionRequest.Builder> updateEnvironmentTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a major or minor version of an environment template.
This is a convenience which creates an instance of the
UpdateEnvironmentTemplateVersionRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentTemplateVersionRequest.builder()
- Parameters:
updateEnvironmentTemplateVersionRequest
- AConsumer
that will call methods onUpdateEnvironmentTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateEnvironmentTemplateVersion operation returned by the service.
- See Also:
-
updateService
default UpdateServiceResponse updateService(UpdateServiceRequest updateServiceRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Edit a service description or use a spec to add and delete service instances.
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the
description
parameter to modify the description.Edit the
spec
parameter to add or delete instances.You can't delete a service instance (remove it from the spec) if it has an attached component.
For more information about components, see Proton components in the Proton User Guide.
- Parameters:
updateServiceRequest
-- Returns:
- Result of the UpdateService operation returned by the service.
- See Also:
-
updateService
default UpdateServiceResponse updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) throws ServiceQuotaExceededException, ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Edit a service description or use a spec to add and delete service instances.
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the
description
parameter to modify the description.Edit the
spec
parameter to add or delete instances.You can't delete a service instance (remove it from the spec) if it has an attached component.
For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
UpdateServiceRequest.Builder
avoiding the need to create one manually viaUpdateServiceRequest.builder()
- Parameters:
updateServiceRequest
- AConsumer
that will call methods onUpdateServiceRequest.Builder
to create a request.- Returns:
- Result of the UpdateService operation returned by the service.
- See Also:
-
updateServiceInstance
default UpdateServiceInstanceResponse updateServiceInstance(UpdateServiceInstanceRequest updateServiceInstanceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a service instance.
There are a few modes for updating a service instance. The
deploymentType
field defines the mode.You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is
IN_PROGRESS
.For more information about components, see Proton components in the Proton User Guide.
- Parameters:
updateServiceInstanceRequest
-- Returns:
- Result of the UpdateServiceInstance operation returned by the service.
- See Also:
-
updateServiceInstance
default UpdateServiceInstanceResponse updateServiceInstance(Consumer<UpdateServiceInstanceRequest.Builder> updateServiceInstanceRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a service instance.
There are a few modes for updating a service instance. The
deploymentType
field defines the mode.You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is
IN_PROGRESS
.For more information about components, see Proton components in the Proton User Guide.
This is a convenience which creates an instance of the
UpdateServiceInstanceRequest.Builder
avoiding the need to create one manually viaUpdateServiceInstanceRequest.builder()
- Parameters:
updateServiceInstanceRequest
- AConsumer
that will call methods onUpdateServiceInstanceRequest.Builder
to create a request.- Returns:
- Result of the UpdateServiceInstance operation returned by the service.
- See Also:
-
updateServicePipeline
default UpdateServicePipelineResponse updateServicePipeline(UpdateServicePipelineRequest updateServicePipelineRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update the service pipeline.
There are four modes for updating a service pipeline. 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 major or minor 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 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 specify a different major version that's higher than the major version in use and a minor version.
- Parameters:
updateServicePipelineRequest
-- Returns:
- Result of the UpdateServicePipeline operation returned by the service.
- See Also:
-
-
updateServicePipeline
default UpdateServicePipelineResponse updateServicePipeline(Consumer<UpdateServicePipelineRequest.Builder> updateServicePipelineRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update the service pipeline.
There are four modes for updating a service pipeline. 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 major or minor 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 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 specify a different major version that's higher than the major version in use and a minor version.
This is a convenience which creates an instance of the
UpdateServicePipelineRequest.Builder
avoiding the need to create one manually viaUpdateServicePipelineRequest.builder()
- Parameters:
updateServicePipelineRequest
- AConsumer
that will call methods onUpdateServicePipelineRequest.Builder
to create a request.- Returns:
- Result of the UpdateServicePipeline operation returned by the service.
- See Also:
-
-
updateServiceSyncBlocker
default UpdateServiceSyncBlockerResponse updateServiceSyncBlocker(UpdateServiceSyncBlockerRequest updateServiceSyncBlockerRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update the service sync blocker by resolving it.
- Parameters:
updateServiceSyncBlockerRequest
-- Returns:
- Result of the UpdateServiceSyncBlocker operation returned by the service.
- See Also:
-
updateServiceSyncBlocker
default UpdateServiceSyncBlockerResponse updateServiceSyncBlocker(Consumer<UpdateServiceSyncBlockerRequest.Builder> updateServiceSyncBlockerRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update the service sync blocker by resolving it.
This is a convenience which creates an instance of the
UpdateServiceSyncBlockerRequest.Builder
avoiding the need to create one manually viaUpdateServiceSyncBlockerRequest.builder()
- Parameters:
updateServiceSyncBlockerRequest
- AConsumer
that will call methods onUpdateServiceSyncBlockerRequest.Builder
to create a request.- Returns:
- Result of the UpdateServiceSyncBlocker operation returned by the service.
- See Also:
-
updateServiceSyncConfig
default UpdateServiceSyncConfigResponse updateServiceSyncConfig(UpdateServiceSyncConfigRequest updateServiceSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update the Proton Ops config file.
- Parameters:
updateServiceSyncConfigRequest
-- Returns:
- Result of the UpdateServiceSyncConfig operation returned by the service.
- See Also:
-
updateServiceSyncConfig
default UpdateServiceSyncConfigResponse updateServiceSyncConfig(Consumer<UpdateServiceSyncConfigRequest.Builder> updateServiceSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update the Proton Ops config file.
This is a convenience which creates an instance of the
UpdateServiceSyncConfigRequest.Builder
avoiding the need to create one manually viaUpdateServiceSyncConfigRequest.builder()
- Parameters:
updateServiceSyncConfigRequest
- AConsumer
that will call methods onUpdateServiceSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateServiceSyncConfig operation returned by the service.
- See Also:
-
updateServiceTemplate
default UpdateServiceTemplateResponse updateServiceTemplate(UpdateServiceTemplateRequest updateServiceTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a service template.
- Parameters:
updateServiceTemplateRequest
-- Returns:
- Result of the UpdateServiceTemplate operation returned by the service.
- See Also:
-
updateServiceTemplate
default UpdateServiceTemplateResponse updateServiceTemplate(Consumer<UpdateServiceTemplateRequest.Builder> updateServiceTemplateRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a service template.
This is a convenience which creates an instance of the
UpdateServiceTemplateRequest.Builder
avoiding the need to create one manually viaUpdateServiceTemplateRequest.builder()
- Parameters:
updateServiceTemplateRequest
- AConsumer
that will call methods onUpdateServiceTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateServiceTemplate operation returned by the service.
- See Also:
-
updateServiceTemplateVersion
default UpdateServiceTemplateVersionResponse updateServiceTemplateVersion(UpdateServiceTemplateVersionRequest updateServiceTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a major or minor version of a service template.
- Parameters:
updateServiceTemplateVersionRequest
-- Returns:
- Result of the UpdateServiceTemplateVersion operation returned by the service.
- See Also:
-
updateServiceTemplateVersion
default UpdateServiceTemplateVersionResponse updateServiceTemplateVersion(Consumer<UpdateServiceTemplateVersionRequest.Builder> updateServiceTemplateVersionRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update a major or minor version of a service template.
This is a convenience which creates an instance of the
UpdateServiceTemplateVersionRequest.Builder
avoiding the need to create one manually viaUpdateServiceTemplateVersionRequest.builder()
- Parameters:
updateServiceTemplateVersionRequest
- AConsumer
that will call methods onUpdateServiceTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateServiceTemplateVersion operation returned by the service.
- See Also:
-
updateTemplateSyncConfig
default UpdateTemplateSyncConfigResponse updateTemplateSyncConfig(UpdateTemplateSyncConfigRequest updateTemplateSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update template sync configuration parameters, except for the
templateName
andtemplateType
. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.- Parameters:
updateTemplateSyncConfigRequest
-- Returns:
- Result of the UpdateTemplateSyncConfig operation returned by the service.
- See Also:
-
updateTemplateSyncConfig
default UpdateTemplateSyncConfigResponse updateTemplateSyncConfig(Consumer<UpdateTemplateSyncConfigRequest.Builder> updateTemplateSyncConfigRequest) throws ValidationException, AccessDeniedException, ThrottlingException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, ProtonException Update template sync configuration parameters, except for the
templateName
andtemplateType
. Repository details (branch, name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
This is a convenience which creates an instance of the
UpdateTemplateSyncConfigRequest.Builder
avoiding the need to create one manually viaUpdateTemplateSyncConfigRequest.builder()
- Parameters:
updateTemplateSyncConfigRequest
- AConsumer
that will call methods onUpdateTemplateSyncConfigRequest.Builder
to create a request.- Returns:
- Result of the UpdateTemplateSyncConfig operation returned by the service.
- See Also:
-
waiter
Create an instance ofProtonWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
ProtonWaiter
-
create
Create aProtonClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aProtonClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-