Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . finspace ]

get-environment

Description

Returns the FinSpace environment object.

See also: AWS API Documentation

Synopsis

  get-environment
--environment-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--environment-id (string)

The identifier of the FinSpace environment.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

environment -> (structure)

The name of the FinSpace environment.

name -> (string)

The name of the FinSpace environment.

environmentId -> (string)

The identifier of the FinSpace environment.

awsAccountId -> (string)

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

status -> (string)

The current status of creation of the FinSpace environment.

environmentUrl -> (string)

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

description -> (string)

The description of the FinSpace environment.

environmentArn -> (string)

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

sageMakerStudioDomainUrl -> (string)

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

kmsKeyId -> (string)

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

dedicatedServiceAccountId -> (string)

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

federationMode -> (string)

The authentication mode for the environment.

federationParameters -> (structure)

Configuration information when authentication mode is FEDERATED.

samlMetadataDocument -> (string)

SAML 2.0 Metadata document from identity provider (IdP).

samlMetadataURL -> (string)

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

applicationCallBackURL -> (string)

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

federationURN -> (string)

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

federationProviderName -> (string)

Name of the identity provider (IdP).

attributeMap -> (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.

key -> (string)

value -> (string)