Skip to content

delete_endpoint 

delete_endpoint(
    endpoint_id: EndpointId,
    outpost_id: OutpostId,
    *,
    config_overrides: Optional[S3OutpostsClientConfig] = None,
) -> None

Deletes an endpoint.

It can take up to 5 minutes for this action to finish.

Related actions include:

Parameters:

  • endpoint_id (EndpointId) –

    The ID of the endpoint.

  • outpost_id (OutpostId) –

    The ID of the Outposts.

Raises:

Source code in docs_src/capo_s3outposts/_services/s3_outposts.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
def delete_endpoint(
    self,
    endpoint_id: "capo_s3outposts.types.endpoint_id.EndpointId",
    outpost_id: "capo_s3outposts.types.outpost_id.OutpostId",
    *,
    config_overrides: Optional[S3OutpostsClientConfig] = None,
) -> None:
    """<p>Deletes an endpoint.</p> <note> <p>It can take up to 5 minutes for this action to finish.</p> </note> <p></p> <p>Related actions include:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_CreateEndpoint.html">CreateEndpoint</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html">ListEndpoints</a> </p> </li> </ul>

    Args:
        endpoint_id: <p>The ID of the endpoint.</p>
        outpost_id: <p>The ID of the Outposts. </p>

    Raises:
        capo_s3outposts.errors.access_denied_exception.AccessDeniedException: <p>Access was denied for this action.</p>
        capo_s3outposts.errors.internal_server_exception.InternalServerException: <p>There was an exception with the internal server.</p>
        capo_s3outposts.errors.outpost_offline_exception.OutpostOfflineException: <p>The service link connection to your Outposts home Region is down. Check your connection and try again.</p>
        capo_s3outposts.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_s3outposts.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_s3outposts.errors.validation_exception.ValidationException: <p>There was an exception validating this data.</p>
        capo_s3outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3outposts.types.delete_endpoint_request.DeleteEndpointRequest]",
    ) -> OperationResponse[None]:
        import capo_s3outposts._operations.s3_outposts.delete_endpoint

        output, http_response = (
            capo_s3outposts._operations.s3_outposts.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_s3outposts.types.delete_endpoint_request.DeleteEndpointRequest = {
        "endpoint_id": endpoint_id,
        "outpost_id": outpost_id,
    }

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