Returns a list of the agreements for the server that's identified by the ServerId that you supply. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing agreements from where you left off.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of items to return.
-
next_token
(Optional[NextToken], default:
None
)
–
When you can get additional results from the ListAgreements call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional agreements.
-
server_id
(ServerId)
–
The identifier of the server for which you want a list of agreements.
Raises:
Source code in docs_src/capo_transfer/_services/transfer.py
| def list_agreements(
self,
server_id: "capo_transfer.types.server_id.ServerId",
*,
config_overrides: Optional[TransferClientConfig] = None,
max_results: Optional["capo_transfer.types.max_results.MaxResults"] = None,
next_token: Optional["capo_transfer.types.next_token.NextToken"] = None,
) -> "capo_transfer.types.list_agreements_response.ListAgreementsResponse":
"""<p>Returns a list of the agreements for the server that's identified by the <code>ServerId</code> that you supply. If you want to limit the results to a certain number, supply a value for the <code>MaxResults</code> parameter. If you ran the command previously and received a value for <code>NextToken</code>, you can supply that value to continue listing agreements from where you left off.</p>
Args:
max_results: <p>The maximum number of items to return.</p>
next_token: <p>When you can get additional results from the <code>ListAgreements</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional agreements.</p>
server_id: <p>The identifier of the server for which you want a list of agreements.</p>
Raises:
capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
capo_transfer.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> parameter that was passed is invalid.</p>
capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_transfer.types.list_agreements_request.ListAgreementsRequest]",
) -> OperationResponse[
"capo_transfer.types.list_agreements_response.ListAgreementsResponse"
]:
import capo_transfer._operations.transfer_service.list_agreements
output, http_response = (
capo_transfer._operations.transfer_service.list_agreements.list_agreements(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAgreements")
)
input_: capo_transfer.types.list_agreements_request.ListAgreementsRequest = {
"server_id": server_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
|