update-environment¶
Description¶
Update your FinSpace environment.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-environment
--environment-id <value>
[--name <value>]
[--description <value>]
[--federation-mode <value>]
[--federation-parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--environment-id (string)
The identifier of the FinSpace environment.
--name (string)
The name of the environment.
--description (string)
The description of the environment.
--federation-mode (string)
Authentication mode for the environment.
FEDERATED- Users access FinSpace through Single Sign On (SSO) via your Identity provider.
LOCAL- Users access FinSpace via email and password managed within the FinSpace environment.Possible values:
FEDERATED
LOCAL
--federation-parameters (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
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)
Shorthand Syntax:
samlMetadataDocument=string,samlMetadataURL=string,applicationCallBackURL=string,federationURN=string,federationProviderName=string,attributeMap={KeyName1=string,KeyName2=string}
JSON Syntax:
{
"samlMetadataDocument": "string",
"samlMetadataURL": "string",
"applicationCallBackURL": "string",
"federationURN": "string",
"federationProviderName": "string",
"attributeMap": {"string": "string"
...}
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
environment -> (structure)
Returns the FinSpace environment object.
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
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)