AWS API Changes

2021/05/03 - FinSpace User Environment Management service - 8 new api methods

Changes This is the initial SDK release for the management APIs for Amazon FinSpace. Amazon FinSpace is a data management and analytics service for the financial services industry (FSI).

UntagResource (new)

Link ¶

Removes metadata tags from a FinSpace resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn

string

param resourceArn

[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).

type tagKeys

list

param tagKeys

[REQUIRED]

The tag keys (names) of one or more tags to be removed.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateEnvironment (new)

Link ¶

Create a new FinSpace environment.

See also: AWS API Documentation

Request Syntax

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'
        }
    }
)

type name

string

param name

[REQUIRED]

The name of the FinSpace environment to be created.

type description

string

param description

The description of the FinSpace environment to be created.

type kmsKeyId

string

param kmsKeyId

The KMS key id to encrypt your data in the FinSpace environment.

type tags

dict

param tags

Add tags to your FinSpace environment.

(string) --
- (string) --

type federationMode

string

param federationMode

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.

type federationParameters

dict

param federationParameters

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) --

rtype

dict

returns

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.

UpdateEnvironment (new)

Link ¶

Update your FinSpace environment.

See also: AWS API Documentation

Request Syntax

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'
        }
    }
)

type environmentId

string

param environmentId

[REQUIRED]

The identifier of the FinSpace environment.

type name

string

param name

The name of the environment.

type description

string

param description

The description of the environment.

type federationMode

string

param federationMode

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.

type federationParameters

dict

param federationParameters

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) --

rtype

dict

returns

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) --

ListTagsForResource (new)

Link ¶

A list of all tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name of the resource.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  A list of all tags for a resource.
  - (string) --
    - (string) --

DeleteEnvironment (new)

Link ¶

Delete an FinSpace environment.

See also: AWS API Documentation

Request Syntax

client.delete_environment(
    environmentId='string'
)

type environmentId

string

param environmentId

[REQUIRED]

The identifier for the FinSpace environment.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

TagResource (new)

Link ¶

Adds metadata tags to a FinSpace resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) for the resource.

type tags

dict

param tags

[REQUIRED]

One or more tags to be assigned to the resource.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListEnvironments (new)

Link ¶

A list of all of your FinSpace environments.

See also: AWS API Documentation

Request Syntax

client.list_environments(
    nextToken='string',
    maxResults=123
)

type nextToken

string

param nextToken

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.

type maxResults

integer

param maxResults

The maximum number of results to return in this request.

rtype

dict

returns

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.

GetEnvironment (new)

Link ¶

Returns the FinSpace environment object.

See also: AWS API Documentation

Request Syntax

client.get_environment(
    environmentId='string'
)

type environmentId

string

param environmentId

[REQUIRED]

The identifier of the FinSpace environment.

rtype

dict

returns

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) --