update_q_app_session_metadata
async
¶
update_q_app_session_metadata(
instance_id: InstanceId,
session_id: UUID,
sharing_configuration: SessionSharingConfiguration,
*,
config_overrides: Optional[AsyncQAppsClientConfig] = None,
session_name: Optional[SessionName] = None,
) -> UpdateQAppSessionMetadataOutput
Updates the configuration metadata of a session for a given Q App sessionId.
Parameters:
-
instance_id(InstanceId) –The unique identifier of the Amazon Q Business application environment instance.
-
session_id(UUID) –The unique identifier of the Q App session to update configuration for.
-
session_name(Optional[SessionName], default:None) –The new name for the Q App session.
-
sharing_configuration(SessionSharingConfiguration) –The new sharing configuration for the Q App data collection session.
Raises:
-
AccessDeniedException–The client is not authorized to perform the requested operation.
-
InternalServerException–An internal service error occurred while processing the request.
-
ResourceNotFoundException–The requested resource could not be found.
-
ServiceQuotaExceededException–The requested operation could not be completed because it would exceed the service's quota or limit.
-
ThrottlingException–The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.
-
UnauthorizedException–The client is not authenticated or authorized to perform the requested operation.
-
ValidationException–The input failed to satisfy the constraints specified by the service.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
Updates an existing session metadata for an Amazon Q App
>>> await client.update_q_app_session_metadata(instance_id='0b95c9c4-89cc-4aa8-9aae-aa91cbec699f', session_id='56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb', session_name='Trip itinerary collection session', sharing_configuration={'enabled': True, 'acceptResponses': True, 'revealCards': False})
Source code in docs_src/capo_qapps/_services/async_q_apps.py
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 | |