Struct aws_sdk_m2::client::Client
source · pub struct Client { /* private fields */ }
Expand description
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.
§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_m2::Client::new(&config);
Occasionally, SDKs may have additional service-specific values 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_m2::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 ListEngineVersions
operation has
a Client::list_engine_versions
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.list_engine_versions()
.engine_type("example")
.send()
.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§
source§impl Client
impl Client
sourcepub fn cancel_batch_job_execution(&self) -> CancelBatchJobExecutionFluentBuilder
pub fn cancel_batch_job_execution(&self) -> CancelBatchJobExecutionFluentBuilder
Constructs a fluent builder for the CancelBatchJobExecution
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
execution_id(impl Into<String>)
/set_execution_id(Option<String>)
:
required: trueThe unique identifier of the batch job execution.
- On success, responds with
CancelBatchJobExecutionOutput
- On failure, responds with
SdkError<CancelBatchJobExecutionError>
source§impl Client
impl Client
sourcepub fn create_application(&self) -> CreateApplicationFluentBuilder
pub fn create_application(&self) -> CreateApplicationFluentBuilder
Constructs a fluent builder for the CreateApplication
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe unique identifier of the application.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the application.
engine_type(EngineType)
/set_engine_type(Option<EngineType>)
:
required: trueThe type of the target platform for this application.
definition(Definition)
/set_definition(Option<Definition>)
:
required: trueThe application definition for this application. You can specify either inline JSON or an S3 bucket location.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of tags to apply to the application.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseUnique, 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.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe identifier of a customer managed key.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources that are not part of the application or are in a different Amazon Web Services account.
- On success, responds with
CreateApplicationOutput
with field(s):application_arn(String)
:The Amazon Resource Name (ARN) of the application.
application_id(String)
:The unique application identifier.
application_version(i32)
:The version number of the application.
- On failure, responds with
SdkError<CreateApplicationError>
source§impl Client
impl Client
sourcepub fn create_data_set_import_task(
&self
) -> CreateDataSetImportTaskFluentBuilder
pub fn create_data_set_import_task( &self ) -> CreateDataSetImportTaskFluentBuilder
Constructs a fluent builder for the CreateDataSetImportTask
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application for which you want to import data sets.
import_config(DataSetImportConfig)
/set_import_config(Option<DataSetImportConfig>)
:
required: trueThe data set import task configuration.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseUnique, 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(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>
source§impl Client
impl Client
sourcepub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe identifier of the runtime environment where you want to deploy this application.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe application identifier.
application_version(i32)
/set_application_version(Option<i32>)
:
required: trueThe version of the application to deploy.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseUnique, 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(String)
:The unique identifier of the deployment.
- On failure, responds with
SdkError<CreateDeploymentError>
source§impl Client
impl Client
sourcepub fn create_environment(&self) -> CreateEnvironmentFluentBuilder
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>)
:
required: trueThe name of the runtime environment. Must be unique within the account.
instance_type(impl Into<String>)
/set_instance_type(Option<String>)
:
required: trueThe type of instance for the runtime environment.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the runtime environment.
engine_type(EngineType)
/set_engine_type(Option<EngineType>)
:
required: trueThe engine type for the runtime environment.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:
required: falseThe version of the engine type for the runtime environment.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: falseThe list of subnets associated with the VPC for this runtime environment.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseThe list of security groups for the VPC associated with this runtime environment.
storage_configurations(StorageConfiguration)
/set_storage_configurations(Option<Vec::<StorageConfiguration>>)
:
required: falseOptional. The storage configurations for this runtime environment.
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:
required: falseSpecifies whether the runtime environment is publicly accessible.
high_availability_config(HighAvailabilityConfig)
/set_high_availability_config(Option<HighAvailabilityConfig>)
:
required: falseThe details of a high availability configuration for this runtime environment.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags for the runtime environment.
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:
required: falseConfigures the maintenance window that you want for the runtime environment. The maintenance window must have the format
ddd:hh24:mi-ddd:hh24:mi
and must be less than 24 hours. The following two examples are valid maintenance windows:sun:23:45-mon:00:15
orsat:01:00-sat:03:00
.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>)
:
required: falseUnique, 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.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe identifier of a customer managed key.
- On success, responds with
CreateEnvironmentOutput
with field(s):environment_id(String)
:The unique identifier of the runtime environment.
- On failure, responds with
SdkError<CreateEnvironmentError>
source§impl Client
impl Client
sourcepub fn delete_application(&self) -> DeleteApplicationFluentBuilder
pub fn delete_application(&self) -> DeleteApplicationFluentBuilder
Constructs a fluent builder for the DeleteApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application you want to delete.
- On success, responds with
DeleteApplicationOutput
- On failure, responds with
SdkError<DeleteApplicationError>
source§impl Client
impl Client
sourcepub fn delete_application_from_environment(
&self
) -> DeleteApplicationFromEnvironmentFluentBuilder
pub fn delete_application_from_environment( &self ) -> DeleteApplicationFromEnvironmentFluentBuilder
Constructs a fluent builder for the DeleteApplicationFromEnvironment
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application you want to delete.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe unique identifier of the runtime environment where the application was previously deployed.
- On success, responds with
DeleteApplicationFromEnvironmentOutput
- On failure, responds with
SdkError<DeleteApplicationFromEnvironmentError>
source§impl Client
impl Client
sourcepub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder
pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder
Constructs a fluent builder for the DeleteEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe unique identifier of the runtime environment you want to delete.
- On success, responds with
DeleteEnvironmentOutput
- On failure, responds with
SdkError<DeleteEnvironmentError>
source§impl Client
impl Client
sourcepub fn get_application(&self) -> GetApplicationFluentBuilder
pub fn get_application(&self) -> GetApplicationFluentBuilder
Constructs a fluent builder for the GetApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application.
- On success, responds with
GetApplicationOutput
with field(s):name(String)
:The unique identifier of the application.
description(Option<String>)
:The description of the application.
application_id(String)
:The identifier of the application.
application_arn(String)
:The Amazon Resource Name (ARN) of the application.
status(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(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. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer’s account.
creation_time(DateTime)
:The timestamp when this application was created.
last_start_time(Option<DateTime>)
:The timestamp when you last started the application. Null until the application runs 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 runtime environment where you want to deploy the application.
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 for you 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.
kms_key_id(Option<String>)
:The identifier of a customer managed key.
role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the role associated with the application.
- On failure, responds with
SdkError<GetApplicationError>
source§impl Client
impl Client
sourcepub fn get_application_version(&self) -> GetApplicationVersionFluentBuilder
pub fn get_application_version(&self) -> GetApplicationVersionFluentBuilder
Constructs a fluent builder for the GetApplicationVersion
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
application_version(i32)
/set_application_version(Option<i32>)
:
required: trueThe specific version of the application.
- On success, responds with
GetApplicationVersionOutput
with field(s):name(String)
:The name of the application version.
application_version(i32)
:The specific version of the application.
description(Option<String>)
:The application description.
definition_content(String)
:The content of the application definition. This is a JSON object that contains the resource configuration and definitions that identify an application.
status(ApplicationVersionLifecycle)
:The status of the application version.
creation_time(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>
source§impl Client
impl Client
sourcepub fn get_batch_job_execution(&self) -> GetBatchJobExecutionFluentBuilder
pub fn get_batch_job_execution(&self) -> GetBatchJobExecutionFluentBuilder
Constructs a fluent builder for the GetBatchJobExecution
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application.
execution_id(impl Into<String>)
/set_execution_id(Option<String>)
:
required: trueThe unique identifier of the batch job execution.
- On success, responds with
GetBatchJobExecutionOutput
with field(s):execution_id(String)
:The unique identifier for this batch job execution.
application_id(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(BatchJobExecutionStatus)
:The status of the batch job execution.
start_time(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.
return_code(Option<String>)
:The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.
batch_job_identifier(Option<BatchJobIdentifier>)
:The unique identifier of this batch job.
job_step_restart_marker(Option<JobStepRestartMarker>)
:The restart steps information for the most recent restart operation.
- On failure, responds with
SdkError<GetBatchJobExecutionError>
source§impl Client
impl Client
sourcepub fn get_data_set_details(&self) -> GetDataSetDetailsFluentBuilder
pub fn get_data_set_details(&self) -> GetDataSetDetailsFluentBuilder
Constructs a fluent builder for the GetDataSetDetails
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application that this data set is associated with.
data_set_name(impl Into<String>)
/set_data_set_name(Option<String>)
:
required: trueThe name of the data set.
- On success, responds with
GetDataSetDetailsOutput
with field(s):data_set_name(String)
:The name of the data set.
data_set_org(Option<DatasetDetailOrgAttributes>)
:The type of data set. The only supported value is VSAM.
record_length(Option<i32>)
:The length of records in the data set.
location(Option<String>)
:The location 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.
file_size(Option<i64>)
:File size of the dataset.
- On failure, responds with
SdkError<GetDataSetDetailsError>
source§impl Client
impl Client
sourcepub fn get_data_set_import_task(&self) -> GetDataSetImportTaskFluentBuilder
pub fn get_data_set_import_task(&self) -> GetDataSetImportTaskFluentBuilder
Constructs a fluent builder for the GetDataSetImportTask
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe application identifier.
task_id(impl Into<String>)
/set_task_id(Option<String>)
:
required: trueThe task identifier returned by the
CreateDataSetImportTask
operation.
- On success, responds with
GetDataSetImportTaskOutput
with field(s):task_id(String)
:The task identifier.
status(DataSetTaskLifecycle)
:The status of the task.
summary(Option<DataSetImportSummary>)
:A summary of the status of the task.
- On failure, responds with
SdkError<GetDataSetImportTaskError>
source§impl Client
impl Client
sourcepub fn get_deployment(&self) -> GetDeploymentFluentBuilder
pub fn get_deployment(&self) -> GetDeploymentFluentBuilder
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe unique identifier for the deployment.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
- On success, responds with
GetDeploymentOutput
with field(s):deployment_id(String)
:The unique identifier of the deployment.
application_id(String)
:The unique identifier of the application.
environment_id(String)
:The unique identifier of the runtime environment.
application_version(i32)
:The application version.
status(DeploymentLifecycle)
:The status of the deployment.
creation_time(DateTime)
:The timestamp when the deployment was created.
status_reason(Option<String>)
:The reason for the reported status.
- On failure, responds with
SdkError<GetDeploymentError>
source§impl Client
impl Client
sourcepub fn get_environment(&self) -> GetEnvironmentFluentBuilder
pub fn get_environment(&self) -> GetEnvironmentFluentBuilder
Constructs a fluent builder for the GetEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe unique identifier of the runtime environment.
- On success, responds with
GetEnvironmentOutput
with field(s):name(String)
:The name of the runtime environment. Must be unique within the account.
description(Option<String>)
:The description of the runtime environment.
environment_arn(String)
:The Amazon Resource Name (ARN) of the runtime environment.
environment_id(String)
:The unique identifier of the runtime environment.
instance_type(String)
:The type of instance underlying the runtime environment.
status(EnvironmentLifecycle)
:The status of the runtime environment.
engine_type(EngineType)
:The target platform for the runtime environment.
engine_version(String)
:The version of the runtime engine.
vpc_id(String)
:The unique identifier for the VPC used with this runtime environment.
subnet_ids(Vec::<String>)
:The unique identifiers of the subnets assigned to this runtime environment.
security_group_ids(Vec::<String>)
:The unique identifiers of the security groups assigned to this runtime environment.
creation_time(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 maximum 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>)
:The maintenance window for the runtime environment. If you don’t provide a value for the maintenance window, the service assigns a random value.
pending_maintenance(Option<PendingMaintenance>)
:Indicates the pending maintenance scheduled on this environment.
kms_key_id(Option<String>)
:The identifier of a customer managed key.
- On failure, responds with
SdkError<GetEnvironmentError>
source§impl Client
impl Client
sourcepub fn get_signed_bluinsights_url(&self) -> GetSignedBluinsightsUrlFluentBuilder
pub fn get_signed_bluinsights_url(&self) -> GetSignedBluinsightsUrlFluentBuilder
Constructs a fluent builder for the GetSignedBluinsightsUrl
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetSignedBluinsightsUrlOutput
with field(s):signed_bi_url(String)
:Single sign-on AWS Blu Insights URL.
- On failure, responds with
SdkError<GetSignedBluinsightsUrlError>
source§impl Client
impl Client
sourcepub fn list_application_versions(&self) -> ListApplicationVersionsFluentBuilder
pub fn list_application_versions(&self) -> ListApplicationVersionsFluentBuilder
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>)
:
required: falseA 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>)
:
required: falseThe maximum number of application versions to return.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
- On success, responds with
ListApplicationVersionsOutput
with field(s):application_versions(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>
source§impl Client
impl Client
sourcepub fn list_applications(&self) -> ListApplicationsFluentBuilder
pub fn list_applications(&self) -> ListApplicationsFluentBuilder
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>)
:
required: falseA pagination token to control the number of applications displayed in the list.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of applications to return.
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: falseThe names of the applications.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: falseThe unique identifier of the runtime environment where the applications are deployed.
- On success, responds with
ListApplicationsOutput
with field(s):applications(Vec::<ApplicationSummary>)
:Returns a list of summary details for all the applications in a runtime 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>
source§impl Client
impl Client
sourcepub fn list_batch_job_definitions(&self) -> ListBatchJobDefinitionsFluentBuilder
pub fn list_batch_job_definitions(&self) -> ListBatchJobDefinitionsFluentBuilder
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>)
:
required: falseA 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>)
:
required: falseThe maximum number of batch job definitions to return.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe identifier of the application.
prefix(impl Into<String>)
/set_prefix(Option<String>)
:
required: falseIf 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(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>
source§impl Client
impl Client
sourcepub fn list_batch_job_executions(&self) -> ListBatchJobExecutionsFluentBuilder
pub fn list_batch_job_executions(&self) -> ListBatchJobExecutionsFluentBuilder
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>)
:
required: falseA pagination token to control the number of batch job executions displayed in the list.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of batch job executions to return.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
execution_ids(impl Into<String>)
/set_execution_ids(Option<Vec::<String>>)
:
required: falseThe unique identifier of each batch job execution.
job_name(impl Into<String>)
/set_job_name(Option<String>)
:
required: falseThe name of each batch job execution.
status(BatchJobExecutionStatus)
/set_status(Option<BatchJobExecutionStatus>)
:
required: falseThe status of the batch job executions.
started_after(DateTime)
/set_started_after(Option<DateTime>)
:
required: falseThe time after which the batch job executions started.
started_before(DateTime)
/set_started_before(Option<DateTime>)
:
required: falseThe time before the batch job executions started.
- On success, responds with
ListBatchJobExecutionsOutput
with field(s):batch_job_executions(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>
source§impl Client
impl Client
sourcepub fn list_batch_job_restart_points(
&self
) -> ListBatchJobRestartPointsFluentBuilder
pub fn list_batch_job_restart_points( &self ) -> ListBatchJobRestartPointsFluentBuilder
Constructs a fluent builder for the ListBatchJobRestartPoints
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
execution_id(impl Into<String>)
/set_execution_id(Option<String>)
:
required: trueThe unique identifier of each batch job execution.
- On success, responds with
ListBatchJobRestartPointsOutput
with field(s):batch_job_steps(Option<Vec::<JobStep>>)
:Returns all the batch job steps and related information for a batch job that previously ran.
- On failure, responds with
SdkError<ListBatchJobRestartPointsError>
source§impl Client
impl Client
sourcepub fn list_data_set_import_history(
&self
) -> ListDataSetImportHistoryFluentBuilder
pub fn list_data_set_import_history( &self ) -> ListDataSetImportHistoryFluentBuilder
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>)
:
required: falseA 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>)
:
required: falseThe maximum number of objects to return.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application.
- On success, responds with
ListDataSetImportHistoryOutput
with field(s):data_set_import_tasks(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>
source§impl Client
impl Client
sourcepub fn list_data_sets(&self) -> ListDataSetsFluentBuilder
pub fn list_data_sets(&self) -> ListDataSetsFluentBuilder
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>)
:
required: trueThe 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>)
:
required: falseA 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>)
:
required: falseThe maximum number of objects to return.
prefix(impl Into<String>)
/set_prefix(Option<String>)
:
required: falseThe prefix of the data set name, which you can use to filter the list of data sets.
name_filter(impl Into<String>)
/set_name_filter(Option<String>)
:
required: falseFilter dataset name matching the specified pattern. Can use * and % as wild cards.
- On success, responds with
ListDataSetsOutput
with field(s):data_sets(Vec::<DataSetSummary>)
:The list of data sets, containing information including the creation 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>
source§impl Client
impl Client
sourcepub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
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>)
:
required: falseA 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>)
:
required: falseThe maximum number of objects to return.
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe application identifier.
- On success, responds with
ListDeploymentsOutput
with field(s):deployments(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>
source§impl Client
impl Client
sourcepub fn list_engine_versions(&self) -> ListEngineVersionsFluentBuilder
pub fn list_engine_versions(&self) -> ListEngineVersionsFluentBuilder
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>)
:
required: falseThe type of target platform.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA 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>)
:
required: falseThe maximum number of objects to return.
- On success, responds with
ListEngineVersionsOutput
with field(s):engine_versions(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>
source§impl Client
impl Client
sourcepub fn list_environments(&self) -> ListEnvironmentsFluentBuilder
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>)
:
required: falseA pagination token to control the number of runtime environments displayed in the list.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of runtime environments to return.
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: falseThe names of the runtime environments. Must be unique within the account.
engine_type(EngineType)
/set_engine_type(Option<EngineType>)
:
required: falseThe engine type for the runtime environment.
- On success, responds with
ListEnvironmentsOutput
with field(s):environments(Vec::<EnvironmentSummary>)
:Returns a list of summary details for all the runtime environments in your account.
next_token(Option<String>)
:A pagination token that’s returned when the response doesn’t contain all the runtime environments.
- On failure, responds with
SdkError<ListEnvironmentsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(HashMap::<String, String>)
:The tags for the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn start_application(&self) -> StartApplicationFluentBuilder
pub fn start_application(&self) -> StartApplicationFluentBuilder
Constructs a fluent builder for the StartApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application you want to start.
- On success, responds with
StartApplicationOutput
- On failure, responds with
SdkError<StartApplicationError>
source§impl Client
impl Client
sourcepub fn start_batch_job(&self) -> StartBatchJobFluentBuilder
pub fn start_batch_job(&self) -> StartBatchJobFluentBuilder
Constructs a fluent builder for the StartBatchJob
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application associated with this batch job.
batch_job_identifier(BatchJobIdentifier)
/set_batch_job_identifier(Option<BatchJobIdentifier>)
:
required: trueThe unique identifier of the batch job.
job_params(impl Into<String>, impl Into<String>)
/set_job_params(Option<HashMap::<String, String>>)
:
required: falseThe 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(String)
:The unique identifier of this execution of the batch job.
- On failure, responds with
SdkError<StartBatchJobError>
source§impl Client
impl Client
sourcepub fn stop_application(&self) -> StopApplicationFluentBuilder
pub fn stop_application(&self) -> StopApplicationFluentBuilder
Constructs a fluent builder for the StopApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application you want to stop.
force_stop(bool)
/set_force_stop(Option<bool>)
:
required: falseStopping 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>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe tags to add to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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>)
:
required: trueThe Amazon Resource Name (ARN) of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe keys of the tags to remove.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_application(&self) -> UpdateApplicationFluentBuilder
pub fn update_application(&self) -> UpdateApplicationFluentBuilder
Constructs a fluent builder for the UpdateApplication
operation.
- The fluent builder is configurable:
application_id(impl Into<String>)
/set_application_id(Option<String>)
:
required: trueThe unique identifier of the application you want to update.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the application to update.
current_application_version(i32)
/set_current_application_version(Option<i32>)
:
required: trueThe current version of the application to update.
definition(Definition)
/set_definition(Option<Definition>)
:
required: falseThe 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(i32)
:The new version of the application.
- On failure, responds with
SdkError<UpdateApplicationError>
source§impl Client
impl Client
sourcepub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder
pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder
Constructs a fluent builder for the UpdateEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe unique identifier of the runtime environment that you want to update.
desired_capacity(i32)
/set_desired_capacity(Option<i32>)
:
required: falseThe desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.
instance_type(impl Into<String>)
/set_instance_type(Option<String>)
:
required: falseThe instance type for the runtime environment to update.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:
required: falseThe version of the runtime engine for the runtime environment.
preferred_maintenance_window(impl Into<String>)
/set_preferred_maintenance_window(Option<String>)
:
required: falseConfigures the maintenance window that you want for the runtime environment. The maintenance window must have the format
ddd:hh24:mi-ddd:hh24:mi
and must be less than 24 hours. The following two examples are valid maintenance windows:sun:23:45-mon:00:15
orsat:01:00-sat:03:00
.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(Option<bool>)
:
required: falseIndicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the
engineVersion
parameter only ifapplyDuringMaintenanceWindow
is true. If any parameter other thanengineVersion
is provided inUpdateEnvironmentRequest
, it will fail ifapplyDuringMaintenanceWindow
is set to true.force_update(bool)
/set_force_update(Option<bool>)
:
required: falseForces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.
If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.
This option is not needed if the attribute being updated is
preferredMaintenanceWindow
.
- On success, responds with
UpdateEnvironmentOutput
with field(s):environment_id(String)
:The unique identifier of the runtime environment that was updated.
- On failure, responds with
SdkError<UpdateEnvironmentError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more