Learn R Programming

paws.analytics (version 0.7.0)

gluedatabrew: AWS Glue DataBrew

Description

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.

Usage

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

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.

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.

Service syntax

svc <- gluedatabrew(
  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

batch_delete_recipe_versionDeletes one or more versions of a recipe at a time
create_datasetCreates a new DataBrew dataset
create_profile_jobCreates a new job to analyze a dataset and create its data profile
create_projectCreates a new DataBrew project
create_recipeCreates a new DataBrew recipe
create_recipe_jobCreates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe
create_rulesetCreates a new ruleset that can be used in a profile job to validate the data quality of a dataset
create_scheduleCreates a new schedule for one or more DataBrew jobs
delete_datasetDeletes a dataset from DataBrew
delete_jobDeletes the specified DataBrew job
delete_projectDeletes an existing DataBrew project
delete_recipe_versionDeletes a single version of a DataBrew recipe
delete_rulesetDeletes a ruleset
delete_scheduleDeletes the specified DataBrew schedule
describe_datasetReturns the definition of a specific DataBrew dataset
describe_jobReturns the definition of a specific DataBrew job
describe_job_runRepresents one run of a DataBrew job
describe_projectReturns the definition of a specific DataBrew project
describe_recipeReturns the definition of a specific DataBrew recipe corresponding to a particular version
describe_rulesetRetrieves detailed information about the ruleset
describe_scheduleReturns the definition of a specific DataBrew schedule
list_datasetsLists all of the DataBrew datasets
list_job_runsLists all of the previous runs of a particular DataBrew job
list_jobsLists all of the DataBrew jobs that are defined
list_projectsLists all of the DataBrew projects that are defined
list_recipesLists all of the DataBrew recipes that are defined
list_recipe_versionsLists the versions of a particular DataBrew recipe, except for LATEST_WORKING
list_rulesetsList all rulesets available in the current account or rulesets associated with a specific resource (dataset)
list_schedulesLists the DataBrew schedules that are defined
list_tags_for_resourceLists all the tags for a DataBrew resource
publish_recipePublishes a new version of a DataBrew recipe
send_project_session_actionPerforms a recipe step within an interactive DataBrew session that's currently open
start_job_runRuns a DataBrew job
start_project_sessionCreates an interactive session, enabling you to manipulate data in a DataBrew project
stop_job_runStops a particular run of a job
tag_resourceAdds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule
untag_resourceRemoves metadata tags from a DataBrew resource
update_datasetModifies the definition of an existing DataBrew dataset
update_profile_jobModifies the definition of an existing profile job
update_projectModifies the definition of an existing DataBrew project
update_recipeModifies the definition of the LATEST_WORKING version of a DataBrew recipe
update_recipe_jobModifies the definition of an existing DataBrew recipe job
update_rulesetUpdates specified ruleset
update_scheduleModifies the definition of an existing DataBrew schedule

Examples

Run this code
if (FALSE) {
svc <- gluedatabrew()
svc$batch_delete_recipe_version(
  Foo = 123
)
}

Run the code above in your browser using DataLab