get_data_source_introspection
async
¶
get_data_source_introspection(
introspection_id: String,
*,
config_overrides: Optional[AsyncAppSyncClientConfig] = None,
include_models_sdl: Optional[Boolean] = None,
next_token: Optional[PaginationToken] = None,
max_results: Optional[MaxResults] = None,
) -> GetDataSourceIntrospectionResponse
Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.
Parameters:
-
introspection_id(String) –The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
-
include_models_sdl(Optional[Boolean], default:None) –A boolean flag that determines whether SDL should be generated for introspected types. If set to
true, each model will contain ansdlproperty that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives. -
next_token(Optional[PaginationToken], default:None) –Determines the number of types to be returned in a single response before paginating. This value is typically taken from
nextTokenvalue from the previous response. -
max_results(Optional[MaxResults], default:None) –The maximum number of introspected types that will be returned in a single response.
Raises:
-
BadRequestException–The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
-
InternalFailureException–An internal AppSync error occurred. Try your request again.
-
NotFoundException–The resource specified in the request was not found. Check the resource, and then try again.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_appsync/_services/async_app_sync.py
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 | |