Get Environment

finspace_get_environment

R Documentation

Returns the FinSpace environment object

Description

Returns the FinSpace environment object.

Usage

finspace_get_environment(environmentId)

Arguments

environmentId

[required] The identifier of the FinSpace environment.

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$get_environment(
  environmentId = "string"
)