Struct aws_sdk_proton::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }Expand description
Client for AWS Proton
Client for invoking operations on AWS Proton. Each operation on AWS Proton is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_proton::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_proton::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_proton::Client::from_conf(config);Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub fn accept_environment_account_connection(
&self
) -> AcceptEnvironmentAccountConnection<C, M, R>
pub fn accept_environment_account_connection(
&self
) -> AcceptEnvironmentAccountConnection<C, M, R>
Constructs a fluent builder for the AcceptEnvironmentAccountConnection operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):The ID of the environment account connection.
- On success, responds with
AcceptEnvironmentAccountConnectionOutputwith field(s):environment_account_connection(Option<EnvironmentAccountConnection>):The environment account connection data that’s returned by Proton.
- On failure, responds with
SdkError<AcceptEnvironmentAccountConnectionError>
Constructs a fluent builder for the CancelEnvironmentDeployment operation.
- The fluent builder is configurable:
environment_name(impl Into<String>)/set_environment_name(Option<String>):The name of the environment with the deployment to cancel.
- On success, responds with
CancelEnvironmentDeploymentOutputwith field(s):environment(Option<Environment>):The environment summary data that’s returned by Proton.
- On failure, responds with
SdkError<CancelEnvironmentDeploymentError>
Constructs a fluent builder for the CancelServiceInstanceDeployment operation.
- The fluent builder is configurable:
service_instance_name(impl Into<String>)/set_service_instance_name(Option<String>):The name of the service instance with the deployment to cancel.
service_name(impl Into<String>)/set_service_name(Option<String>):The name of the service with the service instance deployment to cancel.
- On success, responds with
CancelServiceInstanceDeploymentOutputwith field(s):service_instance(Option<ServiceInstance>):The service instance summary data that’s returned by Proton.
- On failure, responds with
SdkError<CancelServiceInstanceDeploymentError>
Constructs a fluent builder for the CancelServicePipelineDeployment operation.
- The fluent builder is configurable:
service_name(impl Into<String>)/set_service_name(Option<String>):The name of the service with the service pipeline deployment to cancel.
- On success, responds with
CancelServicePipelineDeploymentOutputwith field(s):pipeline(Option<ServicePipeline>):The service pipeline detail data that’s returned by Proton.
- On failure, responds with
SdkError<CancelServicePipelineDeploymentError>
Constructs a fluent builder for the CreateEnvironment operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment.
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
template_major_version(impl Into<String>)/set_template_major_version(Option<String>):The major version of the environment template.
template_minor_version(impl Into<String>)/set_template_minor_version(Option<String>):The minor version of the environment template.
description(impl Into<String>)/set_description(Option<String>):A description of the environment that’s being created and deployed.
spec(impl Into<String>)/set_spec(Option<String>):A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.
proton_service_role_arn(impl Into<String>)/set_proton_service_role_arn(Option<String>):The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. You must include either the
environmentAccountConnectionIdorprotonServiceRoleArnparameter and value and omit theprovisioningRepositoryparameter when you use standard provisioning.environment_account_connection_id(impl Into<String>)/set_environment_account_connection_id(Option<String>):The ID of the environment account connection that you provide if you’re provisioning your environment infrastructure resources to an environment account. You must include either the
environmentAccountConnectionIdorprotonServiceRoleArnparameter and value and omit theprovisioningRepositoryparameter and values. For more information, see Environment account connections in the Proton Administrator guide.tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
provisioning_repository(RepositoryBranchInput)/set_provisioning_repository(Option<RepositoryBranchInput>):The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the
environmentAccountConnectionIdandprotonServiceRoleArnparameters.Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
- On success, responds with
CreateEnvironmentOutputwith field(s):environment(Option<Environment>):The environment detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateEnvironmentError>
pub fn create_environment_account_connection(
&self
) -> CreateEnvironmentAccountConnection<C, M, R>
pub fn create_environment_account_connection(
&self
) -> CreateEnvironmentAccountConnection<C, M, R>
Constructs a fluent builder for the CreateEnvironmentAccountConnection operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):When included, if two identical requests are made with the same client token, Proton returns the environment account connection that the first request created.
management_account_id(impl Into<String>)/set_management_account_id(Option<String>):The ID of the management account that accepts or rejects the environment account connection. You create an manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
role_arn(impl Into<String>)/set_role_arn(Option<String>):The Amazon Resource Name (ARN) of the IAM service role that’s created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.
environment_name(impl Into<String>)/set_environment_name(Option<String>):The name of the Proton environment that’s created in the associated management account.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide.
- On success, responds with
CreateEnvironmentAccountConnectionOutputwith field(s):environment_account_connection(Option<EnvironmentAccountConnection>):The environment account connection detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateEnvironmentAccountConnectionError>
Constructs a fluent builder for the CreateEnvironmentTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment template.
display_name(impl Into<String>)/set_display_name(Option<String>):The environment template name as displayed in the developer interface.
description(impl Into<String>)/set_description(Option<String>):A description of the environment template.
encryption_key(impl Into<String>)/set_encryption_key(Option<String>):A customer provided encryption key that Proton uses to encrypt data.
provisioning(Provisioning)/set_provisioning(Option<Provisioning>):When included, indicates that the environment template is for customer provisioned and managed infrastructure.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Create tags for your environment template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
- On success, responds with
CreateEnvironmentTemplateOutputwith field(s):environment_template(Option<EnvironmentTemplate>):The environment template detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateEnvironmentTemplateError>
pub fn create_environment_template_version(
&self
) -> CreateEnvironmentTemplateVersion<C, M, R>
pub fn create_environment_template_version(
&self
) -> CreateEnvironmentTemplateVersion<C, M, R>
Constructs a fluent builder for the CreateEnvironmentTemplateVersion operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):When included, if two identical requests are made with the same client token, Proton returns the environment template version that the first request created.
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the environment template.
description(impl Into<String>)/set_description(Option<String>):A description of the new version of an environment template.
major_version(impl Into<String>)/set_major_version(Option<String>):To create a new minor version of the environment template, include a
major Version.To create a new major and minor version of the environment template, exclude
major Version.source(TemplateVersionSourceInput)/set_source(Option<TemplateVersionSourceInput>):An object that includes the template bundle S3 bucket path and name for the new version of an template.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Create tags for a new version of an environment template.
- On success, responds with
CreateEnvironmentTemplateVersionOutputwith field(s):environment_template_version(Option<EnvironmentTemplateVersion>):The environment template detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateEnvironmentTemplateVersionError>
Constructs a fluent builder for the CreateRepository operation.
- The fluent builder is configurable:
provider(RepositoryProvider)/set_provider(Option<RepositoryProvider>):The repository provider.
name(impl Into<String>)/set_name(Option<String>):The repository name, for example
myrepos/myrepo.connection_arn(impl Into<String>)/set_connection_arn(Option<String>):The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.
encryption_key(impl Into<String>)/set_encryption_key(Option<String>):The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
- On success, responds with
CreateRepositoryOutputwith field(s):repository(Option<Repository>):The repository detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateRepositoryError>
Constructs a fluent builder for the CreateService operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The service name.
description(impl Into<String>)/set_description(Option<String>):A description of the Proton service.
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the service template that’s used to create the service.
template_major_version(impl Into<String>)/set_template_major_version(Option<String>):The major version of the service template that was used to create the service.
template_minor_version(impl Into<String>)/set_template_minor_version(Option<String>):The minor version of the service template that was used to create the service.
spec(impl Into<String>)/set_spec(Option<String>):A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton Administrator Guide and Create a service in the Proton User Guide.
repository_connection_arn(impl Into<String>)/set_repository_connection_arn(Option<String>):The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide. Don’t include this parameter if your service template doesn’t include a service pipeline.
repository_id(impl Into<String>)/set_repository_id(Option<String>):The ID of the code repository. Don’t include this parameter if your service template doesn’t include a service pipeline.
branch_name(impl Into<String>)/set_branch_name(Option<String>):The name of the code repository branch that holds the code that’s deployed in Proton. Don’t include this parameter if your service template doesn’t include a service pipeline.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Create tags for your service. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
- On success, responds with
CreateServiceOutputwith field(s):service(Option<Service>):The service detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateServiceError>
Constructs a fluent builder for the CreateServiceTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service template.
display_name(impl Into<String>)/set_display_name(Option<String>):The name of the service template as displayed in the developer interface.
description(impl Into<String>)/set_description(Option<String>):A description of the service template.
encryption_key(impl Into<String>)/set_encryption_key(Option<String>):A customer provided encryption key that’s used to encrypt data.
pipeline_provisioning(Provisioning)/set_pipeline_provisioning(Option<Provisioning>):Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline won’t be included for your service. Once specified, this parameter can’t be changed. For more information, see Service template bundles in the Proton Administrator Guide.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Create tags for your service template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
- On success, responds with
CreateServiceTemplateOutputwith field(s):service_template(Option<ServiceTemplate>):The service template detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateServiceTemplateError>
Constructs a fluent builder for the CreateServiceTemplateVersion operation.
- The fluent builder is configurable:
client_token(impl Into<String>)/set_client_token(Option<String>):When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created.
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the service template.
description(impl Into<String>)/set_description(Option<String>):A description of the new version of a service template.
major_version(impl Into<String>)/set_major_version(Option<String>):To create a new minor version of the service template, include a
major Version.To create a new major and minor version of the service template, exclude
major Version.source(TemplateVersionSourceInput)/set_source(Option<TemplateVersionSourceInput>):An object that includes the template bundle S3 bucket path and name for the new version of a service template.
compatible_environment_templates(Vec<CompatibleEnvironmentTemplateInput>)/set_compatible_environment_templates(Option<Vec<CompatibleEnvironmentTemplateInput>>):An array of compatible environment template objects for the new version of a service template.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):Create tags for a new version of a service template.
- On success, responds with
CreateServiceTemplateVersionOutputwith field(s):service_template_version(Option<ServiceTemplateVersion>):The service template version summary of detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateServiceTemplateVersionError>
Constructs a fluent builder for the CreateTemplateSyncConfig operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of your registered template.
template_type(TemplateType)/set_template_type(Option<TemplateType>):The type of the registered template.
repository_provider(RepositoryProvider)/set_repository_provider(Option<RepositoryProvider>):The provider type for your repository.
repository_name(impl Into<String>)/set_repository_name(Option<String>):The name of your repository, for example
myrepos/myrepo.branch(impl Into<String>)/set_branch(Option<String>):The branch of the registered repository for your template.
subdirectory(impl Into<String>)/set_subdirectory(Option<String>):A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.
- On success, responds with
CreateTemplateSyncConfigOutputwith field(s):template_sync_config(Option<TemplateSyncConfig>):The template sync configuration detail data that’s returned by Proton.
- On failure, responds with
SdkError<CreateTemplateSyncConfigError>
Constructs a fluent builder for the DeleteEnvironment operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment to delete.
- On success, responds with
DeleteEnvironmentOutputwith field(s):environment(Option<Environment>):The environment detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteEnvironmentError>
pub fn delete_environment_account_connection(
&self
) -> DeleteEnvironmentAccountConnection<C, M, R>
pub fn delete_environment_account_connection(
&self
) -> DeleteEnvironmentAccountConnection<C, M, R>
Constructs a fluent builder for the DeleteEnvironmentAccountConnection operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):The ID of the environment account connection to delete.
- On success, responds with
DeleteEnvironmentAccountConnectionOutputwith field(s):environment_account_connection(Option<EnvironmentAccountConnection>):The environment account connection detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteEnvironmentAccountConnectionError>
Constructs a fluent builder for the DeleteEnvironmentTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment template to delete.
- On success, responds with
DeleteEnvironmentTemplateOutputwith field(s):environment_template(Option<EnvironmentTemplate>):The environment template detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteEnvironmentTemplateError>
pub fn delete_environment_template_version(
&self
) -> DeleteEnvironmentTemplateVersion<C, M, R>
pub fn delete_environment_template_version(
&self
) -> DeleteEnvironmentTemplateVersion<C, M, R>
Constructs a fluent builder for the DeleteEnvironmentTemplateVersion operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the environment template.
major_version(impl Into<String>)/set_major_version(Option<String>):The environment template major version to delete.
minor_version(impl Into<String>)/set_minor_version(Option<String>):The environment template minor version to delete.
- On success, responds with
DeleteEnvironmentTemplateVersionOutputwith field(s):environment_template_version(Option<EnvironmentTemplateVersion>):The environment template version detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteEnvironmentTemplateVersionError>
Constructs a fluent builder for the DeleteRepository operation.
- The fluent builder is configurable:
provider(RepositoryProvider)/set_provider(Option<RepositoryProvider>):The repository provider.
name(impl Into<String>)/set_name(Option<String>):The name of the repository.
- On success, responds with
DeleteRepositoryOutputwith field(s):repository(Option<Repository>):The repository detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteRepositoryError>
Constructs a fluent builder for the DeleteService operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service to delete.
- On success, responds with
DeleteServiceOutputwith field(s):service(Option<Service>):The service detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteServiceError>
Constructs a fluent builder for the DeleteServiceTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service template to delete.
- On success, responds with
DeleteServiceTemplateOutputwith field(s):service_template(Option<ServiceTemplate>):The service template detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteServiceTemplateError>
Constructs a fluent builder for the DeleteServiceTemplateVersion operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the service template.
major_version(impl Into<String>)/set_major_version(Option<String>):The service template major version to delete.
minor_version(impl Into<String>)/set_minor_version(Option<String>):The service template minor version to delete.
- On success, responds with
DeleteServiceTemplateVersionOutputwith field(s):service_template_version(Option<ServiceTemplateVersion>):The service template version detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteServiceTemplateVersionError>
Constructs a fluent builder for the DeleteTemplateSyncConfig operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The template name.
template_type(TemplateType)/set_template_type(Option<TemplateType>):The template type.
- On success, responds with
DeleteTemplateSyncConfigOutputwith field(s):template_sync_config(Option<TemplateSyncConfig>):The template sync configuration detail data that’s returned by Proton.
- On failure, responds with
SdkError<DeleteTemplateSyncConfigError>
Constructs a fluent builder for the GetAccountSettings operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetAccountSettingsOutputwith field(s):account_settings(Option<AccountSettings>):The Proton pipeline service role detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetAccountSettingsError>
Constructs a fluent builder for the GetEnvironment operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment that you want to get the detail data for.
- On success, responds with
GetEnvironmentOutputwith field(s):environment(Option<Environment>):The environment detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetEnvironmentError>
Constructs a fluent builder for the GetEnvironmentAccountConnection operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):The ID of the environment account connection.
- On success, responds with
GetEnvironmentAccountConnectionOutputwith field(s):environment_account_connection(Option<EnvironmentAccountConnection>):The environment account connection detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetEnvironmentAccountConnectionError>
Constructs a fluent builder for the GetEnvironmentTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment template that you want to get the detail data for.
- On success, responds with
GetEnvironmentTemplateOutputwith field(s):environment_template(Option<EnvironmentTemplate>):The environment template detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetEnvironmentTemplateError>
Constructs a fluent builder for the GetEnvironmentTemplateVersion operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the environment template.
major_version(impl Into<String>)/set_major_version(Option<String>):To view environment template major version detail data, include
major Version.minor_version(impl Into<String>)/set_minor_version(Option<String>):To view environment template minor version detail data, include
minorVersion.
- On success, responds with
GetEnvironmentTemplateVersionOutputwith field(s):environment_template_version(Option<EnvironmentTemplateVersion>):The environment template version detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetEnvironmentTemplateVersionError>
Constructs a fluent builder for the GetRepository operation.
- The fluent builder is configurable:
provider(RepositoryProvider)/set_provider(Option<RepositoryProvider>):The repository provider.
name(impl Into<String>)/set_name(Option<String>):The repository name, for example
myrepos/myrepo.
- On success, responds with
GetRepositoryOutputwith field(s):repository(Option<Repository>):The repository detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetRepositoryError>
Constructs a fluent builder for the GetRepositorySyncStatus operation.
- The fluent builder is configurable:
repository_name(impl Into<String>)/set_repository_name(Option<String>):The repository name.
repository_provider(RepositoryProvider)/set_repository_provider(Option<RepositoryProvider>):The repository provider.
branch(impl Into<String>)/set_branch(Option<String>):The repository branch.
sync_type(SyncType)/set_sync_type(Option<SyncType>):The repository sync type.
- On success, responds with
GetRepositorySyncStatusOutputwith field(s):latest_sync(Option<RepositorySyncAttempt>):The repository sync status detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetRepositorySyncStatusError>
Constructs a fluent builder for the GetService operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service that you want to get the detail data for.
- On success, responds with
GetServiceOutputwith field(s):service(Option<Service>):The service detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetServiceError>
Constructs a fluent builder for the GetServiceInstance operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of a service instance that you want to get the detail data for.
service_name(impl Into<String>)/set_service_name(Option<String>):The name of the service that the service instance belongs to.
- On success, responds with
GetServiceInstanceOutputwith field(s):service_instance(Option<ServiceInstance>):The service instance detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetServiceInstanceError>
Constructs a fluent builder for the GetServiceTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service template that you want to get detail data for.
- On success, responds with
GetServiceTemplateOutputwith field(s):service_template(Option<ServiceTemplate>):The service template detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetServiceTemplateError>
Constructs a fluent builder for the GetServiceTemplateVersion operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the service template.
major_version(impl Into<String>)/set_major_version(Option<String>):To view service template major version detail data, include
major Version.minor_version(impl Into<String>)/set_minor_version(Option<String>):To view service template minor version detail data, include
minorVersion.
- On success, responds with
GetServiceTemplateVersionOutputwith field(s):service_template_version(Option<ServiceTemplateVersion>):The service template version detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetServiceTemplateVersionError>
Constructs a fluent builder for the GetTemplateSyncConfig operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The template name.
template_type(TemplateType)/set_template_type(Option<TemplateType>):The template type.
- On success, responds with
GetTemplateSyncConfigOutputwith field(s):template_sync_config(Option<TemplateSyncConfig>):The template sync configuration detail data that’s returned by Proton.
- On failure, responds with
SdkError<GetTemplateSyncConfigError>
Constructs a fluent builder for the GetTemplateSyncStatus operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The template name.
template_type(TemplateType)/set_template_type(Option<TemplateType>):The template type.
template_version(impl Into<String>)/set_template_version(Option<String>):The template version.
- On success, responds with
GetTemplateSyncStatusOutputwith field(s):latest_sync(Option<ResourceSyncAttempt>):The details of the last sync that’s returned by Proton.
latest_successful_sync(Option<ResourceSyncAttempt>):The details of the last successful sync that’s returned by Proton.
desired_state(Option<Revision>):The template sync desired state that’s returned by Proton.
- On failure, responds with
SdkError<GetTemplateSyncStatusError>
pub fn list_environment_account_connections(
&self
) -> ListEnvironmentAccountConnections<C, M, R>
pub fn list_environment_account_connections(
&self
) -> ListEnvironmentAccountConnections<C, M, R>
Constructs a fluent builder for the ListEnvironmentAccountConnections operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
requested_by(EnvironmentAccountConnectionRequesterAccountType)/set_requested_by(Option<EnvironmentAccountConnectionRequesterAccountType>):The type of account making the
ListEnvironmentAccountConnectionsrequest.environment_name(impl Into<String>)/set_environment_name(Option<String>):The environment name that’s associated with each listed environment account connection.
statuses(Vec<EnvironmentAccountConnectionStatus>)/set_statuses(Option<Vec<EnvironmentAccountConnectionStatus>>):The status details for each listed environment account connection.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of environment account connections to list.
- On success, responds with
ListEnvironmentAccountConnectionsOutputwith field(s):environment_account_connections(Option<Vec<EnvironmentAccountConnectionSummary>>):An array of environment account connections with details that’s returned by Proton.
next_token(Option<String>):A token to indicate the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.
- On failure, responds with
SdkError<ListEnvironmentAccountConnectionsError>
Constructs a fluent builder for the ListEnvironmentOutputs operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
environment_name(impl Into<String>)/set_environment_name(Option<String>):The environment name.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.
- On success, responds with
ListEnvironmentOutputsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.
outputs(Option<Vec<Output>>):An array of environment outputs with detail data.
- On failure, responds with
SdkError<ListEnvironmentOutputsError>
pub fn list_environment_provisioned_resources(
&self
) -> ListEnvironmentProvisionedResources<C, M, R>
pub fn list_environment_provisioned_resources(
&self
) -> ListEnvironmentProvisionedResources<C, M, R>
Constructs a fluent builder for the ListEnvironmentProvisionedResources operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
environment_name(impl Into<String>)/set_environment_name(Option<String>):The environment name.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.
- On success, responds with
ListEnvironmentProvisionedResourcesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.
provisioned_resources(Option<Vec<ProvisionedResource>>):An array of environment provisioned resources.
- On failure, responds with
SdkError<ListEnvironmentProvisionedResourcesError>
Constructs a fluent builder for the ListEnvironments operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of environments to list.
environment_templates(Vec<EnvironmentTemplateFilter>)/set_environment_templates(Option<Vec<EnvironmentTemplateFilter>>):An array of the versions of the environment template.
- On success, responds with
ListEnvironmentsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next environment in the array of environments, after the current requested list of environments.
environments(Option<Vec<EnvironmentSummary>>):An array of environment detail data summaries.
- On failure, responds with
SdkError<ListEnvironmentsError>
Constructs a fluent builder for the ListEnvironmentTemplates operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of environment templates to list.
- On success, responds with
ListEnvironmentTemplatesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next environment template in the array of environment templates, after the current requested list of environment templates.
templates(Option<Vec<EnvironmentTemplateSummary>>):An array of environment templates with detail data.
- On failure, responds with
SdkError<ListEnvironmentTemplatesError>
Constructs a fluent builder for the ListEnvironmentTemplateVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of major or minor versions of an environment template to list.
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the environment template.
major_version(impl Into<String>)/set_major_version(Option<String>):To view a list of minor of versions under a major version of an environment template, include
major Version.To view a list of major versions of an environment template, exclude
major Version.
- On success, responds with
ListEnvironmentTemplateVersionsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
template_versions(Option<Vec<EnvironmentTemplateVersionSummary>>):An array of major or minor versions of an environment template detail data.
- On failure, responds with
SdkError<ListEnvironmentTemplateVersionsError>
Constructs a fluent builder for the ListRepositories operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of repositories to list.
- On success, responds with
ListRepositoriesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next repository in the array of repositories, after the current requested list of repositories.
repositories(Option<Vec<RepositorySummary>>):An array of repositories.
- On failure, responds with
SdkError<ListRepositoriesError>
Constructs a fluent builder for the ListRepositorySyncDefinitions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
repository_name(impl Into<String>)/set_repository_name(Option<String>):The repository name.
repository_provider(RepositoryProvider)/set_repository_provider(Option<RepositoryProvider>):The repository provider.
sync_type(SyncType)/set_sync_type(Option<SyncType>):The sync type. The only supported value is
TEMPLATE_SYNC.next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.
- On success, responds with
ListRepositorySyncDefinitionsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.
sync_definitions(Option<Vec<RepositorySyncDefinition>>):An array of repository sync definitions.
- On failure, responds with
SdkError<ListRepositorySyncDefinitionsError>
Constructs a fluent builder for the ListServiceInstanceOutputs operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_instance_name(impl Into<String>)/set_service_instance_name(Option<String>):The service instance name.
service_name(impl Into<String>)/set_service_name(Option<String>):The service name.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
- On success, responds with
ListServiceInstanceOutputsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
outputs(Option<Vec<Output>>):An array of service instance infrastructure as code outputs.
- On failure, responds with
SdkError<ListServiceInstanceOutputsError>
pub fn list_service_instance_provisioned_resources(
&self
) -> ListServiceInstanceProvisionedResources<C, M, R>
pub fn list_service_instance_provisioned_resources(
&self
) -> ListServiceInstanceProvisionedResources<C, M, R>
Constructs a fluent builder for the ListServiceInstanceProvisionedResources operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_name(impl Into<String>)/set_service_name(Option<String>):The service name.
service_instance_name(impl Into<String>)/set_service_instance_name(Option<String>):The service instance name.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
- On success, responds with
ListServiceInstanceProvisionedResourcesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
provisioned_resources(Option<Vec<ProvisionedResource>>):An array of provisioned resources for a service instance.
- On failure, responds with
SdkError<ListServiceInstanceProvisionedResourcesError>
Constructs a fluent builder for the ListServiceInstances operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_name(impl Into<String>)/set_service_name(Option<String>):The name of the service that the service instance belongs to.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of service instances to list.
- On success, responds with
ListServiceInstancesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next service instance in the array of service instances, after the current requested list of service instances.
service_instances(Option<Vec<ServiceInstanceSummary>>):An array of service instances with summaries of detail data.
- On failure, responds with
SdkError<ListServiceInstancesError>
Constructs a fluent builder for the ListServicePipelineOutputs operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_name(impl Into<String>)/set_service_name(Option<String>):The service name.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
- On success, responds with
ListServicePipelineOutputsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
outputs(Option<Vec<Output>>):An array of outputs.
- On failure, responds with
SdkError<ListServicePipelineOutputsError>
pub fn list_service_pipeline_provisioned_resources(
&self
) -> ListServicePipelineProvisionedResources<C, M, R>
pub fn list_service_pipeline_provisioned_resources(
&self
) -> ListServicePipelineProvisionedResources<C, M, R>
Constructs a fluent builder for the ListServicePipelineProvisionedResources operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_name(impl Into<String>)/set_service_name(Option<String>):The service name.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
- On success, responds with
ListServicePipelineProvisionedResourcesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
provisioned_resources(Option<Vec<ProvisionedResource>>):An array of provisioned resources for a service and pipeline.
- On failure, responds with
SdkError<ListServicePipelineProvisionedResourcesError>
Constructs a fluent builder for the ListServices operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of services to list.
- On success, responds with
ListServicesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next service in the array of services, after the current requested list of services.
services(Option<Vec<ServiceSummary>>):An array of services with summaries of detail data.
- On failure, responds with
SdkError<ListServicesError>
Constructs a fluent builder for the ListServiceTemplates operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of service templates to list.
- On success, responds with
ListServiceTemplatesOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next service template in the array of service templates, after the current requested list of service templates.
templates(Option<Vec<ServiceTemplateSummary>>):An array of service templates with detail data.
- On failure, responds with
SdkError<ListServiceTemplatesError>
Constructs a fluent builder for the ListServiceTemplateVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of major or minor versions of a service template to list.
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the service template.
major_version(impl Into<String>)/set_major_version(Option<String>):To view a list of minor of versions under a major version of a service template, include
major Version.To view a list of major versions of a service template, exclude
major Version.
- On success, responds with
ListServiceTemplateVersionsOutputwith field(s):next_token(Option<String>):A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.
template_versions(Option<Vec<ServiceTemplateVersionSummary>>):An array of major or minor versions of a service template with detail data.
- On failure, responds with
SdkError<ListServiceTemplateVersionsError>
Constructs a fluent builder for the ListTagsForResource operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource for the listed tags.
next_token(impl Into<String>)/set_next_token(Option<String>):A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.
max_results(i32)/set_max_results(Option<i32>):The maximum number of tags to list.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<Vec<Tag>>):An array of resource tags with detail data.
next_token(Option<String>):A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
pub fn notify_resource_deployment_status_change(
&self
) -> NotifyResourceDeploymentStatusChange<C, M, R>
pub fn notify_resource_deployment_status_change(
&self
) -> NotifyResourceDeploymentStatusChange<C, M, R>
Constructs a fluent builder for the NotifyResourceDeploymentStatusChange operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The provisioned resource Amazon Resource Name (ARN).
status(ResourceDeploymentStatus)/set_status(Option<ResourceDeploymentStatus>):The status of your provisioned resource.
outputs(Vec<Output>)/set_outputs(Option<Vec<Output>>):The provisioned resource state change detail data that’s returned by Proton.
deployment_id(impl Into<String>)/set_deployment_id(Option<String>):The deployment ID for your provisioned resource.
status_message(impl Into<String>)/set_status_message(Option<String>):The deployment status message for your provisioned resource.
- On success, responds with
NotifyResourceDeploymentStatusChangeOutput - On failure, responds with
SdkError<NotifyResourceDeploymentStatusChangeError>
pub fn reject_environment_account_connection(
&self
) -> RejectEnvironmentAccountConnection<C, M, R>
pub fn reject_environment_account_connection(
&self
) -> RejectEnvironmentAccountConnection<C, M, R>
Constructs a fluent builder for the RejectEnvironmentAccountConnection operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):The ID of the environment account connection to reject.
- On success, responds with
RejectEnvironmentAccountConnectionOutputwith field(s):environment_account_connection(Option<EnvironmentAccountConnection>):The environment connection account detail data that’s returned by Proton.
- On failure, responds with
SdkError<RejectEnvironmentAccountConnectionError>
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.
tags(Vec<Tag>)/set_tags(Option<Vec<Tag>>):An array of resource tags to apply to a resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.
tag_keys(Vec<String>)/set_tag_keys(Option<Vec<String>>):An array of tag keys indicating the resource tags to be removed from the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateAccountSettings operation.
- The fluent builder is configurable:
pipeline_service_role_arn(impl Into<String>)/set_pipeline_service_role_arn(Option<String>):The Amazon Resource Name (ARN) of the Proton pipeline service role.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
pipeline_provisioning_repository(RepositoryBranchInput)/set_pipeline_provisioning_repository(Option<RepositoryBranchInput>):The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
- On success, responds with
UpdateAccountSettingsOutputwith field(s):account_settings(Option<AccountSettings>):The Proton pipeline service role repository detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateAccountSettingsError>
Constructs a fluent builder for the UpdateEnvironment operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment to update.
description(impl Into<String>)/set_description(Option<String>):A description of the environment update.
spec(impl Into<String>)/set_spec(Option<String>):The formatted specification that defines the update.
template_major_version(impl Into<String>)/set_template_major_version(Option<String>):The major version of the environment to update.
template_minor_version(impl Into<String>)/set_template_minor_version(Option<String>):The minor version of the environment to update.
proton_service_role_arn(impl Into<String>)/set_proton_service_role_arn(Option<String>):The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
deployment_type(DeploymentUpdateType)/set_deployment_type(Option<DeploymentUpdateType>):There are four modes for updating an environment as described in the following. The
deploymentTypefield defines the mode.-
NONEIn this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated.
-
CURRENT_VERSIONIn 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_VERSIONIn 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_VERSIONIn 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 is higher than the major version in use and a minor version (optional).
-
environment_account_connection_id(impl Into<String>)/set_environment_account_connection_id(Option<String>):The ID of the environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
provisioning_repository(RepositoryBranchInput)/set_provisioning_repository(Option<RepositoryBranchInput>):The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
- On success, responds with
UpdateEnvironmentOutputwith field(s):environment(Option<Environment>):The environment detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateEnvironmentError>
pub fn update_environment_account_connection(
&self
) -> UpdateEnvironmentAccountConnection<C, M, R>
pub fn update_environment_account_connection(
&self
) -> UpdateEnvironmentAccountConnection<C, M, R>
Constructs a fluent builder for the UpdateEnvironmentAccountConnection operation.
- The fluent builder is configurable:
id(impl Into<String>)/set_id(Option<String>):The ID of the environment account connection to update.
role_arn(impl Into<String>)/set_role_arn(Option<String>):The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.
- On success, responds with
UpdateEnvironmentAccountConnectionOutputwith field(s):environment_account_connection(Option<EnvironmentAccountConnection>):The environment account connection detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateEnvironmentAccountConnectionError>
Constructs a fluent builder for the UpdateEnvironmentTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the environment template to update.
display_name(impl Into<String>)/set_display_name(Option<String>):The name of the environment template to update as displayed in the developer interface.
description(impl Into<String>)/set_description(Option<String>):A description of the environment template update.
- On success, responds with
UpdateEnvironmentTemplateOutputwith field(s):environment_template(Option<EnvironmentTemplate>):The environment template detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateEnvironmentTemplateError>
pub fn update_environment_template_version(
&self
) -> UpdateEnvironmentTemplateVersion<C, M, R>
pub fn update_environment_template_version(
&self
) -> UpdateEnvironmentTemplateVersion<C, M, R>
Constructs a fluent builder for the UpdateEnvironmentTemplateVersion operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the environment template.
major_version(impl Into<String>)/set_major_version(Option<String>):To update a major version of an environment template, include
major Version.minor_version(impl Into<String>)/set_minor_version(Option<String>):To update a minor version of an environment template, include
minorVersion.description(impl Into<String>)/set_description(Option<String>):A description of environment template version to update.
status(TemplateVersionStatus)/set_status(Option<TemplateVersionStatus>):The status of the environment template minor version to update.
- On success, responds with
UpdateEnvironmentTemplateVersionOutputwith field(s):environment_template_version(Option<EnvironmentTemplateVersion>):The environment template version detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateEnvironmentTemplateVersionError>
Constructs a fluent builder for the UpdateService operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service to edit.
description(impl Into<String>)/set_description(Option<String>):The edited service description.
spec(impl Into<String>)/set_spec(Option<String>):Lists the service instances to add and the existing service instances to remain. Omit the existing service instances to delete from the list. Don’t include edits to the existing service instances or pipeline. For more information, see Edit a service in the Proton Administrator Guide or the Proton User Guide.
- On success, responds with
UpdateServiceOutputwith field(s):service(Option<Service>):The service detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateServiceError>
Constructs a fluent builder for the UpdateServiceInstance operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service instance to update.
service_name(impl Into<String>)/set_service_name(Option<String>):The name of the service that the service instance belongs to.
deployment_type(DeploymentUpdateType)/set_deployment_type(Option<DeploymentUpdateType>):The deployment type.
There are four modes for updating a service instance as described in the following. The
deploymentTypefield defines the mode.-
NONEIn this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated.
-
CURRENT_VERSIONIn this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this
deployment-type. -
MINOR_VERSIONIn this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
-
MAJOR_VERSIONIn this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
-
spec(impl Into<String>)/set_spec(Option<String>):The formatted specification that defines the service instance update.
template_major_version(impl Into<String>)/set_template_major_version(Option<String>):The major version of the service template to update.
template_minor_version(impl Into<String>)/set_template_minor_version(Option<String>):The minor version of the service template to update.
- On success, responds with
UpdateServiceInstanceOutputwith field(s):service_instance(Option<ServiceInstance>):The service instance summary data returned by Proton.
- On failure, responds with
SdkError<UpdateServiceInstanceError>
Constructs a fluent builder for the UpdateServicePipeline operation.
- The fluent builder is configurable:
service_name(impl Into<String>)/set_service_name(Option<String>):The name of the service to that the pipeline is associated with.
spec(impl Into<String>)/set_spec(Option<String>):The spec for the service pipeline to update.
deployment_type(DeploymentUpdateType)/set_deployment_type(Option<DeploymentUpdateType>):The deployment type.
There are four modes for updating a service pipeline as described in the following. The
deploymentTypefield defines the mode.-
NONEIn this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated.
-
CURRENT_VERSIONIn this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this
deployment-type. -
MINOR_VERSIONIn this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
-
MAJOR_VERSIONIn this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
-
template_major_version(impl Into<String>)/set_template_major_version(Option<String>):The major version of the service template that was used to create the service that the pipeline is associated with.
template_minor_version(impl Into<String>)/set_template_minor_version(Option<String>):The minor version of the service template that was used to create the service that the pipeline is associated with.
- On success, responds with
UpdateServicePipelineOutputwith field(s):pipeline(Option<ServicePipeline>):The pipeline details returned by Proton.
- On failure, responds with
SdkError<UpdateServicePipelineError>
Constructs a fluent builder for the UpdateServiceTemplate operation.
- The fluent builder is configurable:
name(impl Into<String>)/set_name(Option<String>):The name of the service template to update.
display_name(impl Into<String>)/set_display_name(Option<String>):The name of the service template to update as displayed in the developer interface.
description(impl Into<String>)/set_description(Option<String>):A description of the service template update.
- On success, responds with
UpdateServiceTemplateOutputwith field(s):service_template(Option<ServiceTemplate>):The service template detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateServiceTemplateError>
Constructs a fluent builder for the UpdateServiceTemplateVersion operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The name of the service template.
major_version(impl Into<String>)/set_major_version(Option<String>):To update a major version of a service template, include
major Version.minor_version(impl Into<String>)/set_minor_version(Option<String>):To update a minor version of a service template, include
minorVersion.description(impl Into<String>)/set_description(Option<String>):A description of a service template version to update.
status(TemplateVersionStatus)/set_status(Option<TemplateVersionStatus>):The status of the service template minor version to update.
compatible_environment_templates(Vec<CompatibleEnvironmentTemplateInput>)/set_compatible_environment_templates(Option<Vec<CompatibleEnvironmentTemplateInput>>):An array of compatible environment names for a service template major or minor version to update.
- On success, responds with
UpdateServiceTemplateVersionOutputwith field(s):service_template_version(Option<ServiceTemplateVersion>):The service template version detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateServiceTemplateVersionError>
Constructs a fluent builder for the UpdateTemplateSyncConfig operation.
- The fluent builder is configurable:
template_name(impl Into<String>)/set_template_name(Option<String>):The synced template name.
template_type(TemplateType)/set_template_type(Option<TemplateType>):The synced template type.
repository_provider(RepositoryProvider)/set_repository_provider(Option<RepositoryProvider>):The repository provider.
repository_name(impl Into<String>)/set_repository_name(Option<String>):The name of the repository, for example
myrepos/myrepo.branch(impl Into<String>)/set_branch(Option<String>):The repository branch.
subdirectory(impl Into<String>)/set_subdirectory(Option<String>):A subdirectory path to your template bundle version. When included, limits the template bundle search to this repository directory.
- On success, responds with
UpdateTemplateSyncConfigOutputwith field(s):template_sync_config(Option<TemplateSyncConfig>):The template sync configuration detail data that’s returned by Proton.
- On failure, responds with
SdkError<UpdateTemplateSyncConfigError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more