ListAgreements
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.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"ServerId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of agreements to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
When you can get additional results from the
ListAgreements
call, aNextToken
parameter is returned in the output. You can then pass in a subsequent command to theNextToken
parameter to continue listing additional agreements.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
- ServerId
-
The identifier of the server for which you want a list of agreements.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
s-([0-9a-f]{17})
Required: Yes
Response Syntax
{
"Agreements": [
{
"AgreementId": "string",
"Arn": "string",
"Description": "string",
"LocalProfileId": "string",
"PartnerProfileId": "string",
"ServerId": "string",
"Status": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Agreements
-
Returns an array, where each item contains the details of an agreement.
Type: Array of ListedAgreement objects
- NextToken
-
Returns a token that you can use to call
ListAgreements
again and receive additional results, if there are any.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
HTTP Status Code: 500
- InvalidNextTokenException
-
The
NextToken
parameter that was passed is invalid.HTTP Status Code: 400
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: