:doc:`FinSpaceData <../../finspace-data>` / Client / get_programmatic_access_credentials

***********************************
get_programmatic_access_credentials
***********************************



.. py:method:: 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 <https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials>`__.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials>`_  


  **Request Syntax**
  ::

    response = client.get_programmatic_access_credentials(
        durationInMinutes=123,
        environmentId='string'
    )
    
  :type durationInMinutes: integer
  :param durationInMinutes: 

    The time duration in which the credentials remain valid.

    

  
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    The FinSpace environment identifier.

    

  
  
  :rtype: 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**
  
  *   :py:class:`FinSpaceData.Client.exceptions.InternalServerException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.ValidationException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.ThrottlingException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.AccessDeniedException`

  