:doc:`AppSync <../../appsync>` / Client / start_data_source_introspection

*******************************
start_data_source_introspection
*******************************



.. py:method:: AppSync.Client.start_data_source_introspection(**kwargs)

  

  Creates a new introspection. Returns the ``introspectionId`` of the new introspection after its creation.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/StartDataSourceIntrospection>`_  


  **Request Syntax**
  ::

    response = client.start_data_source_introspection(
        rdsDataApiConfig={
            'resourceArn': 'string',
            'secretArn': 'string',
            'databaseName': 'string'
        }
    )
    
  :type rdsDataApiConfig: dict
  :param rdsDataApiConfig: 

    The ``rdsDataApiConfig`` object data.

    

  
    - **resourceArn** *(string) --* **[REQUIRED]** 

      The resource ARN of the RDS cluster.

      

    
    - **secretArn** *(string) --* **[REQUIRED]** 

      The secret's ARN that was obtained from Secrets Manager. A secret consists of secret information, the secret value, plus metadata about the secret. A secret value can be a string or binary. It typically includes the ARN, secret name and description, policies, tags, encryption key from the Key Management Service, and key rotation data.

      

    
    - **databaseName** *(string) --* **[REQUIRED]** 

      The name of the database in the cluster.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'introspectionId': 'string',
          'introspectionStatus': 'PROCESSING'|'FAILED'|'SUCCESS',
          'introspectionStatusDetail': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **introspectionId** *(string) --* 

        The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

        
      

      - **introspectionStatus** *(string) --* 

        The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to ``PROCESSING``. Once the operation has been completed, the status will change to ``SUCCESS`` or ``FAILED`` depending on how the data was parsed. A ``FAILED`` operation will return an error and its details as an ``introspectionStatusDetail``.

        
      

      - **introspectionStatusDetail** *(string) --* 

        The error detail field. When a ``FAILED`` ``introspectionStatus`` is returned, the ``introspectionStatusDetail`` will also return the exact error that was generated during the operation.

        
  
  **Exceptions**
  
  *   :py:class:`AppSync.Client.exceptions.NotFoundException`

  
  *   :py:class:`AppSync.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`AppSync.Client.exceptions.InternalFailureException`

  
  *   :py:class:`AppSync.Client.exceptions.BadRequestException`

  