Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).
Related actions include:
Parameters:
-
next_token
(Optional[NextToken], default:
None
)
–
If a previous response from this operation included a NextToken value, you can provide that value here to retrieve the next page of results.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of endpoints that will be returned in the response.
-
outpost_id
(OutpostId)
–
The ID of the Amazon Web Services Outpost.
Raises:
Source code in docs_src/capo_s3outposts/_services/s3_outposts.py
| def list_shared_endpoints(
self,
outpost_id: "capo_s3outposts.types.outpost_id.OutpostId",
*,
config_overrides: Optional[S3OutpostsClientConfig] = None,
next_token: Optional["capo_s3outposts.types.next_token.NextToken"] = None,
max_results: Optional["capo_s3outposts.types.max_results.MaxResults"] = None,
) -> "capo_s3outposts.types.list_shared_endpoints_result.ListSharedEndpointsResult":
"""<p>Lists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager (RAM).</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_DeleteEndpoint.html">DeleteEndpoint</a> </p> </li> </ul>
Args:
next_token: <p>If a previous response from this operation included a <code>NextToken</code> value, you can provide that value here to retrieve the next page of results.</p>
max_results: <p>The maximum number of endpoints that will be returned in the response.</p>
outpost_id: <p>The ID of the Amazon Web Services Outpost.</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.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.list_shared_endpoints_request.ListSharedEndpointsRequest]",
) -> OperationResponse[
"capo_s3outposts.types.list_shared_endpoints_result.ListSharedEndpointsResult"
]:
import capo_s3outposts._operations.s3_outposts.list_shared_endpoints
output, http_response = (
capo_s3outposts._operations.s3_outposts.list_shared_endpoints.list_shared_endpoints(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSharedEndpoints")
)
input_: capo_s3outposts.types.list_shared_endpoints_request.ListSharedEndpointsRequest = {
"outpost_id": outpost_id
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|