Client

emrserverless

R Documentation

EMR Serverless¶

Description¶

Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running analytics applications using the latest open source frameworks such as Apache Spark and Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize, secure, or operate clusters to run applications with these frameworks.

The API reference to Amazon EMR Serverless is emr-serverless. The emr-serverless prefix is used in the following scenarios:

It is the prefix in the CLI commands for Amazon EMR Serverless. For example, ⁠aws emr-serverless start-job-run⁠.
It is the prefix before IAM policy actions for Amazon EMR Serverless. For example, ⁠"Action": ["emr-serverless:StartJobRun"]⁠. For more information, see Policy actions for Amazon EMR Serverless.
It is the prefix used in Amazon EMR Serverless service endpoints. For example, ⁠emr-serverless.us-east-2.amazonaws.com⁠.

Usage¶

emrserverless(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- emrserverless(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

cancel_job_run: Cancels a job run
create_application: Creates an application
delete_application: Deletes an application
get_application: Displays detailed information about a specified application
get_dashboard_for_job_run: Creates and returns a URL that you can use to access the application UIs for a job run
get_job_run: Displays detailed information about a job run
list_applications: Lists applications based on a set of parameters
list_job_run_attempts: Lists all attempt of a job run
list_job_runs: Lists job runs based on a set of parameters
list_tags_for_resource: Lists the tags assigned to the resources
start_application: Starts a specified application and initializes initial capacity if configured
start_job_run: Starts a job run
stop_application: Stops a specified application and releases initial capacity if configured
tag_resource: Assigns tags to resources
untag_resource: Removes tags from resources
update_application: Updates a specified application

Examples¶

## Not run: 
svc <- emrserverless()
svc$cancel_job_run(
  Foo = 123
)

## End(Not run)