PawsSession: PawsSession Class create connection to AWS utilizing paws.

In DyfanJones/sagemaker-r-local: Sagemaker core classes, methods and functions

PawsSession Class create connection to AWS utilizing paws.

Description

A session stores configuration state and allows you to create paws service clients.

Public fields

aws_access_key_id

aws access key

aws_secret_access_key

aws secret access key

aws_session_token

aws session token

region_name

Default region when creating new connections

profile_name

The name of a profile to use.

endpoint

The complete URL to use for the constructed client.

credentials

Formatted aws credentials to pass to paws objects

Methods

Public methods

• PawsSession$new()

• PawsSession$client()

• PawsSession$format()

• PawsSession$clone()

---

Method new()

Initialize PawsSession class

Usage

PawsSession$new(
  aws_access_key_id = NULL,
  aws_secret_access_key = NULL,
  aws_session_token = NULL,
  region_name = NULL,
  profile_name = NULL,
  endpoint = NULL,
  config = list()
)

Arguments

aws_access_key_id

(str): AWS access key ID

aws_secret_access_key

(str): AWS secret access key

aws_session_token

(str): AWS temporary session token

region_name

(str): Default region when creating new connections

profile_name

(str): The name of a profile to use. If not given, then the default profile is used.

endpoint

(str): The complete URL to use for the constructed client.

config

(list): Optional paws configuration of credentials, endpoint, and/or region.

---

Method client()

Create a low-level service client by name.

Usage

PawsSession$client(service_name, config = NULL)

Arguments

service_name

(str): The name of a service, e.g. 's3' or 'ec2'. A list of available services can be found https://paws-r.github.io/docs/

config

(list): Optional paws configuration of credentials, endpoint, and/or region.

---

Method format()

format class

Usage

PawsSession$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

PawsSession$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other Session: LocalSession, Session

DyfanJones/sagemaker-r-local documentation built on June 14, 2022, 10:32 p.m.