Update Environment

finspace_update_environment

R Documentation

Update your FinSpace environment

Description

Update your FinSpace environment.

Usage

finspace_update_environment(environmentId, name, description,
  federationMode, federationParameters)

Arguments

environmentId

[required] The identifier of the FinSpace environment.

name

The name of the environment.

description

The description of the environment.

federationMode

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

federationParameters

Value

A list with the following syntax:

list(
  environment = list(
    name = "string",
    environmentId = "string",
    awsAccountId = "string",
    status = "CREATE_REQUESTED"|"CREATING"|"CREATED"|"DELETE_REQUESTED"|"DELETING"|"DELETED"|"FAILED_CREATION"|"RETRY_DELETION"|"FAILED_DELETION"|"UPDATE_NETWORK_REQUESTED"|"UPDATING_NETWORK"|"FAILED_UPDATING_NETWORK"|"SUSPENDED",
    environmentUrl = "string",
    description = "string",
    environmentArn = "string",
    sageMakerStudioDomainUrl = "string",
    kmsKeyId = "string",
    dedicatedServiceAccountId = "string",
    federationMode = "FEDERATED"|"LOCAL",
    federationParameters = list(
      samlMetadataDocument = "string",
      samlMetadataURL = "string",
      applicationCallBackURL = "string",
      federationURN = "string",
      federationProviderName = "string",
      attributeMap = list(
        "string"
      )
    )
  )
)

Request syntax

svc$update_environment(
  environmentId = "string",
  name = "string",
  description = "string",
  federationMode = "FEDERATED"|"LOCAL",
  federationParameters = list(
    samlMetadataDocument = "string",
    samlMetadataURL = "string",
    applicationCallBackURL = "string",
    federationURN = "string",
    federationProviderName = "string",
    attributeMap = list(
      "string"
    )
  )
)