Skip to content

delete_endpoint 

delete_endpoint(
    application_id: __string,
    endpoint_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> DeleteEndpointResponse

Deletes an endpoint from an application.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • endpoint_id (__string) –

    The case insensitive unique identifier for the endpoint. The identifier can't contain $, { or }.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
def delete_endpoint(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    endpoint_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
) -> "capo_pinpoint.types.delete_endpoint_response.DeleteEndpointResponse":
    """<p>Deletes an endpoint from an application.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
        endpoint_id: <p>The case insensitive unique identifier for the endpoint. The identifier can't contain <code>$</code>, <code>{</code> or <code>}</code>.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.delete_endpoint_request.DeleteEndpointRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.delete_endpoint_response.DeleteEndpointResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.delete_endpoint

        output, http_response = (
            capo_pinpoint._operations.pinpoint.delete_endpoint.delete_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteEndpoint")
    )
    input_: capo_pinpoint.types.delete_endpoint_request.DeleteEndpointRequest = {
        "application_id": application_id,
        "endpoint_id": endpoint_id,
    }

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