delete_agent ¶

delete_agent(
    agent_id: str,
    aws_account_id: str,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DeleteAgentResponse

Deletes an agent.

Parameters:

agent_id (str) –

The unique identifier for the agent to delete.
aws_account_id (str) –

The ID of the Amazon Web Services account that contains the agent.

Raises:

AccessDeniedException –

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
ConflictException –

Updating or deleting a resource can cause an inconsistent state.
InternalFailureException –

An internal failure occurred.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

Access is throttled.
UnknownServiceError –

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

Source code in docs_src/capo_quicksight/_services/quick_sight.py

def delete_agent(
    self,
    agent_id: str,
    aws_account_id: str,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.delete_agent_response.DeleteAgentResponse":
    """<p>Deletes an agent.</p>

    Args:
        agent_id: <p>The unique identifier for the agent to delete.</p>
        aws_account_id: <p>The ID of the Amazon Web Services account that contains the agent.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.delete_agent_request.DeleteAgentRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.delete_agent_response.DeleteAgentResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.delete_agent

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.delete_agent.delete_agent(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAgent")
    )
    input_: capo_quicksight.types.delete_agent_request.DeleteAgentRequest = {
        "agent_id": agent_id,
        "aws_account_id": aws_account_id,
    }

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