Struct aws_sdk_emrserverless::client::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.

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_emrserverless::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_emrserverless::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_emrserverless::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_job_run(&self) -> CancelJobRun

Constructs a fluent builder for the CancelJobRun operation.

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

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

    The ID of the job run to cancel.

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

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

  • job_run_id(Option<String>):

    The output contains the ID of the cancelled job run.

• On failure, responds with SdkError<CancelJobRunError>

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 name of the application.

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

    The EMR release version associated with the application.

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

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

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

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

  • initial_capacity(HashMap<String, InitialCapacityConfig>) / set_initial_capacity(Option<HashMap<String, InitialCapacityConfig>>):

    The capacity to initialize when the application is created.

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

    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(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The tags assigned to the application.

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

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

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

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

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

    The network configuration for customer VPC connectivity.

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

    The output contains the application ID.

  • name(Option<String>):

    The output contains the name of the application.

  • arn(Option<String>):

    The output contains the ARN of the application.

• On failure, responds with SdkError<CreateApplicationError>

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 ID of the application that will be deleted.

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

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

pub fn get_dashboard_for_job_run(&self) -> GetDashboardForJobRun

Constructs a fluent builder for the GetDashboardForJobRun operation.

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

    The ID of the application.

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

    The ID of the job run.

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

pub fn get_job_run(&self) -> GetJobRun

Constructs a fluent builder for the GetJobRun operation.

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

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

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

    The ID of the job run.

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

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

    The token for the next set of application results.

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

    The maximum number of applications that can be listed.

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

    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(Option<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>

pub fn list_job_runs(&self) -> ListJobRuns

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

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

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

    The token for the next set of job run results.

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

    The maximum number of job runs that can be listed.

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

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

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

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

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

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

• On success, responds with ListJobRunsOutput with field(s):
  • job_runs(Option<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>

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

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 ID of the application to start.

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

pub fn start_job_run(&self) -> StartJobRun

Constructs a fluent builder for the StartJobRun operation.

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

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

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

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

    The execution role ARN for the job run.

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

    The job driver for the job run.

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

    The configuration overrides for the job run.

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

    The tags assigned to the job run.

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

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

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

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

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

  • job_run_id(Option<String>):

    The output contains the ID of the started job run.

  • arn(Option<String>):

    The output lists the execution role ARN of the job run.

• On failure, responds with SdkError<StartJobRunError>

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 ID of the application to stop.

• 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) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

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

    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>

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) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

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

    The keys of the tags to be removed.

• 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 ID of the application to update.

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

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

  • initial_capacity(HashMap<String, InitialCapacityConfig>) / set_initial_capacity(Option<HashMap<String, InitialCapacityConfig>>):

    The capacity to initialize when the application is updated.

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

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

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

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

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

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

    The network configuration for customer VPC connectivity.

• 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 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 1915)

    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.