Skip to content

GetDataSourceIntrospectionResponse

Source code in docs_src/capo_appsync/types/get_data_source_introspection_response.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class GetDataSourceIntrospectionResponse(TypedDict, closed=True):
    introspection_id: NotRequired["capo_appsync.types.string.String"]
    """<p>The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.</p>"""
    introspection_status: NotRequired[
        "capo_appsync.types.data_source_introspection_status.DataSourceIntrospectionStatus"
    ]
    """<p>The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to <code>PROCESSING</code>. Once the operation has been completed, the status will change to <code>SUCCESS</code> or <code>FAILED</code> depending on how the data was parsed. A <code>FAILED</code> operation will return an error and its details as an <code>introspectionStatusDetail</code>.</p>"""
    introspection_status_detail: NotRequired["capo_appsync.types.string.String"]
    """<p>The error detail field. When a <code>FAILED</code> <code>introspectionStatus</code> is returned, the <code>introspectionStatusDetail</code> will also return the exact error that was generated during the operation.</p>"""
    introspection_result: NotRequired[
        "capo_appsync.types.data_source_introspection_result.DataSourceIntrospectionResult"
    ]
    """<p>The <code>DataSourceIntrospectionResult</code> object data.</p>"""

introspection_id instance-attribute 

introspection_id: NotRequired[String]

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

introspection_result instance-attribute 

introspection_result: NotRequired[DataSourceIntrospectionResult]

The DataSourceIntrospectionResult object data.

introspection_status instance-attribute 

introspection_status: NotRequired[DataSourceIntrospectionStatus]

The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, 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.

introspection_status_detail instance-attribute 

introspection_status_detail: NotRequired[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.