Struct Client

pub struct Client { /* private fields */ }

Client for EMR Serverless

Client for invoking operations on EMR Serverless. Each operation on EMR Serverless 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_emrserverless::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 Builder 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_emrserverless::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 CancelJobRun operation has a Client::cancel_job_run, 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.cancel_job_run()
    .application_id("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

impl Client

pub fn cancel_job_run(&self) -> CancelJobRunFluentBuilder

Constructs a fluent builder for the CancelJobRun operation.

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

    The ID of the application on which the job run will be canceled.

    
    
  • job_run_id(impl Into<String>) / set_job_run_id(Option<String>):
    required: true
    

    The ID of the job run to cancel.

    
    
• On success, responds with CancelJobRunOutput with field(s):
  • application_id(String):

    The output contains the application ID on which the job run is cancelled.

  • job_run_id(String):

    The output contains the ID of the cancelled job run.

• On failure, responds with SdkError<CancelJobRunError>

impl Client

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

    The name of the application.

    
    
  • release_label(impl Into<String>) / set_release_label(Option<String>):
    required: true
    

    The Amazon EMR release associated with the application.

    
    
  • r#type(impl Into<String>) / set_type(Option<String>):
    required: true
    

    The type of application you want to start, such as Spark or Hive.

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

    The client idempotency token of the application to create. Its value must be unique for each request.

    
    
  • initial_capacity(impl Into<String>, InitialCapacityConfig) / set_initial_capacity(Option<HashMap::<String, InitialCapacityConfig>>):
    required: false
    

    The capacity to initialize when the application is created.

    
    
  • maximum_capacity(MaximumAllowedResources) / set_maximum_capacity(Option<MaximumAllowedResources>):
    required: false
    

    The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags assigned to the application.

    
    
  • auto_start_configuration(AutoStartConfig) / set_auto_start_configuration(Option<AutoStartConfig>):
    required: false
    

    The configuration for an application to automatically start on job submission.

    
    
  • auto_stop_configuration(AutoStopConfig) / set_auto_stop_configuration(Option<AutoStopConfig>):
    required: false
    

    The configuration for an application to automatically stop after a certain amount of time being idle.

    
    
  • network_configuration(NetworkConfiguration) / set_network_configuration(Option<NetworkConfiguration>):
    required: false
    

    The network configuration for customer VPC connectivity.

    
    
  • architecture(Architecture) / set_architecture(Option<Architecture>):
    required: false
    

    The CPU architecture of an application.

    
    
  • image_configuration(ImageConfigurationInput) / set_image_configuration(Option<ImageConfigurationInput>):
    required: false
    

    The image configuration for all worker types. You can either set this parameter or imageConfiguration for each worker type in workerTypeSpecifications.

    
    
  • worker_type_specifications(impl Into<String>, WorkerTypeSpecificationInput) / set_worker_type_specifications(Option<HashMap::<String, WorkerTypeSpecificationInput>>):
    required: false
    

    The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

    
    
  • runtime_configuration(Configuration) / set_runtime_configuration(Option<Vec::<Configuration>>):
    required: false
    

    The Configuration specifications to use when creating an application. Each configuration consists of a classification and properties. This configuration is applied to all the job runs submitted under the application.

    
    
  • monitoring_configuration(MonitoringConfiguration) / set_monitoring_configuration(Option<MonitoringConfiguration>):
    required: false
    

    The configuration setting for monitoring.

    
    
  • interactive_configuration(InteractiveConfiguration) / set_interactive_configuration(Option<InteractiveConfiguration>):
    required: false
    

    The interactive configuration object that enables the interactive use cases to use when running an application.

    
    
  • scheduler_configuration(SchedulerConfiguration) / set_scheduler_configuration(Option<SchedulerConfiguration>):
    required: false
    

    The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.

    
    
• On success, responds with CreateApplicationOutput with field(s):
  • application_id(String):

    The output contains the application ID.

  • name(Option<String>):

    The output contains the name of the application.

  • arn(String):

    The output contains the ARN of the application.

• On failure, responds with SdkError<CreateApplicationError>

impl Client

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

    The ID of the application that will be deleted.

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

impl Client

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

    The ID of the application that will be described.

    
    
• On success, responds with GetApplicationOutput with field(s):
  • application(Option<Application>):

    The output displays information about the specified application.

• On failure, responds with SdkError<GetApplicationError>

impl Client

pub fn get_dashboard_for_job_run(&self) -> GetDashboardForJobRunFluentBuilder

Constructs a fluent builder for the GetDashboardForJobRun operation.

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

    The ID of the application.

    
    
  • job_run_id(impl Into<String>) / set_job_run_id(Option<String>):
    required: true
    

    The ID of the job run.

    
    
  • attempt(i32) / set_attempt(Option<i32>):
    required: false
    

    An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

    
    
  • access_system_profile_logs(bool) / set_access_system_profile_logs(Option<bool>):
    required: false
    

    Allows access to system profile logs for Lake Formation-enabled jobs. Default is false.

    
    
• On success, responds with GetDashboardForJobRunOutput with field(s):
  • url(Option<String>):

    The URL to view job run’s dashboard.

• On failure, responds with SdkError<GetDashboardForJobRunError>

impl Client

pub fn get_job_run(&self) -> GetJobRunFluentBuilder

Constructs a fluent builder for the GetJobRun operation.

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

    The ID of the application on which the job run is submitted.

    
    
  • job_run_id(impl Into<String>) / set_job_run_id(Option<String>):
    required: true
    

    The ID of the job run.

    
    
  • attempt(i32) / set_attempt(Option<i32>):
    required: false
    

    An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

    
    
• On success, responds with GetJobRunOutput with field(s):
  • job_run(Option<JobRun>):

    The output displays information about the job run.

• On failure, responds with SdkError<GetJobRunError>

impl Client

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

    The token for the next set of application results.

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

    The maximum number of applications that can be listed.

    
    
  • states(ApplicationState) / set_states(Option<Vec::<ApplicationState>>):
    required: false
    

    An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

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

    The output lists the specified applications.

  • next_token(Option<String>):

    The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.

• On failure, responds with SdkError<ListApplicationsError>

impl Client

pub fn list_job_run_attempts(&self) -> ListJobRunAttemptsFluentBuilder

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

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

    The ID of the application for which to list job runs.

    
    
  • job_run_id(impl Into<String>) / set_job_run_id(Option<String>):
    required: true
    

    The ID of the job run to list.

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

    The token for the next set of job run attempt results.

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

    The maximum number of job run attempts to list.

    
    
• On success, responds with ListJobRunAttemptsOutput with field(s):
  • job_run_attempts(Vec::<JobRunAttemptSummary>):

    The array of the listed job run attempt objects.

  • next_token(Option<String>):

    The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.

• On failure, responds with SdkError<ListJobRunAttemptsError>

impl Client

pub fn list_job_runs(&self) -> ListJobRunsFluentBuilder

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

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

    The ID of the application for which to list the job run.

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

    The token for the next set of job run results.

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

    The maximum number of job runs that can be listed.

    
    
  • created_at_after(DateTime) / set_created_at_after(Option<DateTime>):
    required: false
    

    The lower bound of the option to filter by creation date and time.

    
    
  • created_at_before(DateTime) / set_created_at_before(Option<DateTime>):
    required: false
    

    The upper bound of the option to filter by creation date and time.

    
    
  • states(JobRunState) / set_states(Option<Vec::<JobRunState>>):
    required: false
    

    An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

    
    
  • mode(JobRunMode) / set_mode(Option<JobRunMode>):
    required: false
    

    The mode of the job runs to list.

    
    
• On success, responds with ListJobRunsOutput with field(s):
  • job_runs(Vec::<JobRunSummary>):

    The output lists information about the specified job runs.

  • next_token(Option<String>):

    The output displays the token for the next set of job run results. This is required for pagination and is available as a response of the previous request.

• On failure, responds with SdkError<ListJobRunsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

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

    The tags for the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

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

    The ID of the application to start.

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

impl Client

pub fn start_job_run(&self) -> StartJobRunFluentBuilder

Constructs a fluent builder for the StartJobRun operation.

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

    The ID of the application on which to run the job.

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

    The client idempotency token of the job run to start. Its value must be unique for each request.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: true
    

    The execution role ARN for the job run.

    
    
  • job_driver(JobDriver) / set_job_driver(Option<JobDriver>):
    required: false
    

    The job driver for the job run.

    
    
  • configuration_overrides(ConfigurationOverrides) / set_configuration_overrides(Option<ConfigurationOverrides>):
    required: false
    

    The configuration overrides for the job run.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags assigned to the job run.

    
    
  • execution_timeout_minutes(i64) / set_execution_timeout_minutes(Option<i64>):
    required: false
    

    The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The optional job run name. This doesn’t have to be unique.

    
    
  • mode(JobRunMode) / set_mode(Option<JobRunMode>):
    required: false
    

    The mode of the job run when it starts.

    
    
  • retry_policy(RetryPolicy) / set_retry_policy(Option<RetryPolicy>):
    required: false
    

    The retry policy when job run starts.

    
    
• On success, responds with StartJobRunOutput with field(s):
  • application_id(String):

    This output displays the application ID on which the job run was submitted.

  • job_run_id(String):

    The output contains the ID of the started job run.

  • arn(String):

    This output displays the ARN of the job run..

• On failure, responds with SdkError<StartJobRunError>

impl Client

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

    The ID of the application to stop.

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

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

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to add to the resource. A tag is an array of key-value pairs.

    
    
• 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>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to be removed.

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

impl Client

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

    The ID of the application to update.

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

    The client idempotency token of the application to update. Its value must be unique for each request.

    
    
  • initial_capacity(impl Into<String>, InitialCapacityConfig) / set_initial_capacity(Option<HashMap::<String, InitialCapacityConfig>>):
    required: false
    

    The capacity to initialize when the application is updated.

    
    
  • maximum_capacity(MaximumAllowedResources) / set_maximum_capacity(Option<MaximumAllowedResources>):
    required: false
    

    The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.

    
    
  • auto_start_configuration(AutoStartConfig) / set_auto_start_configuration(Option<AutoStartConfig>):
    required: false
    

    The configuration for an application to automatically start on job submission.

    
    
  • auto_stop_configuration(AutoStopConfig) / set_auto_stop_configuration(Option<AutoStopConfig>):
    required: false
    

    The configuration for an application to automatically stop after a certain amount of time being idle.

    
    
  • network_configuration(NetworkConfiguration) / set_network_configuration(Option<NetworkConfiguration>):
    required: false
    

    The network configuration for customer VPC connectivity.

    
    
  • architecture(Architecture) / set_architecture(Option<Architecture>):
    required: false
    

    The CPU architecture of an application.

    
    
  • image_configuration(ImageConfigurationInput) / set_image_configuration(Option<ImageConfigurationInput>):
    required: false
    

    The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration for each worker type in WorkerTypeSpecificationInput.

    
    
  • worker_type_specifications(impl Into<String>, WorkerTypeSpecificationInput) / set_worker_type_specifications(Option<HashMap::<String, WorkerTypeSpecificationInput>>):
    required: false
    

    The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

    
    
  • interactive_configuration(InteractiveConfiguration) / set_interactive_configuration(Option<InteractiveConfiguration>):
    required: false
    

    The interactive configuration object that contains new interactive use cases when the application is updated.

    
    
  • release_label(impl Into<String>) / set_release_label(Option<String>):
    required: false
    

    The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.

    
    
  • runtime_configuration(Configuration) / set_runtime_configuration(Option<Vec::<Configuration>>):
    required: false
    

    The Configuration specifications to use when updating an application. Each configuration consists of a classification and properties. This configuration is applied across all the job runs submitted under the application.

    
    
  • monitoring_configuration(MonitoringConfiguration) / set_monitoring_configuration(Option<MonitoringConfiguration>):
    required: false
    

    The configuration setting for monitoring.

    
    
  • scheduler_configuration(SchedulerConfiguration) / set_scheduler_configuration(Option<SchedulerConfiguration>):
    required: false
    

    The scheduler configuration for batch and streaming jobs running on this application. Supported with release labels emr-7.0.0 and above.

    
    
• On success, responds with UpdateApplicationOutput with field(s):
  • application(Option<Application>):

    Information about the updated application.

• On failure, responds with SdkError<UpdateApplicationError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.