list_attached_indices
async
¶
list_attached_indices(
directory_arn: Arn,
target_reference: ObjectReference,
*,
config_overrides: Optional[AsyncCloudDirectoryClientConfig] = None,
next_token: Optional[NextToken] = None,
max_results: Optional[NumberResults] = None,
consistency_level: Optional[ConsistencyLevel] = None,
) -> ListAttachedIndicesResponse
Lists indices attached to the specified object.
Parameters:
-
directory_arn(Arn) –The ARN of the directory.
-
target_reference(ObjectReference) –A reference to the object that has indices attached.
-
next_token(Optional[NextToken], default:None) –The pagination token.
-
max_results(Optional[NumberResults], default:None) –The maximum number of results to retrieve.
-
consistency_level(Optional[ConsistencyLevel], default:None) –The consistency level to use for this operation.
Raises:
-
AccessDeniedException–Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
-
DirectoryNotEnabledException–Operations are only permitted on enabled directories.
-
InternalServiceException–Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.
-
InvalidArnException–Indicates that the provided ARN value is not valid.
-
LimitExceededException–Indicates that limits are exceeded. See Limits for more information.
-
ResourceNotFoundException–The specified resource could not be found.
-
RetryableConflictException–Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
-
ValidationException–Indicates that your request is malformed in some manner. See the exception message.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
To list the indices attached to an object
>>> await client.list_attached_indices(directory_arn='arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY', target_reference={'Selector': '$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw'})
Source code in docs_src/capo_clouddirectory/_services/async_cloud_directory.py
2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 | |