FinSpace User Environment Management service 2021-03-12
- Client: Aws\finspace\finspaceClient
- Service ID: finspace
- Version: 2021-03-12
This page describes the parameters and results for the operations of the FinSpace User Environment Management service (2021-03-12), and shows how to use the Aws\finspace\finspaceClient object to call the described operations. This documentation is specific to the 2021-03-12 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateEnvironment ( array $params = [] )
Create a new FinSpace environment.
- DeleteEnvironment ( array $params = [] )
Delete an FinSpace environment.
- GetEnvironment ( array $params = [] )
Returns the FinSpace environment object.
- ListEnvironments ( array $params = [] )
A list of all of your FinSpace environments.
- ListTagsForResource ( array $params = [] )
A list of all tags for a resource.
- TagResource ( array $params = [] )
Adds metadata tags to a FinSpace resource.
- UntagResource ( array $params = [] )
Removes metadata tags from a FinSpace resource.
- UpdateEnvironment ( array $params = [] )
Update your FinSpace environment.
Operations
CreateEnvironment
$result = $client->createEnvironment([/* ... */]); $promise = $client->createEnvironmentAsync([/* ... */]);
Create a new FinSpace environment.
Parameter Syntax
$result = $client->createEnvironment([
'dataBundles' => ['<string>', ...],
'description' => '<string>',
'federationMode' => 'FEDERATED|LOCAL',
'federationParameters' => [
'applicationCallBackURL' => '<string>',
'attributeMap' => ['<string>', ...],
'federationProviderName' => '<string>',
'federationURN' => '<string>',
'samlMetadataDocument' => '<string>',
'samlMetadataURL' => '<string>',
],
'kmsKeyId' => '<string>',
'name' => '<string>', // REQUIRED
'superuserParameters' => [
'emailAddress' => '<string>', // REQUIRED
'firstName' => '<string>', // REQUIRED
'lastName' => '<string>', // REQUIRED
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- dataBundles
-
- Type: Array of strings
The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
-
arn:aws:finspace:${Region}::data-bundle/capital-markets-sample- Contains sample Capital Markets datasets, categories and controlled vocabularies. -
arn:aws:finspace:${Region}::data-bundle/taq(default) - Contains trades and quotes data in addition to sample Capital Markets data.
- description
-
- Type: string
The description of the FinSpace environment to be created.
- federationMode
-
- Type: 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.
- federationParameters
-
- Type: FederationParameters structure
Configuration information when authentication mode is FEDERATED.
- kmsKeyId
-
- Type: string
The KMS key id to encrypt your data in the FinSpace environment.
- name
-
- Required: Yes
- Type: string
The name of the FinSpace environment to be created.
- superuserParameters
-
- Type: SuperuserParameters structure
Configuration information for the superuser.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Add tags to your FinSpace environment.
Result Syntax
[
'environmentArn' => '<string>',
'environmentId' => '<string>',
'environmentUrl' => '<string>',
]
Result Details
Members
- environmentArn
-
- Type: string
The Amazon Resource Name (ARN) of the FinSpace environment that you created.
- environmentId
-
- Type: string
The unique identifier for FinSpace environment that you created.
- environmentUrl
-
- Type: string
The sign-in url for the web application of the FinSpace environment you created.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
ServiceQuotaExceededException:
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
-
A service limit or quota is exceeded.
DeleteEnvironment
$result = $client->deleteEnvironment([/* ... */]); $promise = $client->deleteEnvironmentAsync([/* ... */]);
Delete an FinSpace environment.
Parameter Syntax
$result = $client->deleteEnvironment([
'environmentId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
The identifier for the FinSpace environment.
Result Syntax
[]
Result Details
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
GetEnvironment
$result = $client->getEnvironment([/* ... */]); $promise = $client->getEnvironmentAsync([/* ... */]);
Returns the FinSpace environment object.
Parameter Syntax
$result = $client->getEnvironment([
'environmentId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- environmentId
-
- Required: Yes
- Type: string
The identifier of the FinSpace environment.
Result Syntax
[
'environment' => [
'awsAccountId' => '<string>',
'dedicatedServiceAccountId' => '<string>',
'description' => '<string>',
'environmentArn' => '<string>',
'environmentId' => '<string>',
'environmentUrl' => '<string>',
'federationMode' => 'FEDERATED|LOCAL',
'federationParameters' => [
'applicationCallBackURL' => '<string>',
'attributeMap' => ['<string>', ...],
'federationProviderName' => '<string>',
'federationURN' => '<string>',
'samlMetadataDocument' => '<string>',
'samlMetadataURL' => '<string>',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'sageMakerStudioDomainUrl' => '<string>',
'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|SUSPENDED',
],
]
Result Details
Members
- environment
-
- Type: Environment structure
The name of the FinSpace environment.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
-
You do not have sufficient access to perform this action.
ListEnvironments
$result = $client->listEnvironments([/* ... */]); $promise = $client->listEnvironmentsAsync([/* ... */]);
A list of all of your FinSpace environments.
Parameter Syntax
$result = $client->listEnvironments([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in this request.
- nextToken
-
- Type: string
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.
Result Syntax
[
'environments' => [
[
'awsAccountId' => '<string>',
'dedicatedServiceAccountId' => '<string>',
'description' => '<string>',
'environmentArn' => '<string>',
'environmentId' => '<string>',
'environmentUrl' => '<string>',
'federationMode' => 'FEDERATED|LOCAL',
'federationParameters' => [
'applicationCallBackURL' => '<string>',
'attributeMap' => ['<string>', ...],
'federationProviderName' => '<string>',
'federationURN' => '<string>',
'samlMetadataDocument' => '<string>',
'samlMetadataURL' => '<string>',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'sageMakerStudioDomainUrl' => '<string>',
'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|SUSPENDED',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- environments
-
- Type: Array of Environment structures
A list of all of your FinSpace environments.
- nextToken
-
- Type: string
A token that you can use in a subsequent call to retrieve the next set of results.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The input fails to satisfy the constraints specified by an AWS service.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
A list of all tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name of the resource.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of all tags for a resource.
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request is invalid. Something is wrong with the input to the request.
-
One or more resources can't be found.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds metadata tags to a FinSpace resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
One or more tags to be assigned to the resource.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request is invalid. Something is wrong with the input to the request.
-
One or more resources can't be found.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes metadata tags from a FinSpace resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys (names) of one or more tags to be removed.
Result Syntax
[]
Result Details
Errors
-
The request processing has failed because of an unknown error, exception or failure.
-
The request is invalid. Something is wrong with the input to the request.
-
One or more resources can't be found.
UpdateEnvironment
$result = $client->updateEnvironment([/* ... */]); $promise = $client->updateEnvironmentAsync([/* ... */]);
Update your FinSpace environment.
Parameter Syntax
$result = $client->updateEnvironment([
'description' => '<string>',
'environmentId' => '<string>', // REQUIRED
'federationMode' => 'FEDERATED|LOCAL',
'federationParameters' => [
'applicationCallBackURL' => '<string>',
'attributeMap' => ['<string>', ...],
'federationProviderName' => '<string>',
'federationURN' => '<string>',
'samlMetadataDocument' => '<string>',
'samlMetadataURL' => '<string>',
],
'name' => '<string>',
]);
Parameter Details
Members
- description
-
- Type: string
The description of the environment.
- environmentId
-
- Required: Yes
- Type: string
The identifier of the FinSpace environment.
- federationMode
-
- Type: 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.
- federationParameters
-
- Type: FederationParameters structure
Configuration information when authentication mode is FEDERATED.
- name
-
- Type: string
The name of the environment.
Result Syntax
[
'environment' => [
'awsAccountId' => '<string>',
'dedicatedServiceAccountId' => '<string>',
'description' => '<string>',
'environmentArn' => '<string>',
'environmentId' => '<string>',
'environmentUrl' => '<string>',
'federationMode' => 'FEDERATED|LOCAL',
'federationParameters' => [
'applicationCallBackURL' => '<string>',
'attributeMap' => ['<string>', ...],
'federationProviderName' => '<string>',
'federationURN' => '<string>',
'samlMetadataDocument' => '<string>',
'samlMetadataURL' => '<string>',
],
'kmsKeyId' => '<string>',
'name' => '<string>',
'sageMakerStudioDomainUrl' => '<string>',
'status' => 'CREATE_REQUESTED|CREATING|CREATED|DELETE_REQUESTED|DELETING|DELETED|FAILED_CREATION|RETRY_DELETION|FAILED_DELETION|SUSPENDED',
],
]
Result Details
Members
- environment
-
- Type: Environment structure
Returns the FinSpace environment object.
Errors
-
One or more resources can't be found.
-
The request processing has failed because of an unknown error, exception or failure.
-
You do not have sufficient access to perform this action.
-
The request was denied due to request throttling.
-
The input fails to satisfy the constraints specified by an AWS service.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
Environment
Description
Represents an FinSpace environment.
Members
- awsAccountId
-
- Type: string
The ID of the AWS account in which the FinSpace environment is created.
- dedicatedServiceAccountId
-
- Type: string
The AWS account ID of the dedicated service account associated with your FinSpace environment.
- description
-
- Type: string
The description of the FinSpace environment.
- environmentArn
-
- Type: string
The Amazon Resource Name (ARN) of your FinSpace environment.
- environmentId
-
- Type: string
The identifier of the FinSpace environment.
- environmentUrl
-
- Type: string
The sign-in url for the web application of your FinSpace environment.
- federationMode
-
- Type: string
The authentication mode for the environment.
- federationParameters
-
- Type: FederationParameters structure
Configuration information when authentication mode is FEDERATED.
- kmsKeyId
-
- Type: string
The KMS key id used to encrypt in the FinSpace environment.
- name
-
- Type: string
The name of the FinSpace environment.
- sageMakerStudioDomainUrl
-
- Type: string
The url of the integrated FinSpace notebook environment in your web application.
- status
-
- Type: string
The current status of creation of the FinSpace environment.
FederationParameters
Description
Configuration information when authentication mode is FEDERATED.
Members
- applicationCallBackURL
-
- Type: string
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
- attributeMap
-
- Type: Associative array of custom strings keys (FederationAttributeKey) to strings
SAML attribute name and value. The name must always be
Emailand the value should be set to the attribute definition in which user email is set. For example, name would beEmailand valuehttp://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details. - federationProviderName
-
- Type: string
Name of the identity provider (IdP).
- federationURN
-
- Type: string
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
- samlMetadataDocument
-
- Type: string
SAML 2.0 Metadata document from identity provider (IdP).
- samlMetadataURL
-
- Type: string
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).
InternalServerException
Description
The request processing has failed because of an unknown error, exception or failure.
Members
- message
-
- Type: string
InvalidRequestException
Description
The request is invalid. Something is wrong with the input to the request.
Members
- message
-
- Type: string
LimitExceededException
Description
A service limit or quota is exceeded.
Members
- message
-
- Type: string
ResourceNotFoundException
Description
One or more resources can't be found.
Members
- message
-
- Type: string
ServiceQuotaExceededException
Description
You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
Members
- message
-
- Type: string
SuperuserParameters
Description
Configuration information for the superuser.
Members
- emailAddress
-
- Required: Yes
- Type: string
The email address of the superuser.
- firstName
-
- Required: Yes
- Type: string
The first name of the superuser.
- lastName
-
- Required: Yes
- Type: string
The last name of the superuser.
ThrottlingException
Description
The request was denied due to request throttling.
Members
ValidationException
Description
The input fails to satisfy the constraints specified by an AWS service.
Members
- message
-
- Type: string