OpenSearchService / Client / deregister_capability
deregister_capability¶
- OpenSearchService.Client.deregister_capability(**kwargs)¶
Deregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration.
See also: AWS API Documentation
Request Syntax
response = client.deregister_capability( applicationId='string', capabilityName='string' )
- Parameters:
applicationId (string) –
[REQUIRED]
The unique identifier of the OpenSearch UI application to deregister the capability from.
capabilityName (string) –
[REQUIRED]
The name of the capability to deregister.
- Return type:
dict
- Returns:
Response Syntax
{ 'status': 'creating'|'create_failed'|'active'|'updating'|'update_failed'|'deleting'|'delete_failed' }
Response Structure
(dict) –
The result of a
DeregisterCapabilityrequest.status (string) –
The status of the deregistration operation. Returns
deletingwhen the capability is being removed.
Exceptions
OpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ConflictExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationException