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 DeregisterCapability request.

    • status (string) –

      The status of the deregistration operation. Returns deleting when the capability is being removed.

Exceptions

  • OpenSearchService.Client.exceptions.ValidationException

  • OpenSearchService.Client.exceptions.AccessDeniedException

  • OpenSearchService.Client.exceptions.ConflictException

  • OpenSearchService.Client.exceptions.InternalException

  • OpenSearchService.Client.exceptions.ResourceNotFoundException

  • OpenSearchService.Client.exceptions.DisabledOperationException