Struct aws_sdk_m2::Client

pub struct Client { /* private fields */ }

Client for AWSMainframeModernization

Client for invoking operations on AWSMainframeModernization. Each operation on AWSMainframeModernization is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_m2::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_m2::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_m2::Client::from_conf(config);

Implementations

impl Client

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

Creates a client with the given service configuration.

Examples found in repository

src/client.rs (line 70)

    fn from(
        client: aws_smithy_client::Client<
            aws_smithy_client::erase::DynConnector,
            aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
        >,
    ) -> Self {
        Self::with_config(client, crate::Config::builder().build())
    }

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn cancel_batch_job_execution(&self) -> CancelBatchJobExecution

Constructs a fluent builder for the CancelBatchJobExecution operation.

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

    The unique identifier of the application.

  • execution_id(impl Into<String>) / set_execution_id(Option<String>):

    The unique identifier of the batch job execution.

• On success, responds with CancelBatchJobExecutionOutput
• On failure, responds with SdkError<CancelBatchJobExecutionError>

pub fn create_application(&self) -> CreateApplication

Constructs a fluent builder for the CreateApplication operation.

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

    The unique identifier of the application.

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

    The description of the application.

  • engine_type(EngineType) / set_engine_type(Option<EngineType>):

    The type of the target platform for this application.

  • definition(Definition) / set_definition(Option<Definition>):

    The application definition for this application. You can specify either inline JSON or an S3 bucket location.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    A list of tags to apply to the application.

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

    Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

• On success, responds with CreateApplicationOutput with field(s):
  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the application.

  • application_id(Option<String>):

    The unique application identifier.

  • application_version(Option<i32>):

    The version number of the application.

• On failure, responds with SdkError<CreateApplicationError>

pub fn create_data_set_import_task(&self) -> CreateDataSetImportTask

Constructs a fluent builder for the CreateDataSetImportTask operation.

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

    The unique identifier of the application for which you want to import data sets.

  • import_config(DataSetImportConfig) / set_import_config(Option<DataSetImportConfig>):

    The data set import task configuration.

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

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

• On success, responds with CreateDataSetImportTaskOutput with field(s):
  • task_id(Option<String>):

    The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.

• On failure, responds with SdkError<CreateDataSetImportTaskError>

pub fn create_deployment(&self) -> CreateDeployment

Constructs a fluent builder for the CreateDeployment operation.

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

    The identifier of the environment where this application will be deployed.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The application identifier.

  • application_version(i32) / set_application_version(Option<i32>):

    The version of the application to deploy.

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

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a deployment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

• On success, responds with CreateDeploymentOutput with field(s):
  • deployment_id(Option<String>):

    The unique identifier of the deployment.

• On failure, responds with SdkError<CreateDeploymentError>

pub fn create_environment(&self) -> CreateEnvironment

Constructs a fluent builder for the CreateEnvironment operation.

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

    The unique identifier of the environment.

  • instance_type(impl Into<String>) / set_instance_type(Option<String>):

    The type of instance for the environment.

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

    The description of the environment.

  • engine_type(EngineType) / set_engine_type(Option<EngineType>):

    The engine type for the environment.

  • engine_version(impl Into<String>) / set_engine_version(Option<String>):

    The version of the engine type for the environment.

  • subnet_ids(Vec<String>) / set_subnet_ids(Option<Vec<String>>):

    The list of subnets associated with the VPC for this environment.

  • security_group_ids(Vec<String>) / set_security_group_ids(Option<Vec<String>>):

    The list of security groups for the VPC associated with this environment.

  • storage_configurations(Vec<StorageConfiguration>) / set_storage_configurations(Option<Vec<StorageConfiguration>>):

    Optional. The storage configurations for this environment.

  • publicly_accessible(bool) / set_publicly_accessible(bool):

    Specifies whether the environment is publicly accessible.

  • high_availability_config(HighAvailabilityConfig) / set_high_availability_config(Option<HighAvailabilityConfig>):

    The details of a high availability configuration for this runtime environment.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags for the environment.

  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):

    Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

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

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

• On success, responds with CreateEnvironmentOutput with field(s):
  • environment_id(Option<String>):

    The identifier of this environment.

• On failure, responds with SdkError<CreateEnvironmentError>

pub fn delete_application(&self) -> DeleteApplication

Constructs a fluent builder for the DeleteApplication operation.

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

    The unique identifier of the application you want to delete.

• On success, responds with DeleteApplicationOutput
• On failure, responds with SdkError<DeleteApplicationError>

pub fn delete_application_from_environment(
    &self
) -> DeleteApplicationFromEnvironment

Constructs a fluent builder for the DeleteApplicationFromEnvironment operation.

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

    The unique identifier of the application you want to delete.

  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    The unique identifier of the runtime environment where the application was previously deployed.

• On success, responds with DeleteApplicationFromEnvironmentOutput
• On failure, responds with SdkError<DeleteApplicationFromEnvironmentError>

pub fn delete_environment(&self) -> DeleteEnvironment

Constructs a fluent builder for the DeleteEnvironment operation.

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

    The unique identifier of the runtime environment you want to delete.

• On success, responds with DeleteEnvironmentOutput
• On failure, responds with SdkError<DeleteEnvironmentError>

pub fn get_application(&self) -> GetApplication

Constructs a fluent builder for the GetApplication operation.

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

    The identifier of the application.

• On success, responds with GetApplicationOutput with field(s):
  • name(Option<String>):

    The unique identifier of the application.

  • description(Option<String>):

    The description of the application.

  • application_id(Option<String>):

    The identifier of the application.

  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the application.

  • status(Option<ApplicationLifecycle>):

    The status of the application.

  • latest_version(Option<ApplicationVersionSummary>):

    The latest version of the application.

  • deployed_version(Option<DeployedVersionSummary>):

    The version of the application that is deployed.

  • engine_type(Option<EngineType>):

    The type of the target platform for the application.

  • log_groups(Option<Vec<LogGroupSummary>>):

    The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. The Amazon Web Services Mainframe Modernization application log is pushed to CloudWatch under the customer’s account.

  • creation_time(Option<DateTime>):

    The timestamp when this application was created.

  • last_start_time(Option<DateTime>):

    The timestamp when the application was last started. Null until the application has started running for the first time.

  • tags(Option<HashMap<String, String>>):

    A list of tags associated with the application.

  • environment_id(Option<String>):

    The identifier of the environment where the application will be deployed.

  • target_group_arns(Option<Vec<String>>):

    Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.

  • listener_arns(Option<Vec<String>>):

    The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener on your behalf the first time you deploy an application.

  • listener_ports(Option<Vec<i32>>):

    The port associated with the network load balancer listener created in your Amazon Web Services account.

  • load_balancer_dns_name(Option<String>):

    The public DNS name of the load balancer created in your Amazon Web Services account.

  • status_reason(Option<String>):

    The reason for the reported status.

• On failure, responds with SdkError<GetApplicationError>

pub fn get_application_version(&self) -> GetApplicationVersion

Constructs a fluent builder for the GetApplicationVersion operation.

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

    The unique identifier of the application.

  • application_version(i32) / set_application_version(Option<i32>):

    The specific version of the application.

• On success, responds with GetApplicationVersionOutput with field(s):
  • name(Option<String>):

    The name of the application version.

  • application_version(Option<i32>):

    The specific version of the application.

  • description(Option<String>):

    The application description.

  • definition_content(Option<String>):

    The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.

  • status(Option<ApplicationVersionLifecycle>):

    The status of the application version.

  • creation_time(Option<DateTime>):

    The timestamp when the application version was created.

  • status_reason(Option<String>):

    The reason for the reported status.

• On failure, responds with SdkError<GetApplicationVersionError>

pub fn get_batch_job_execution(&self) -> GetBatchJobExecution

Constructs a fluent builder for the GetBatchJobExecution operation.

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

    The identifier of the application.

  • execution_id(impl Into<String>) / set_execution_id(Option<String>):

    The unique identifier of the batch job execution.

• On success, responds with GetBatchJobExecutionOutput with field(s):
  • execution_id(Option<String>):

    The unique identifier for this batch job execution.

  • application_id(Option<String>):

    The identifier of the application.

  • job_id(Option<String>):

    The unique identifier for this batch job.

  • job_name(Option<String>):

    The name of this batch job.

  • job_user(Option<String>):

    The user for the job.

  • job_type(Option<BatchJobType>):

    The type of job.

  • status(Option<BatchJobExecutionStatus>):

    The status of the batch job execution.

  • start_time(Option<DateTime>):

    The timestamp when the batch job execution started.

  • end_time(Option<DateTime>):

    The timestamp when the batch job execution ended.

  • status_reason(Option<String>):

    The reason for the reported status.

• On failure, responds with SdkError<GetBatchJobExecutionError>

pub fn get_data_set_details(&self) -> GetDataSetDetails

Constructs a fluent builder for the GetDataSetDetails operation.

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

    The unique identifier of the application that this data set is associated with.

  • data_set_name(impl Into<String>) / set_data_set_name(Option<String>):

    The name of the data set.

• On success, responds with GetDataSetDetailsOutput with field(s):
  • data_set_name(Option<String>):

    The name of the data set.

  • data_set_org(Option<DatasetDetailOrgAttributes>):

    The type of data set. Possible values include VSAM, IS, PS, GDG, PO, PS, or unknown.

  • record_length(Option<i32>):

    The length of records in the data set.

  • location(Option<String>):

    The locaion where the data set is stored.

  • blocksize(Option<i32>):

    The size of the block on disk.

  • creation_time(Option<DateTime>):

    The timestamp when the data set was created.

  • last_updated_time(Option<DateTime>):

    The last time the data set was updated.

  • last_referenced_time(Option<DateTime>):

    The last time the data set was referenced.

• On failure, responds with SdkError<GetDataSetDetailsError>

pub fn get_data_set_import_task(&self) -> GetDataSetImportTask

Constructs a fluent builder for the GetDataSetImportTask operation.

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

    The application identifier.

  • task_id(impl Into<String>) / set_task_id(Option<String>):

    The task identifier returned by the CreateDataSetImportTask operation.

• On success, responds with GetDataSetImportTaskOutput with field(s):
  • task_id(Option<String>):

    The task identifier.

  • status(Option<DataSetTaskLifecycle>):

    The status of the task.

  • summary(Option<DataSetImportSummary>):

    A summary of the status of the task.

• On failure, responds with SdkError<GetDataSetImportTaskError>

pub fn get_deployment(&self) -> GetDeployment

Constructs a fluent builder for the GetDeployment operation.

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

    The unique identifier for the deployment.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The unique identifier of the application.

• On success, responds with GetDeploymentOutput with field(s):
  • deployment_id(Option<String>):

    The unique identifier of the deployment.

  • application_id(Option<String>):

    The unique identifier of the application.

  • environment_id(Option<String>):

    The unique identifier of the runtime environment.

  • application_version(Option<i32>):

    The application version.

  • status(Option<DeploymentLifecycle>):

    The status of the deployment.

  • creation_time(Option<DateTime>):

    The timestamp when the deployment was created.

  • status_reason(Option<String>):

    The reason for the reported status.

• On failure, responds with SdkError<GetDeploymentError>

pub fn get_environment(&self) -> GetEnvironment

Constructs a fluent builder for the GetEnvironment operation.

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

    The unique identifier of the runtime environment.

• On success, responds with GetEnvironmentOutput with field(s):
  • name(Option<String>):

    The name of the runtime environment.

  • description(Option<String>):

    The description of the runtime environment.

  • environment_arn(Option<String>):

    The Amazon Resource Name (ARN) of the runtime environment.

  • environment_id(Option<String>):

    The unique identifier of the runtime environment.

  • instance_type(Option<String>):

    The type of instance underlying the runtime environment.

  • status(Option<EnvironmentLifecycle>):

    The status of the runtime environment.

  • engine_type(Option<EngineType>):

    The target platform for the runtime environment.

  • engine_version(Option<String>):

    The version of the runtime engine.

  • vpc_id(Option<String>):

    The unique identifier for the VPC used with this runtime environment.

  • subnet_ids(Option<Vec<String>>):

    The unique identifiers of the subnets assigned to this runtime environment.

  • security_group_ids(Option<Vec<String>>):

    The unique identifiers of the security groups assigned to this runtime environment.

  • creation_time(Option<DateTime>):

    The timestamp when the runtime environment was created.

  • storage_configurations(Option<Vec<StorageConfiguration>>):

    The storage configurations defined for the runtime environment.

  • tags(Option<HashMap<String, String>>):

    The tags defined for this runtime environment.

  • high_availability_config(Option<HighAvailabilityConfig>):

    The desired capacity of the high availability configuration for the runtime environment.

  • publicly_accessible(bool):

    Whether applications running in this runtime environment are publicly accessible.

  • actual_capacity(Option<i32>):

    The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

  • load_balancer_arn(Option<String>):

    The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

  • status_reason(Option<String>):

    The reason for the reported status.

  • preferred_maintenance_window(Option<String>):

    Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

  • pending_maintenance(Option<PendingMaintenance>):

    Indicates the pending maintenance scheduled on this environment.

• On failure, responds with SdkError<GetEnvironmentError>

pub fn list_applications(&self) -> ListApplications

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

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

    A pagination token to control the number of applications displayed in the list.

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

    The maximum number of applications to return.

  • names(Vec<String>) / set_names(Option<Vec<String>>):

    The names of the applications.

  • environment_id(impl Into<String>) / set_environment_id(Option<String>):

    The unique identifier of the runtime environment where the applications are deployed.

• On success, responds with ListApplicationsOutput with field(s):
  • applications(Option<Vec<ApplicationSummary>>):

    Returns a list of summary details for all the applications in an environment.

  • next_token(Option<String>):

    A pagination token that’s returned when the response doesn’t contain all applications.

• On failure, responds with SdkError<ListApplicationsError>

pub fn list_application_versions(&self) -> ListApplicationVersions

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

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

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

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

    The maximum number of application versions to return.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The unique identifier of the application.

• On success, responds with ListApplicationVersionsOutput with field(s):
  • application_versions(Option<Vec<ApplicationVersionSummary>>):

    The list of application versions.

  • next_token(Option<String>):

    If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

• On failure, responds with SdkError<ListApplicationVersionsError>

pub fn list_batch_job_definitions(&self) -> ListBatchJobDefinitions

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

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

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

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

    The maximum number of batch job definitions to return.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The identifier of the application.

  • prefix(impl Into<String>) / set_prefix(Option<String>):

    If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

• On success, responds with ListBatchJobDefinitionsOutput with field(s):
  • batch_job_definitions(Option<Vec<BatchJobDefinition>>):

    The list of batch job definitions.

  • next_token(Option<String>):

    If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

• On failure, responds with SdkError<ListBatchJobDefinitionsError>

pub fn list_batch_job_executions(&self) -> ListBatchJobExecutions

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

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

    A pagination token to control the number of batch job executions displayed in the list.

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

    The maximum number of batch job executions to return.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The unique identifier of the application.

  • execution_ids(Vec<String>) / set_execution_ids(Option<Vec<String>>):

    The unique identifier of each batch job execution.

  • job_name(impl Into<String>) / set_job_name(Option<String>):

    The name of each batch job execution.

  • status(BatchJobExecutionStatus) / set_status(Option<BatchJobExecutionStatus>):

    The status of the batch job executions.

  • started_after(DateTime) / set_started_after(Option<DateTime>):

    The time after which the batch job executions started.

  • started_before(DateTime) / set_started_before(Option<DateTime>):

    The time before the batch job executions started.

• On success, responds with ListBatchJobExecutionsOutput with field(s):
  • batch_job_executions(Option<Vec<BatchJobExecutionSummary>>):

    Returns a list of batch job executions for an application.

  • next_token(Option<String>):

    A pagination token that’s returned when the response doesn’t contain all batch job executions.

• On failure, responds with SdkError<ListBatchJobExecutionsError>

pub fn list_data_set_import_history(&self) -> ListDataSetImportHistory

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

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

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

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

    The maximum number of objects to return.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The unique identifier of the application.

• On success, responds with ListDataSetImportHistoryOutput with field(s):
  • data_set_import_tasks(Option<Vec<DataSetImportTask>>):

    The data set import tasks.

  • next_token(Option<String>):

    If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

• On failure, responds with SdkError<ListDataSetImportHistoryError>

pub fn list_data_sets(&self) -> ListDataSets

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

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

    The unique identifier of the application for which you want to list the associated data sets.

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

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

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

    The maximum number of objects to return.

  • prefix(impl Into<String>) / set_prefix(Option<String>):

    The prefix of the data set name, which you can use to filter the list of data sets.

• On success, responds with ListDataSetsOutput with field(s):
  • data_sets(Option<Vec<DataSetSummary>>):

    The list of data sets, containing ionformation including the creating time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.

  • next_token(Option<String>):

    If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

• On failure, responds with SdkError<ListDataSetsError>

pub fn list_deployments(&self) -> ListDeployments

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

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

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

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

    The maximum number of objects to return.

  • application_id(impl Into<String>) / set_application_id(Option<String>):

    The application identifier.

• On success, responds with ListDeploymentsOutput with field(s):
  • deployments(Option<Vec<DeploymentSummary>>):

    The list of deployments that is returned.

  • next_token(Option<String>):

    If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

• On failure, responds with SdkError<ListDeploymentsError>

pub fn list_engine_versions(&self) -> ListEngineVersions

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

• The fluent builder is configurable:
  • engine_type(EngineType) / set_engine_type(Option<EngineType>):

    The type of target platform.

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

    A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.

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

    The maximum number of objects to return.

• On success, responds with ListEngineVersionsOutput with field(s):
  • engine_versions(Option<Vec<EngineVersionsSummary>>):

    Returns the engine versions.

  • next_token(Option<String>):

    If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.

• On failure, responds with SdkError<ListEngineVersionsError>

pub fn list_environments(&self) -> ListEnvironments

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 pagination token to control the number of environments displayed in the list.

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

    The maximum number of environments to return.

  • names(Vec<String>) / set_names(Option<Vec<String>>):

    The name of the environment.

  • engine_type(EngineType) / set_engine_type(Option<EngineType>):

    The engine type for the environment.

• On success, responds with ListEnvironmentsOutput with field(s):
  • environments(Option<Vec<EnvironmentSummary>>):

    Returns a list of summary details for all the environments in your account.

  • next_token(Option<String>):

    A pagination token that’s returned when the response doesn’t contain all the environments.

• On failure, responds with SdkError<ListEnvironmentsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The tags for the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

pub fn start_application(&self) -> StartApplication

Constructs a fluent builder for the StartApplication operation.

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

    The unique identifier of the application you want to start.

• On success, responds with StartApplicationOutput
• On failure, responds with SdkError<StartApplicationError>

pub fn start_batch_job(&self) -> StartBatchJob

Constructs a fluent builder for the StartBatchJob operation.

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

    The unique identifier of the application associated with this batch job.

  • batch_job_identifier(BatchJobIdentifier) / set_batch_job_identifier(Option<BatchJobIdentifier>):

    The unique identifier of the batch job.

  • job_params(HashMap<String, String>) / set_job_params(Option<HashMap<String, String>>):

    The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.

• On success, responds with StartBatchJobOutput with field(s):
  • execution_id(Option<String>):

    The unique identifier of this execution of the batch job.

• On failure, responds with SdkError<StartBatchJobError>

pub fn stop_application(&self) -> StopApplication

Constructs a fluent builder for the StopApplication operation.

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

    The unique identifier of the application you want to stop.

  • force_stop(bool) / set_force_stop(bool):

    Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don’t need to wait until the process finishes to apply another action on the application. The default value is false.

• On success, responds with StopApplicationOutput
• On failure, responds with SdkError<StopApplicationError>

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags to add to the resource.

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

pub fn untag_resource(&self) -> UntagResource

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.

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

    The keys of the tags to remove.

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

pub fn update_application(&self) -> UpdateApplication

Constructs a fluent builder for the UpdateApplication operation.

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

    The unique identifier of the application you want to update.

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

    The description of the application to update.

  • current_application_version(i32) / set_current_application_version(Option<i32>):

    The current version of the application to update.

  • definition(Definition) / set_definition(Option<Definition>):

    The application definition for this application. You can specify either inline JSON or an S3 bucket location.

• On success, responds with UpdateApplicationOutput with field(s):
  • application_version(Option<i32>):

    The new version of the application.

• On failure, responds with SdkError<UpdateApplicationError>

pub fn update_environment(&self) -> UpdateEnvironment

Constructs a fluent builder for the UpdateEnvironment operation.

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

    The unique identifier of the runtime environment that you want to update.

  • desired_capacity(i32) / set_desired_capacity(Option<i32>):

    The desired capacity for the environment to update.

  • instance_type(impl Into<String>) / set_instance_type(Option<String>):

    The instance type for the environment to update.

  • engine_version(impl Into<String>) / set_engine_version(Option<String>):

    The version of the runtime engine for the environment.

  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):

    Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

  • apply_during_maintenance_window(bool) / set_apply_during_maintenance_window(bool):

    Indicates whether to update the environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

• On success, responds with UpdateEnvironmentOutput with field(s):
  • environment_id(Option<String>):

    The unique identifier of the runtime environment that was updated.

• On failure, responds with SdkError<UpdateEnvironmentError>

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.

Examples found in repository

src/client.rs (line 3926)

    pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }

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.