Skip to content

delete_api_key_credential_provider

delete_api_key_credential_provider(
    name: CredentialProviderName,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
) -> DeleteApiKeyCredentialProviderResponse

Deletes an API key credential provider.

Parameters:

Raises:

  • AccessDeniedException –

    This exception is thrown when a request is denied per access permissions

  • InternalServerException –

    This exception is thrown if there was an unexpected error during processing of request

  • ResourceNotFoundException –

    This exception is thrown when a resource referenced by the operation does not exist

  • ThrottlingException –

    This exception is thrown when the number of requests exceeds the limit

  • UnauthorizedException –

    This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

  • ValidationException –

    The input fails to satisfy the constraints specified by the service.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def delete_api_key_credential_provider(
    self,
    name: "capo_bedrock_agentcore_control.types.credential_provider_name.CredentialProviderName",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
) -> "capo_bedrock_agentcore_control.types.delete_api_key_credential_provider_response.DeleteApiKeyCredentialProviderResponse":
    """<p>Deletes an API key credential provider.</p>

    Args:
        name: <p>The name of the API key credential provider to delete.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.unauthorized_exception.UnauthorizedException: <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.delete_api_key_credential_provider_request.DeleteApiKeyCredentialProviderRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.delete_api_key_credential_provider_response.DeleteApiKeyCredentialProviderResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.delete_api_key_credential_provider

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.delete_api_key_credential_provider.delete_api_key_credential_provider(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApiKeyCredentialProvider")
    )
    input_: capo_bedrock_agentcore_control.types.delete_api_key_credential_provider_request.DeleteApiKeyCredentialProviderRequest = {
        "name": name
    }

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