List Environments

finspace_list_environments

R Documentation

A list of all of your FinSpace environments¶

Description¶

A list of all of your FinSpace environments.

Usage¶

finspace_list_environments(nextToken, maxResults)

Arguments¶

nextToken

A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the response object of the previous page call.

maxResults

The maximum number of results to return in this request.

Value¶

A list with the following syntax:

list(
  environments = list(
    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"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_environments(
  nextToken = "string",
  maxResults = 123
)