update_security_config
async
¶
update_security_config(
id: SecurityConfigId,
config_version: PolicyVersion,
*,
config_overrides: Optional[AsyncOpenSearchServerlessClientConfig] = None,
description: Optional[ConfigDescription] = None,
saml_options: Optional[SamlConfigOptions] = None,
iam_identity_center_options_updates: Optional[
UpdateIamIdentityCenterConfigOptions
] = None,
iam_federation_options: Optional[IamFederationConfigOptions] = None,
client_token: Optional[ClientToken] = None,
) -> UpdateSecurityConfigResponse
Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameters:
-
id(SecurityConfigId) –The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>. For example,saml/123456789123/OKTADev. -
config_version(PolicyVersion) –The version of the security configuration to be updated. You can find the most recent version of a security configuration using the
GetSecurityPolicycommand. -
description(Optional[ConfigDescription], default:None) –A description of the security configuration.
-
saml_options(Optional[SamlConfigOptions], default:None) –SAML options in in the form of a key-value map.
-
iam_identity_center_options_updates(Optional[UpdateIamIdentityCenterConfigOptions], default:None) –Describes IAM Identity Center options in the form of a key-value map.
-
iam_federation_options(Optional[IamFederationConfigOptions], default:None) –Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.
-
client_token(Optional[ClientToken], default:None) –Unique, case-sensitive identifier to ensure idempotency of the request.
Raises:
-
ConflictException–When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE, FAILED, or UPDATE_FAILED state.
-
InternalServerException–Thrown when an error internal to the service occurs while processing a request.
-
ResourceNotFoundException–Thrown when accessing or deleting a resource that does not exist.
-
ValidationException–Thrown when the HTTP request contains invalid input or is missing required input.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_opensearchserverless/_services/async_open_search_serverless.py
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 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 | |