delete_security_config ¶

delete_security_config(
    id: SecurityConfigId,
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> DeleteSecurityConfigResponse

Deletes 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.
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/open_search_serverless.py

def delete_security_config(
    self,
    id: "capo_opensearchserverless.types.security_config_id.SecurityConfigId",
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
    client_token: Optional[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ] = None,
) -> "capo_opensearchserverless.types.delete_security_config_response.DeleteSecurityConfigResponse":
    """<p>Deletes a security configuration for OpenSearch Serverless. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>.</p>

    Args:
        id: <p>The security configuration identifier. For SAML the ID will be <code>saml/&lt;accountId&gt;/&lt;idpProviderName&gt;</code>. For example, <code>saml/123456789123/OKTADev</code>.</p>
        client_token: <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>

    Raises:
        capo_opensearchserverless.errors.conflict_exception.ConflictException: <p>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.</p>
        capo_opensearchserverless.errors.internal_server_exception.InternalServerException: <p>Thrown when an error internal to the service occurs while processing a request.</p>
        capo_opensearchserverless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Thrown when accessing or deleting a resource that does not exist.</p>
        capo_opensearchserverless.errors.validation_exception.ValidationException: <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
        capo_opensearchserverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_opensearchserverless.types.delete_security_config_request.DeleteSecurityConfigRequest]",
    ) -> OperationResponse[
        "capo_opensearchserverless.types.delete_security_config_response.DeleteSecurityConfigResponse"
    ]:
        import capo_opensearchserverless._operations.open_search_serverless.delete_security_config

        output, http_response = (
            capo_opensearchserverless._operations.open_search_serverless.delete_security_config.delete_security_config(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSecurityConfig")
    )
    input_: capo_opensearchserverless.types.delete_security_config_request.DeleteSecurityConfigRequest = {
        "id": id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output