ListEnvironments -

ListEnvironments

A list of all of your FinSpace environments.

Request Syntax

GET /environment?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return in this request.

Valid Range: Minimum value of 0. Maximum value of 100.

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 nextToken value from the response object of the previous page call.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "environments": [ { "awsAccountId": "string", "dedicatedServiceAccountId": "string", "description": "string", "environmentArn": "string", "environmentId": "string", "environmentUrl": "string", "federationMode": "string", "federationParameters": { "applicationCallBackURL": "string", "attributeMap": { "string" : "string" }, "federationProviderName": "string", "federationURN": "string", "samlMetadataDocument": "string", "samlMetadataURL": "string" }, "kmsKeyId": "string", "name": "string", "sageMakerStudioDomainUrl": "string", "status": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

environments

A list of all of your FinSpace environments.

Type: Array of Environment objects

nextToken

A token that you can use in a subsequent call to retrieve the next set of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: