list_file_system_associations `async` ¶

list_file_system_associations(
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    gateway_arn: Optional[GatewayARN] = None,
    limit: Optional[PositiveIntObject] = None,
    marker: Optional[Marker] = None,
) -> ListFileSystemAssociationsOutput

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.

Parameters:

limit (Optional[PositiveIntObject], default: None ) –

The maximum number of file system associations to return in the response. If present, Limit must be an integer with a value greater than zero. Optional.
marker (Optional[Marker], default: None ) –

Opaque pagination token returned from a previous ListFileSystemAssociations operation. If present, Marker specifies where to continue the list from after a previous call to ListFileSystemAssociations. Optional.

Raises:

InternalServerError –

An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException –

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
UnknownServiceError –

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

Source code in docs_src/capo_storage_gateway/_services/async_storage_gateway.py

async def list_file_system_associations(
    self,
    *,
    config_overrides: Optional[AsyncStorageGatewayClientConfig] = None,
    gateway_arn: Optional[
        "capo_storage_gateway.types.gateway_arn.GatewayARN"
    ] = None,
    limit: Optional[
        "capo_storage_gateway.types.positive_int_object.PositiveIntObject"
    ] = None,
    marker: Optional["capo_storage_gateway.types.marker.Marker"] = None,
) -> "capo_storage_gateway.types.list_file_system_associations_output.ListFileSystemAssociationsOutput":
    """<p>Gets a list of <code>FileSystemAssociationSummary</code> objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.</p>

    Args:
        limit: <p>The maximum number of file system associations to return in the response. If present, <code>Limit</code> must be an integer with a value greater than zero. Optional.</p>
        marker: <p>Opaque pagination token returned from a previous <code>ListFileSystemAssociations</code> operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to <code>ListFileSystemAssociations</code>. Optional.</p>

    Raises:
        capo_storage_gateway.errors.internal_server_error.InternalServerError: <p>An internal server error has occurred during the request. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.invalid_gateway_request_exception.InvalidGatewayRequestException: <p>An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.</p>
        capo_storage_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_storage_gateway.types.list_file_system_associations_input.ListFileSystemAssociationsInput]",
    ) -> AsyncOperationResponse[
        "capo_storage_gateway.types.list_file_system_associations_output.ListFileSystemAssociationsOutput"
    ]:
        import capo_storage_gateway._operations.storage_gateway_20130630.list_file_system_associations

        (
            output,
            http_response,
        ) = await capo_storage_gateway._operations.storage_gateway_20130630.list_file_system_associations.async_list_file_system_associations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFileSystemAssociations")
    )
    input_: capo_storage_gateway.types.list_file_system_associations_input.ListFileSystemAssociationsInput = {}
    if gateway_arn is not None:
        input_["gateway_arn"] = gateway_arn
    if limit is not None:
        input_["limit"] = limit
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_file_system_associations async ¶

list_file_system_associations `async` ¶