Table of Contents
finspace.
Client
¶A low-level client representing FinSpace User Environment Management service
The FinSpace management service provides the APIs for managing FinSpace environments.
client = session.create_client('finspace')
These are the available methods:
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
create_environment
(**kwargs)¶Create a new FinSpace environment.
See also: AWS API Documentation
Request Syntax
response = client.create_environment(
name='string',
description='string',
kmsKeyId='string',
tags={
'string': 'string'
},
federationMode='FEDERATED'|'LOCAL',
federationParameters={
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
},
superuserParameters={
'emailAddress': 'string',
'firstName': 'string',
'lastName': 'string'
},
dataBundles=[
'string',
]
)
name (string) –
[REQUIRED]
The name of the FinSpace environment to be created.
description (string) – The description of the FinSpace environment to be created.
kmsKeyId (string) – The KMS key id to encrypt your data in the FinSpace environment.
tags (dict) –
Add tags to your FinSpace environment.
(string) –
(string) –
federationMode (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 (dict) –
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 (dict) –
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.
(string) –
(string) –
superuserParameters (dict) –
Configuration information for the superuser.
emailAddress (string) – [REQUIRED]
The email address of the superuser.
firstName (string) – [REQUIRED]
The first name of the superuser.
lastName (string) – [REQUIRED]
The last name of the superuser.
dataBundles (list) –
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.
(string) –
The Amazon Resource Name (ARN) of the data bundle.
dict
Response Syntax
{
'environmentId': 'string',
'environmentArn': 'string',
'environmentUrl': 'string'
}
Response Structure
(dict) –
environmentId (string) –
The unique identifier for FinSpace environment that you created.
environmentArn (string) –
The Amazon Resource Name (ARN) of the FinSpace environment that you created.
environmentUrl (string) –
The sign-in url for the web application of the FinSpace environment you created.
Exceptions
delete_environment
(**kwargs)¶Delete an FinSpace environment.
See also: AWS API Documentation
Request Syntax
response = client.delete_environment(
environmentId='string'
)
environmentId (string) –
[REQUIRED]
The identifier for the FinSpace environment.
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
get_environment
(**kwargs)¶Returns the FinSpace environment object.
See also: AWS API Documentation
Request Syntax
response = client.get_environment(
environmentId='string'
)
environmentId (string) –
[REQUIRED]
The identifier of the FinSpace environment.
dict
Response Syntax
{
'environment': {
'name': 'string',
'environmentId': 'string',
'awsAccountId': 'string',
'status': 'CREATE_REQUESTED'|'CREATING'|'CREATED'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'FAILED_CREATION'|'RETRY_DELETION'|'FAILED_DELETION'|'SUSPENDED',
'environmentUrl': 'string',
'description': 'string',
'environmentArn': 'string',
'sageMakerStudioDomainUrl': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'federationMode': 'FEDERATED'|'LOCAL',
'federationParameters': {
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
}
}
Response Structure
(dict) –
environment (dict) –
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 (dict) –
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 (dict) –
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.
(string) –
(string) –
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
list_environments
(**kwargs)¶A list of all of your FinSpace environments.
See also: AWS API Documentation
Request Syntax
response = client.list_environments(
nextToken='string',
maxResults=123
)
nextToken (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.
maxResults (integer) – The maximum number of results to return in this request.
dict
Response Syntax
{
'environments': [
{
'name': 'string',
'environmentId': 'string',
'awsAccountId': 'string',
'status': 'CREATE_REQUESTED'|'CREATING'|'CREATED'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'FAILED_CREATION'|'RETRY_DELETION'|'FAILED_DELETION'|'SUSPENDED',
'environmentUrl': 'string',
'description': 'string',
'environmentArn': 'string',
'sageMakerStudioDomainUrl': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'federationMode': 'FEDERATED'|'LOCAL',
'federationParameters': {
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
environments (list) –
A list of all of your FinSpace environments.
(dict) –
Represents an 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 (dict) –
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 (dict) –
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.
(string) –
(string) –
nextToken (string) –
A token that you can use in a subsequent call to retrieve the next set of results.
Exceptions
A list of all tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) –
tags (dict) –
A list of all tags for a resource.
(string) –
(string) –
Exceptions
tag_resource
(**kwargs)¶Adds metadata tags to a FinSpace resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) for the resource.
tags (dict) –
[REQUIRED]
One or more tags to be assigned to the resource.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Removes metadata tags from a FinSpace resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
resourceArn (string) –
[REQUIRED]
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 (list) –
[REQUIRED]
The tag keys (names) of one or more tags to be removed.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_environment
(**kwargs)¶Update your FinSpace environment.
See also: AWS API Documentation
Request Syntax
response = client.update_environment(
environmentId='string',
name='string',
description='string',
federationMode='FEDERATED'|'LOCAL',
federationParameters={
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
)
environmentId (string) –
[REQUIRED]
The identifier of the FinSpace environment.
name (string) – The name of the environment.
description (string) – The description of the environment.
federationMode (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 (dict) –
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 (dict) –
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.
(string) –
(string) –
dict
Response Syntax
{
'environment': {
'name': 'string',
'environmentId': 'string',
'awsAccountId': 'string',
'status': 'CREATE_REQUESTED'|'CREATING'|'CREATED'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'FAILED_CREATION'|'RETRY_DELETION'|'FAILED_DELETION'|'SUSPENDED',
'environmentUrl': 'string',
'description': 'string',
'environmentArn': 'string',
'sageMakerStudioDomainUrl': 'string',
'kmsKeyId': 'string',
'dedicatedServiceAccountId': 'string',
'federationMode': 'FEDERATED'|'LOCAL',
'federationParameters': {
'samlMetadataDocument': 'string',
'samlMetadataURL': 'string',
'applicationCallBackURL': 'string',
'federationURN': 'string',
'federationProviderName': 'string',
'attributeMap': {
'string': 'string'
}
}
}
}
Response Structure
(dict) –
environment (dict) –
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 (dict) –
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 (dict) –
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.
(string) –
(string) –
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
finspace.Client.exceptions.
AccessDeniedException
¶You do not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
You do not have sufficient access to perform this action.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
InternalServerException
¶The request processing has failed because of an unknown error, exception or failure.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request processing has failed because of an unknown error, exception or failure.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
InvalidRequestException
¶The request is invalid. Something is wrong with the input to the request.
Example
try:
...
except client.exceptions.InvalidRequestException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The request is invalid. Something is wrong with the input to the request.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
LimitExceededException
¶A service limit or quota is exceeded.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
A service limit or quota is exceeded.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
ResourceNotFoundException
¶One or more resources can’t be found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
One or more resources can’t be found.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
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.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
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.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
ThrottlingException
¶The request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) –
The request was denied due to request throttling.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
finspace.Client.exceptions.
ValidationException
¶The input fails to satisfy the constraints specified by an AWS service.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The input fails to satisfy the constraints specified by an AWS service.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: