set_service_parameter: Set service parameters

In paws.common: Paws Low-Level Amazon Web Services API

Set service parameters

Description

Help functions for setting the parameters for services

Usage

config(
  credentials = list(creds = list(access_key_id = "", secret_access_key = "",
    session_token = "", access_token = "", expiration = Inf), profile = "", anonymous =
    FALSE),
  endpoint = "",
  region = "",
  close_connection = FALSE,
  max_retries = 3,
  connect_timeout = 60,
  s3_force_path_style = FALSE,
  sts_regional_endpoint = "",
  signature_version = ""
)

credentials(
  creds = list(access_key_id = "", secret_access_key = "", session_token = "",
    access_token = "", expiration = Inf),
  profile = "",
  anonymous = FALSE
)

creds(
  access_key_id = "",
  secret_access_key = "",
  session_token = "",
  access_token = "",
  expiration = Inf
)

Arguments

credentials	credentials() or list in same format. creds: creds() or list in same format. access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token access_token: The token issued by the CreateToken API call. For more information, see CreateToken in the ⁠IAM Identity Center OIDC API Reference Guide⁠. expiration: The date and time when the temporary credentials expire. expiration must be a POSIXct date-time or able to be compared with them. 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.
max_retries	Max number of retries call AWS API (default set to 3).
connect_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
signature_version	The signature version used when signing requests. Note that the default version is Signature Version 4.
creds	creds() or list in same format. access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token access_token: The token issued by the CreateToken API call. For more information, see CreateToken in the ⁠IAM Identity Center OIDC API Reference Guide⁠. expiration: The date and time when the temporary credentials expire. expiration must be a POSIXct date-time or able to be compared with them.
profile	The name of a profile to use. If not given, then the default profile is used.
anonymous	Set anonymous credentials.
access_key_id	AWS access key ID
secret_access_key	AWS secret access key
session_token	AWS temporary session token
access_token	The token issued by the CreateToken API call. For more information, see CreateToken in the ⁠IAM Identity Center OIDC API Reference Guide⁠.
expiration	The date and time when the temporary credentials expire. expiration must be a POSIXct date-time or able to be compared with them.

Value

list set of parameter variables for paws services.

Examples

# set service parameter access_key_id and secret_access_key

config(credentials(creds("dummy", "secret")))

# set service parameter access_key_id and secret_access_key using using lists
config(
    credentials = list(
        creds = list(
            access_key_id = "dummy",
            secret_access_key = "secret"
        )
    )
)

paws.common documentation built on Oct. 4, 2024, 1:08 a.m.