Skip to content
AWS for Query.Farm

aws.finspace.get_environment

Example SQL Queries

SELECT * FROM
aws.finspace.get_environment
WHERE
"environment_id" = 'VALUE';

Description

Returns the FinSpace environment object.

Table Definition

Column NameColumn Data Type
environment_id Required Input Column

The identifier of the FinSpace environment.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
environment

The name of the FinSpace environment.

STRUCT(
    "name" VARCHAR,
    "environment_id" VARCHAR,
    "aws_account_id" VARCHAR,
    "status" VARCHAR,
    "environment_url" VARCHAR,
    "description" VARCHAR,
    "environment_arn" VARCHAR,
    "sage_maker_studio_domain_url" VARCHAR,
    "kms_key_id" VARCHAR,
    "dedicated_service_account_id" VARCHAR,
    "federation_mode" VARCHAR,
    "federation_parameters" STRUCT(
        "saml_metadata_document" VARCHAR,
        "saml_metadata_url" VARCHAR,
        "application_call_back_url" VARCHAR,
        "federation_urn" VARCHAR,
        "federation_provider_name" VARCHAR,
        "attribute_map" MAP(VARCHAR, VARCHAR)
    )
)
Show child fields
environment.aws_account_id

The ID of the AWS account in which the FinSpace environment is created.

environment.dedicated_service_account_id

The AWS account ID of the dedicated service account associated with your FinSpace environment.

environment.description

The description of the FinSpace environment.

environment.environment_arn

The Amazon Resource Name (ARN) of your FinSpace environment.

environment.environment_id

The identifier of the FinSpace environment.

environment.environment_url

The sign-in URL for the web application of your FinSpace environment.

environment.federation_mode

The authentication mode for the environment.

environment.federation_parameters

Configuration information when authentication mode is FEDERATED.

Show child fields
environment.federation_parameters.application_call_back_url

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

environment.federation_parameters.attribute_map

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

environment.federation_parameters.federation_provider_name

Name of the identity provider (IdP).

environment.federation_parameters.federation_urn

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

environment.federation_parameters.saml_metadata_document

SAML 2.0 Metadata document from identity provider (IdP).

environment.federation_parameters.saml_metadata_url

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

environment.kms_key_id

The KMS key id used to encrypt in the FinSpace environment.

environment.name

The name of the FinSpace environment.

environment.sage_maker_studio_domain_url

The URL of the integrated FinSpace notebook environment in your web application.

environment.status

The current status of creation of the FinSpace environment.