FinSpaceData / Client / get_programmatic_access_credentials

get_programmatic_access_credentials#

FinSpaceData.Client.get_programmatic_access_credentials(**kwargs)#

Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

Request Syntax

response = client.get_programmatic_access_credentials(
    durationInMinutes=123,
    environmentId='string'
)

Parameters:

durationInMinutes (integer) – The time duration in which the credentials remain valid.
environmentId (string) –
[REQUIRED]

The FinSpace environment identifier.

Return type:

dict

Returns:

Response Syntax

{
    'credentials': {
        'accessKeyId': 'string',
        'secretAccessKey': 'string',
        'sessionToken': 'string'
    },
    'durationInMinutes': 123
}

Response Structure

(dict) – Response for GetProgrammaticAccessCredentials operation
- credentials (dict) –
  
  Returns the programmatic credentials.
  - accessKeyId (string) –
    
    The access key identifier.
  - secretAccessKey (string) –
    
    The access key.
  - sessionToken (string) –
    
    The session token.
- durationInMinutes (integer) –
  
  Returns the duration in which the credentials will remain valid.

Exceptions

FinSpaceData.Client.exceptions.InternalServerException
FinSpaceData.Client.exceptions.ValidationException
FinSpaceData.Client.exceptions.ThrottlingException
FinSpaceData.Client.exceptions.AccessDeniedException