Skip to content

list_access_points 

list_access_points(
    file_system_id: FileSystemId,
    *,
    config_overrides: Optional[S3FilesClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> ListAccessPointsResponse

Returns resource information for all S3 File System Access Points associated with the specified S3 File System.

Parameters:

  • file_system_id (FileSystemId) –

    The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.

  • max_results (Optional[int], default: None ) –

    The maximum number of access points to return in a single response.

  • next_token (Optional[str], default: None ) –

    A pagination token returned from a previous call to continue listing access points.

Raises:

Source code in docs_src/capo_s3files/_services/s3_files.py 
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
def list_access_points(
    self,
    file_system_id: "capo_s3files.types.file_system_id.FileSystemId",
    *,
    config_overrides: Optional[S3FilesClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "capo_s3files.types.list_access_points_response.ListAccessPointsResponse":
    """<p>Returns resource information for all S3 File System Access Points associated with the specified S3 File System.</p>

    Args:
        file_system_id: <p>The ID or Amazon Resource Name (ARN) of the S3 File System to list access points for.</p>
        max_results: <p>The maximum number of access points to return in a single response.</p>
        next_token: <p>A pagination token returned from a previous call to continue listing access points.</p>

    Raises:
        capo_s3files.errors.throttling_exception.ThrottlingException: <p>The request was throttled. Retry your request using exponential backoff.</p>
        capo_s3files.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_s3files.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource exists and that you have permission to access it.</p>
        capo_s3files.errors.validation_exception.ValidationException: <p>The input parameters are not valid. Check the parameter values and try again.</p>
        capo_s3files.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_s3files.types.list_access_points_request.ListAccessPointsRequest]",
    ) -> OperationResponse[
        "capo_s3files.types.list_access_points_response.ListAccessPointsResponse"
    ]:
        import capo_s3files._operations.s3_files.list_access_points

        output, http_response = (
            capo_s3files._operations.s3_files.list_access_points.list_access_points(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAccessPoints")
    )
    input_: capo_s3files.types.list_access_points_request.ListAccessPointsRequest = {
        "file_system_id": file_system_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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