Struct aws_sdk_proton::client::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_proton::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = aws_config::load_from_env().await;
let config = aws_sdk_proton::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CancelComponentDeployment operation has a Client::cancel_component_deployment, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.cancel_component_deployment()
    .component_name("example")
    .call()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_environment_account_connection( &self ) -> AcceptEnvironmentAccountConnectionFluentBuilder

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 AcceptEnvironmentAccountConnectionOutput with field(s):
  • environment_account_connection(Option<EnvironmentAccountConnection>):

    The environment account connection data that’s returned by Proton.

• On failure, responds with SdkError<AcceptEnvironmentAccountConnectionError>

impl Client

pub fn cancel_component_deployment( &self ) -> CancelComponentDeploymentFluentBuilder

Constructs a fluent builder for the CancelComponentDeployment operation.

• The fluent builder is configurable:
  • component_name(impl Into<String>) / set_component_name(Option<String>):

    The name of the component with the deployment to cancel.

• On success, responds with CancelComponentDeploymentOutput with field(s):
  • component(Option<Component>):

    The detailed data of the component with the deployment that is being canceled.

• On failure, responds with SdkError<CancelComponentDeploymentError>

impl Client

pub fn cancel_environment_deployment( &self ) -> CancelEnvironmentDeploymentFluentBuilder

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 CancelEnvironmentDeploymentOutput with field(s):
  • environment(Option<Environment>):

    The environment summary data that’s returned by Proton.

• On failure, responds with SdkError<CancelEnvironmentDeploymentError>

impl Client

pub fn cancel_service_instance_deployment( &self ) -> CancelServiceInstanceDeploymentFluentBuilder

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 CancelServiceInstanceDeploymentOutput with field(s):
  • service_instance(Option<ServiceInstance>):

    The service instance summary data that’s returned by Proton.

• On failure, responds with SdkError<CancelServiceInstanceDeploymentError>

impl Client

pub fn cancel_service_pipeline_deployment( &self ) -> CancelServicePipelineDeploymentFluentBuilder

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 CancelServicePipelineDeploymentOutput with field(s):
  • pipeline(Option<ServicePipeline>):

    The service pipeline detail data that’s returned by Proton.

• On failure, responds with SdkError<CancelServicePipelineDeploymentError>

impl Client

pub fn create_component(&self) -> CreateComponentFluentBuilder

Constructs a fluent builder for the CreateComponent operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The customer-provided name of the component.

  • description(impl Into<String>) / set_description(Option<String>):

    An optional customer-provided description of the component.

  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that serviceInstanceName is associated with. If you don’t specify this, the component isn’t attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

  • service_instance_name(impl Into<String>) / set_service_instance_name(Option<String>):

    The name of the service instance that you want to attach this component to. If you don’t specify this, the component isn’t attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

  • environment_name(impl Into<String>) / set_environment_name(Option<String>):

    The name of the Proton environment that you want to associate this component with. You must specify this when you don’t specify serviceInstanceName and serviceName.

  • template_file(impl Into<String>) / set_template_file(Option<String>):

    A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

    Components support a single IaC file, even if you use Terraform as your template language.

  • manifest(impl Into<String>) / set_manifest(Option<String>):

    A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

  • service_spec(impl Into<String>) / set_service_spec(Option<String>):

    The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The client token for the created component.

• On success, responds with CreateComponentOutput with field(s):
  • component(Option<Component>):

    The detailed data of the created component.

• On failure, responds with SdkError<CreateComponentError>

impl Client

pub fn create_environment(&self) -> CreateEnvironmentFluentBuilder

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 User 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 YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User 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.

    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

  • 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. For more information, see Environment account connections in the Proton User guide.

    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

  • provisioning_repository(RepositoryBranchInput) / set_provisioning_repository(Option<RepositoryBranchInput>):

    The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.

  • component_role_arn(impl Into<String>) / set_component_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

    You must specify componentRoleArn to allow directly defined components to be associated with this environment.

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

  • codebuild_role_arn(impl Into<String>) / set_codebuild_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

    To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn parameter.

• On success, responds with CreateEnvironmentOutput with field(s):
  • environment(Option<Environment>):

    The environment detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateEnvironmentError>

impl Client

pub fn create_environment_account_connection( &self ) -> CreateEnvironmentAccountConnectionFluentBuilder

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 and 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>>):

    An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

  • component_role_arn(impl Into<String>) / set_component_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

    You must specify componentRoleArn to allow directly defined components to be associated with any environments running in this account.

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

  • codebuild_role_arn(impl Into<String>) / set_codebuild_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

• On success, responds with CreateEnvironmentAccountConnectionOutput with field(s):
  • environment_account_connection(Option<EnvironmentAccountConnection>):

    The environment account connection detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateEnvironmentAccountConnectionError>

impl Client

pub fn create_environment_template( &self ) -> CreateEnvironmentTemplateFluentBuilder

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>>):

    An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

• On success, responds with CreateEnvironmentTemplateOutput with field(s):
  • environment_template(Option<EnvironmentTemplate>):

    The environment template detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateEnvironmentTemplateError>

impl Client

pub fn create_environment_template_version( &self ) -> CreateEnvironmentTemplateVersionFluentBuilder

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 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>>):

    An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

• On success, responds with CreateEnvironmentTemplateVersionOutput with field(s):
  • environment_template_version(Option<EnvironmentTemplateVersion>):

    The environment template detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateEnvironmentTemplateVersionError>

impl Client

pub fn create_repository(&self) -> CreateRepositoryFluentBuilder

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 AWS CodeStar connection that connects Proton to your repository provider account. For more information, see Setting up for Proton in the Proton User 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.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

• On success, responds with CreateRepositoryOutput with field(s):
  • repository(Option<Repository>):

    The repository link’s detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateRepositoryError>

impl Client

pub fn create_service(&self) -> CreateServiceFluentBuilder

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 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 Setting up an AWS CodeStar connection 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>>):

    An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

• On success, responds with CreateServiceOutput with field(s):
  • service(Option<Service>):

    The service detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateServiceError>

impl Client

pub fn create_service_instance(&self) -> CreateServiceInstanceFluentBuilder

Constructs a fluent builder for the CreateServiceInstance operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the service instance to create.

  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service the service instance is added to.

  • spec(impl Into<String>) / set_spec(Option<String>):

    The spec for the service instance you want to create.

  • template_major_version(impl Into<String>) / set_template_major_version(Option<String>):

    To create a new major and minor version of the service template, exclude major Version.

  • template_minor_version(impl Into<String>) / set_template_minor_version(Option<String>):

    To create a new minor version of the service template, include a major Version.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The client token of the service instance to create.

• On success, responds with CreateServiceInstanceOutput with field(s):
  • service_instance(Option<ServiceInstance>):

    The detailed data of the service instance being created.

• On failure, responds with SdkError<CreateServiceInstanceError>

impl Client

pub fn create_service_sync_config(&self) -> CreateServiceSyncConfigFluentBuilder

Constructs a fluent builder for the CreateServiceSyncConfig operation.

• The fluent builder is configurable:
  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service the Proton Ops file is for.

  • 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 repository name.

  • branch(impl Into<String>) / set_branch(Option<String>):

    The repository branch for your Proton Ops file.

  • file_path(impl Into<String>) / set_file_path(Option<String>):

    The path to the Proton Ops file.

• On success, responds with CreateServiceSyncConfigOutput with field(s):
  • service_sync_config(Option<ServiceSyncConfig>):

    The detailed data of the Proton Ops file.

• On failure, responds with SdkError<CreateServiceSyncConfigError>

impl Client

pub fn create_service_template(&self) -> CreateServiceTemplateFluentBuilder

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>):

    By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn’t provided for your service. After it’s included, it can’t be changed. For more information, see Template bundles in the Proton User Guide.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

• On success, responds with CreateServiceTemplateOutput with field(s):
  • service_template(Option<ServiceTemplate>):

    The service template detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateServiceTemplateError>

impl Client

pub fn create_service_template_version( &self ) -> CreateServiceTemplateVersionFluentBuilder

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 environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

  • supported_component_sources(Vec<ServiceTemplateSupportedComponentSourceType>) / set_supported_component_sources(Option<Vec<ServiceTemplateSupportedComponentSourceType>>):

    An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

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

• On success, responds with CreateServiceTemplateVersionOutput with 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>

impl Client

pub fn create_template_sync_config( &self ) -> CreateTemplateSyncConfigFluentBuilder

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 repository name (for example, myrepos/myrepo).

  • branch(impl Into<String>) / set_branch(Option<String>):

    The repository branch 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 CreateTemplateSyncConfigOutput with field(s):
  • template_sync_config(Option<TemplateSyncConfig>):

    The template sync configuration detail data that’s returned by Proton.

• On failure, responds with SdkError<CreateTemplateSyncConfigError>

impl Client

pub fn delete_component(&self) -> DeleteComponentFluentBuilder

Constructs a fluent builder for the DeleteComponent operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the component to delete.

• On success, responds with DeleteComponentOutput with field(s):
  • component(Option<Component>):

    The detailed data of the component being deleted.

• On failure, responds with SdkError<DeleteComponentError>

impl Client

pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder

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 DeleteEnvironmentOutput with field(s):
  • environment(Option<Environment>):

    The detailed data of the environment being deleted.

• On failure, responds with SdkError<DeleteEnvironmentError>

impl Client

pub fn delete_environment_account_connection( &self ) -> DeleteEnvironmentAccountConnectionFluentBuilder

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 DeleteEnvironmentAccountConnectionOutput with field(s):
  • environment_account_connection(Option<EnvironmentAccountConnection>):

    The detailed data of the environment account connection being deleted.

• On failure, responds with SdkError<DeleteEnvironmentAccountConnectionError>

impl Client

pub fn delete_environment_template( &self ) -> DeleteEnvironmentTemplateFluentBuilder

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 DeleteEnvironmentTemplateOutput with field(s):
  • environment_template(Option<EnvironmentTemplate>):

    The detailed data of the environment template being deleted.

• On failure, responds with SdkError<DeleteEnvironmentTemplateError>

impl Client

pub fn delete_environment_template_version( &self ) -> DeleteEnvironmentTemplateVersionFluentBuilder

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 DeleteEnvironmentTemplateVersionOutput with field(s):
  • environment_template_version(Option<EnvironmentTemplateVersion>):

    The detailed data of the environment template version being deleted.

• On failure, responds with SdkError<DeleteEnvironmentTemplateVersionError>

impl Client

pub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder

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 repository name.

• On success, responds with DeleteRepositoryOutput with field(s):
  • repository(Option<Repository>):

    The deleted repository link’s detail data that’s returned by Proton.

• On failure, responds with SdkError<DeleteRepositoryError>

impl Client

pub fn delete_service(&self) -> DeleteServiceFluentBuilder

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 DeleteServiceOutput with field(s):
  • service(Option<Service>):

    The detailed data of the service being deleted.

• On failure, responds with SdkError<DeleteServiceError>

impl Client

pub fn delete_service_sync_config(&self) -> DeleteServiceSyncConfigFluentBuilder

Constructs a fluent builder for the DeleteServiceSyncConfig operation.

• The fluent builder is configurable:
  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that you want to delete the service sync configuration for.

• On success, responds with DeleteServiceSyncConfigOutput with field(s):
  • service_sync_config(Option<ServiceSyncConfig>):

    The detailed data for the service sync config.

• On failure, responds with SdkError<DeleteServiceSyncConfigError>

impl Client

pub fn delete_service_template(&self) -> DeleteServiceTemplateFluentBuilder

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 DeleteServiceTemplateOutput with field(s):
  • service_template(Option<ServiceTemplate>):

    The detailed data of the service template being deleted.

• On failure, responds with SdkError<DeleteServiceTemplateError>

impl Client

pub fn delete_service_template_version( &self ) -> DeleteServiceTemplateVersionFluentBuilder

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 DeleteServiceTemplateVersionOutput with field(s):
  • service_template_version(Option<ServiceTemplateVersion>):

    The detailed data of the service template version being deleted.

• On failure, responds with SdkError<DeleteServiceTemplateVersionError>

impl Client

pub fn delete_template_sync_config( &self ) -> DeleteTemplateSyncConfigFluentBuilder

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 DeleteTemplateSyncConfigOutput with field(s):
  • template_sync_config(Option<TemplateSyncConfig>):

    The template sync configuration detail data that’s returned by Proton.

• On failure, responds with SdkError<DeleteTemplateSyncConfigError>

impl Client

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    The Proton pipeline service role detail data that’s returned by Proton.

• On failure, responds with SdkError<GetAccountSettingsError>

impl Client

pub fn get_component(&self) -> GetComponentFluentBuilder

Constructs a fluent builder for the GetComponent operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the component that you want to get the detailed data for.

• On success, responds with GetComponentOutput with field(s):
  • component(Option<Component>):

    The detailed data of the requested component.

• On failure, responds with SdkError<GetComponentError>

impl Client

pub fn get_environment(&self) -> GetEnvironmentFluentBuilder

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 detailed data for.

• On success, responds with GetEnvironmentOutput with field(s):
  • environment(Option<Environment>):

    The detailed data of the requested environment.

• On failure, responds with SdkError<GetEnvironmentError>

impl Client

pub fn get_environment_account_connection( &self ) -> GetEnvironmentAccountConnectionFluentBuilder

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 that you want to get the detailed data for.

• On success, responds with GetEnvironmentAccountConnectionOutput with field(s):
  • environment_account_connection(Option<EnvironmentAccountConnection>):

    The detailed data of the requested environment account connection.

• On failure, responds with SdkError<GetEnvironmentAccountConnectionError>

impl Client

pub fn get_environment_template(&self) -> GetEnvironmentTemplateFluentBuilder

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 detailed data for.

• On success, responds with GetEnvironmentTemplateOutput with field(s):
  • environment_template(Option<EnvironmentTemplate>):

    The detailed data of the requested environment template.

• On failure, responds with SdkError<GetEnvironmentTemplateError>

impl Client

pub fn get_environment_template_version( &self ) -> GetEnvironmentTemplateVersionFluentBuilder

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 a version of which you want to get detailed data for.

  • major_version(impl Into<String>) / set_major_version(Option<String>):

    To get environment template major version detail data, include major Version.

  • minor_version(impl Into<String>) / set_minor_version(Option<String>):

    To get environment template minor version detail data, include minorVersion.

• On success, responds with GetEnvironmentTemplateVersionOutput with field(s):
  • environment_template_version(Option<EnvironmentTemplateVersion>):

    The detailed data of the requested environment template version.

• On failure, responds with SdkError<GetEnvironmentTemplateVersionError>

impl Client

pub fn get_repository(&self) -> GetRepositoryFluentBuilder

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 GetRepositoryOutput with field(s):
  • repository(Option<Repository>):

    The repository link’s detail data that’s returned by Proton.

• On failure, responds with SdkError<GetRepositoryError>

impl Client

pub fn get_repository_sync_status(&self) -> GetRepositorySyncStatusFluentBuilder

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 GetRepositorySyncStatusOutput with field(s):
  • latest_sync(Option<RepositorySyncAttempt>):

    The repository sync status detail data that’s returned by Proton.

• On failure, responds with SdkError<GetRepositorySyncStatusError>

impl Client

pub fn get_resources_summary(&self) -> GetResourcesSummaryFluentBuilder

Constructs a fluent builder for the GetResourcesSummary operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetResourcesSummaryOutput with field(s):
  • counts(Option<CountsSummary>):

    Summary counts of each Proton resource type.

• On failure, responds with SdkError<GetResourcesSummaryError>

impl Client

pub fn get_service(&self) -> GetServiceFluentBuilder

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 detailed data for.

• On success, responds with GetServiceOutput with field(s):
  • service(Option<Service>):

    The detailed data of the requested service.

• On failure, responds with SdkError<GetServiceError>

impl Client

pub fn get_service_instance(&self) -> GetServiceInstanceFluentBuilder

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 detailed data for.

  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that you want the service instance input for.

• On success, responds with GetServiceInstanceOutput with field(s):
  • service_instance(Option<ServiceInstance>):

    The detailed data of the requested service instance.

• On failure, responds with SdkError<GetServiceInstanceError>

impl Client

pub fn get_service_instance_sync_status( &self ) -> GetServiceInstanceSyncStatusFluentBuilder

Constructs a fluent builder for the GetServiceInstanceSyncStatus operation.

• 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.

  • service_instance_name(impl Into<String>) / set_service_instance_name(Option<String>):

    The name of the service instance that you want the sync status input for.

• On success, responds with GetServiceInstanceSyncStatusOutput with field(s):
  • latest_sync(Option<ResourceSyncAttempt>):

    The detailed data of the latest sync with the service instance.

  • latest_successful_sync(Option<ResourceSyncAttempt>):

    The detailed data of the latest successful sync with the service instance.

  • desired_state(Option<Revision>):

    The service instance sync desired state that’s returned by Proton

• On failure, responds with SdkError<GetServiceInstanceSyncStatusError>

impl Client

pub fn get_service_sync_blocker_summary( &self ) -> GetServiceSyncBlockerSummaryFluentBuilder

Constructs a fluent builder for the GetServiceSyncBlockerSummary operation.

• The fluent builder is configurable:
  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.

  • service_instance_name(impl Into<String>) / set_service_instance_name(Option<String>):

    The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.

• On success, responds with GetServiceSyncBlockerSummaryOutput with field(s):
  • service_sync_blocker_summary(Option<ServiceSyncBlockerSummary>):

    The detailed data of the requested service sync blocker summary.

• On failure, responds with SdkError<GetServiceSyncBlockerSummaryError>

impl Client

pub fn get_service_sync_config(&self) -> GetServiceSyncConfigFluentBuilder

Constructs a fluent builder for the GetServiceSyncConfig operation.

• The fluent builder is configurable:
  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that you want to get the service sync configuration for.

• On success, responds with GetServiceSyncConfigOutput with field(s):
  • service_sync_config(Option<ServiceSyncConfig>):

    The detailed data of the requested service sync configuration.

• On failure, responds with SdkError<GetServiceSyncConfigError>

impl Client

pub fn get_service_template(&self) -> GetServiceTemplateFluentBuilder

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 detailed data for.

• On success, responds with GetServiceTemplateOutput with field(s):
  • service_template(Option<ServiceTemplate>):

    The detailed data of the requested service template.

• On failure, responds with SdkError<GetServiceTemplateError>

impl Client

pub fn get_service_template_version( &self ) -> GetServiceTemplateVersionFluentBuilder

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 a version of which you want to get detailed data for.

  • major_version(impl Into<String>) / set_major_version(Option<String>):

    To get service template major version detail data, include major Version.

  • minor_version(impl Into<String>) / set_minor_version(Option<String>):

    To get service template minor version detail data, include minorVersion.

• On success, responds with GetServiceTemplateVersionOutput with field(s):
  • service_template_version(Option<ServiceTemplateVersion>):

    The detailed data of the requested service template version.

• On failure, responds with SdkError<GetServiceTemplateVersionError>

impl Client

pub fn get_template_sync_config(&self) -> GetTemplateSyncConfigFluentBuilder

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 GetTemplateSyncConfigOutput with field(s):
  • template_sync_config(Option<TemplateSyncConfig>):

    The template sync configuration detail data that’s returned by Proton.

• On failure, responds with SdkError<GetTemplateSyncConfigError>

impl Client

pub fn get_template_sync_status(&self) -> GetTemplateSyncStatusFluentBuilder

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 major version.

• On success, responds with GetTemplateSyncStatusOutput with 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>

impl Client

pub fn list_component_outputs(&self) -> ListComponentOutputsFluentBuilder

Constructs a fluent builder for the ListComponentOutputs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • component_name(impl Into<String>) / set_component_name(Option<String>):

    The name of the component whose outputs you want.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

• On success, responds with ListComponentOutputsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

  • outputs(Option<Vec<Output>>):

    An array of component Infrastructure as Code (IaC) outputs.

• On failure, responds with SdkError<ListComponentOutputsError>

impl Client

pub fn list_component_provisioned_resources( &self ) -> ListComponentProvisionedResourcesFluentBuilder

Constructs a fluent builder for the ListComponentProvisionedResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • component_name(impl Into<String>) / set_component_name(Option<String>):

    The name of the component whose provisioned resources you want.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates 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 ListComponentProvisionedResourcesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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 component.

• On failure, responds with SdkError<ListComponentProvisionedResourcesError>

impl Client

pub fn list_components(&self) -> ListComponentsFluentBuilder

Constructs a fluent builder for the ListComponents 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 that indicates the location of the next component in the array of components, after the list of components that was previously requested.

  • environment_name(impl Into<String>) / set_environment_name(Option<String>):

    The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of a service for result list filtering. Proton returns components attached to service instances of the service.

  • service_instance_name(impl Into<String>) / set_service_instance_name(Option<String>):

    The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of components to list.

• On success, responds with ListComponentsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates the location of the next component in the array of components, after the current requested list of components.

  • components(Option<Vec<ComponentSummary>>):

    An array of components with summary data.

• On failure, responds with SdkError<ListComponentsError>

impl Client

pub fn list_environment_account_connections( &self ) -> ListEnvironmentAccountConnectionsFluentBuilder

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 ListEnvironmentAccountConnections request.

  • 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 that indicates 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 ListEnvironmentAccountConnectionsOutput with 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 that indicates 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>

impl Client

pub fn list_environment_outputs(&self) -> ListEnvironmentOutputsFluentBuilder

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 that indicates 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 ListEnvironmentOutputsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_environment_provisioned_resources( &self ) -> ListEnvironmentProvisionedResourcesFluentBuilder

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 that indicates 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 ListEnvironmentProvisionedResourcesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_environment_template_versions( &self ) -> ListEnvironmentTemplateVersionsFluentBuilder

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 that indicates 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 ListEnvironmentTemplateVersionsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_environment_templates( &self ) -> ListEnvironmentTemplatesFluentBuilder

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 that indicates 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 ListEnvironmentTemplatesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder

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 that indicates 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 ListEnvironmentsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_repositories(&self) -> ListRepositoriesFluentBuilder

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 that indicates 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 ListRepositoriesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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 repository links.

• On failure, responds with SdkError<ListRepositoriesError>

impl Client

pub fn list_repository_sync_definitions( &self ) -> ListRepositorySyncDefinitionsFluentBuilder

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 that indicates 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 ListRepositorySyncDefinitionsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_service_instance_outputs( &self ) -> ListServiceInstanceOutputsFluentBuilder

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 name of the service instance whose outputs you want.

  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that serviceInstanceName is associated to.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

• On success, responds with ListServiceInstanceOutputsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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 (IaC) outputs.

• On failure, responds with SdkError<ListServiceInstanceOutputsError>

impl Client

pub fn list_service_instance_provisioned_resources( &self ) -> ListServiceInstanceProvisionedResourcesFluentBuilder

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 name of the service that serviceInstanceName is associated to.

  • service_instance_name(impl Into<String>) / set_service_instance_name(Option<String>):

    The name of the service instance whose provisioned resources you want.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates 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 ListServiceInstanceProvisionedResourcesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_service_instances(&self) -> ListServiceInstancesFluentBuilder

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 that indicates 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.

  • filters(Vec<ListServiceInstancesFilter>) / set_filters(Option<Vec<ListServiceInstancesFilter>>):

    An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

  • sort_by(ListServiceInstancesSortBy) / set_sort_by(Option<ListServiceInstancesSortBy>):

    The field that the result list is sorted by.

    When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

    Default: serviceName

  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):

    Result list sort order.

    Default: ASCENDING

• On success, responds with ListServiceInstancesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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 summary data.

• On failure, responds with SdkError<ListServiceInstancesError>

impl Client

pub fn list_service_pipeline_outputs( &self ) -> ListServicePipelineOutputsFluentBuilder

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 name of the service whose pipeline’s outputs you want.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.

• On success, responds with ListServicePipelineOutputsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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 pipeline Infrastructure as Code (IaC) outputs.

• On failure, responds with SdkError<ListServicePipelineOutputsError>

impl Client

pub fn list_service_pipeline_provisioned_resources( &self ) -> ListServicePipelineProvisionedResourcesFluentBuilder

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 name of the service whose pipeline’s provisioned resources you want.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    A token that indicates 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 ListServicePipelineProvisionedResourcesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_service_template_versions( &self ) -> ListServiceTemplateVersionsFluentBuilder

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 that indicates 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 ListServiceTemplateVersionsOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_service_templates(&self) -> ListServiceTemplatesFluentBuilder

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 that indicates 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 ListServiceTemplatesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_services(&self) -> ListServicesFluentBuilder

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 that indicates 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 ListServicesOutput with field(s):
  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

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 that indicates 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 ListTagsForResourceOutput with field(s):
  • tags(Option<Vec<Tag>>):

    A list of resource tags with detail data.

  • next_token(Option<String>):

    A token that indicates 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>

impl Client

pub fn notify_resource_deployment_status_change( &self ) -> NotifyResourceDeploymentStatusChangeFluentBuilder

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>

impl Client

pub fn reject_environment_account_connection( &self ) -> RejectEnvironmentAccountConnectionFluentBuilder

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 RejectEnvironmentAccountConnectionOutput with field(s):
  • environment_account_connection(Option<EnvironmentAccountConnection>):

    The environment connection account detail data that’s returned by Proton.

• On failure, responds with SdkError<RejectEnvironmentAccountConnectionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

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 Proton resource to apply customer tags to.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    A list of customer tags to apply to the Proton resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

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 to remove customer tags from.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    A list of customer tag keys that indicate the customer tags to be removed from the resource.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder

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 service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.

    To remove a previously configured ARN, specify an empty string.

  • pipeline_provisioning_repository(RepositoryBranchInput) / set_pipeline_provisioning_repository(Option<RepositoryBranchInput>):

    A linked repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

    To remove a previously configured repository, set deletePipelineProvisioningRepository to true, and don’t set pipelineProvisioningRepository.

  • delete_pipeline_provisioning_repository(bool) / set_delete_pipeline_provisioning_repository(Option<bool>):

    Set to true to remove a configured pipeline repository from the account settings. Don’t set this field if you are updating the configured pipeline repository.

  • pipeline_codebuild_role_arn(impl Into<String>) / set_pipeline_codebuild_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Proton assumes this role for CodeBuild-based provisioning.

• On success, responds with UpdateAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    The Proton pipeline service role and repository data shared across the Amazon Web Services account.

• On failure, responds with SdkError<UpdateAccountSettingsError>

impl Client

pub fn update_component(&self) -> UpdateComponentFluentBuilder

Constructs a fluent builder for the UpdateComponent operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):

    The name of the component to update.

  • deployment_type(ComponentDeploymentUpdateType) / set_deployment_type(Option<ComponentDeploymentUpdateType>):

    The deployment type. It defines the mode for updating a component, as follows:

    NONE

    In this mode, a deployment doesn’t occur. Only the requested metadata parameters are updated. You can only specify description in this mode.

    CURRENT_VERSION

    In this mode, the component is deployed and updated with the new serviceSpec, templateSource, and/or type that you provide. Only requested parameters are updated.

  • description(impl Into<String>) / set_description(Option<String>):

    An optional customer-provided description of the component.

  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service that serviceInstanceName is associated with. Don’t specify to keep the component’s current service instance attachment. Specify an empty string to detach the component from the service instance it’s attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

  • service_instance_name(impl Into<String>) / set_service_instance_name(Option<String>):

    The name of the service instance that you want to attach this component to. Don’t specify to keep the component’s current service instance attachment. Specify an empty string to detach the component from the service instance it’s attached to. Specify non-empty values for both serviceInstanceName and serviceName or for neither of them.

  • service_spec(impl Into<String>) / set_service_spec(Option<String>):

    The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.

  • template_file(impl Into<String>) / set_template_file(Option<String>):

    A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

    Components support a single IaC file, even if you use Terraform as your template language.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The client token for the updated component.

• On success, responds with UpdateComponentOutput with field(s):
  • component(Option<Component>):

    The detailed data of the updated component.

• On failure, responds with SdkError<UpdateComponentError>

impl Client

pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder

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. 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 major or minor 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 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 linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

  • component_role_arn(impl Into<String>) / set_component_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

    The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.

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

  • codebuild_role_arn(impl Into<String>) / set_codebuild_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

• On success, responds with UpdateEnvironmentOutput with field(s):
  • environment(Option<Environment>):

    The environment detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateEnvironmentError>

impl Client

pub fn update_environment_account_connection( &self ) -> UpdateEnvironmentAccountConnectionFluentBuilder

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’s associated with the environment account connection to update.

  • component_role_arn(impl Into<String>) / set_component_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in the associated environment account. It determines the scope of infrastructure that a component can provision in the account.

    The environment account connection must have a componentRoleArn to allow directly defined components to be associated with any environments running in the account.

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

  • codebuild_role_arn(impl Into<String>) / set_codebuild_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of an IAM service role in the environment account. Proton uses this role to provision infrastructure resources using CodeBuild-based provisioning in the associated environment account.

• On success, responds with UpdateEnvironmentAccountConnectionOutput with field(s):
  • environment_account_connection(Option<EnvironmentAccountConnection>):

    The environment account connection detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateEnvironmentAccountConnectionError>

impl Client

pub fn update_environment_template( &self ) -> UpdateEnvironmentTemplateFluentBuilder

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 UpdateEnvironmentTemplateOutput with field(s):
  • environment_template(Option<EnvironmentTemplate>):

    The environment template detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateEnvironmentTemplateError>

impl Client

pub fn update_environment_template_version( &self ) -> UpdateEnvironmentTemplateVersionFluentBuilder

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 UpdateEnvironmentTemplateVersionOutput with field(s):
  • environment_template_version(Option<EnvironmentTemplateVersion>):

    The environment template version detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateEnvironmentTemplateVersionError>

impl Client

pub fn update_service(&self) -> UpdateServiceFluentBuilder

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 User Guide.

• On success, responds with UpdateServiceOutput with field(s):
  • service(Option<Service>):

    The service detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateServiceError>

impl Client

pub fn update_service_instance(&self) -> UpdateServiceInstanceFluentBuilder

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. It defines the mode for updating a service instance, as follows:

    NONE

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

    CURRENT_VERSION

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

    MINOR_VERSION

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

    MAJOR_VERSION

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

  • 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.

  • client_token(impl Into<String>) / set_client_token(Option<String>):

    The client token of the service instance to update.

• On success, responds with UpdateServiceInstanceOutput with field(s):
  • service_instance(Option<ServiceInstance>):

    The service instance summary data that’s returned by Proton.

• On failure, responds with SdkError<UpdateServiceInstanceError>

impl Client

pub fn update_service_pipeline(&self) -> UpdateServicePipelineFluentBuilder

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

  • 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 UpdateServicePipelineOutput with field(s):
  • pipeline(Option<ServicePipeline>):

    The pipeline details that are returned by Proton.

• On failure, responds with SdkError<UpdateServicePipelineError>

impl Client

pub fn update_service_sync_blocker( &self ) -> UpdateServiceSyncBlockerFluentBuilder

Constructs a fluent builder for the UpdateServiceSyncBlocker operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):

    The ID of the service sync blocker.

  • resolved_reason(impl Into<String>) / set_resolved_reason(Option<String>):

    The reason the service sync blocker was resolved.

• On success, responds with UpdateServiceSyncBlockerOutput with field(s):
  • service_name(Option<String>):

    The name of the service that you want to update the service sync blocker for.

  • service_instance_name(Option<String>):

    The name of the service instance that you want to update the service sync blocker for.

  • service_sync_blocker(Option<SyncBlocker>):

    The detailed data on the service sync blocker that was updated.

• On failure, responds with SdkError<UpdateServiceSyncBlockerError>

impl Client

pub fn update_service_sync_config(&self) -> UpdateServiceSyncConfigFluentBuilder

Constructs a fluent builder for the UpdateServiceSyncConfig operation.

• The fluent builder is configurable:
  • service_name(impl Into<String>) / set_service_name(Option<String>):

    The name of the service the Proton Ops file is for.

  • repository_provider(RepositoryProvider) / set_repository_provider(Option<RepositoryProvider>):

    The name of the repository provider where the Proton Ops file is found.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository where the Proton Ops file is found.

  • branch(impl Into<String>) / set_branch(Option<String>):

    The name of the code repository branch where the Proton Ops file is found.

  • file_path(impl Into<String>) / set_file_path(Option<String>):

    The path to the Proton Ops file.

• On success, responds with UpdateServiceSyncConfigOutput with field(s):
  • service_sync_config(Option<ServiceSyncConfig>):

    The detailed data of the Proton Ops file.

• On failure, responds with SdkError<UpdateServiceSyncConfigError>

impl Client

pub fn update_service_template(&self) -> UpdateServiceTemplateFluentBuilder

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 that’s displayed in the developer interface.

  • description(impl Into<String>) / set_description(Option<String>):

    A description of the service template update.

• On success, responds with UpdateServiceTemplateOutput with field(s):
  • service_template(Option<ServiceTemplate>):

    The service template detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateServiceTemplateError>

impl Client

pub fn update_service_template_version( &self ) -> UpdateServiceTemplateVersionFluentBuilder

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 environment template objects that are compatible with this service template version. A service instance based on this service template version can run in environments based on compatible templates.

  • supported_component_sources(Vec<ServiceTemplateSupportedComponentSourceType>) / set_supported_component_sources(Option<Vec<ServiceTemplateSupportedComponentSourceType>>):

    An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.

    A change to supportedComponentSources doesn’t impact existing component attachments to instances based on this template version. A change only affects later associations.

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

• On success, responds with UpdateServiceTemplateVersionOutput with field(s):
  • service_template_version(Option<ServiceTemplateVersion>):

    The service template version detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateServiceTemplateVersionError>

impl Client

pub fn update_template_sync_config( &self ) -> UpdateTemplateSyncConfigFluentBuilder

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 repository name (for example, myrepos/myrepo).

  • branch(impl Into<String>) / set_branch(Option<String>):

    The repository branch for your template.

  • 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 UpdateTemplateSyncConfigOutput with field(s):
  • template_sync_config(Option<TemplateSyncConfig>):

    The template sync configuration detail data that’s returned by Proton.

• On failure, responds with SdkError<UpdateTemplateSyncConfigError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.