ListProfiles
Returns a list of the profiles for your system. 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 profiles from where you left off.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"ProfileType": "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 profiles to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
When there are additional results that were not returned, a
NextToken
parameter is returned. You can use that value for a subsequent call toListProfiles
to continue listing results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
- ProfileType
-
Indicates whether to list only
LOCAL
type profiles or onlyPARTNER
type profiles. If not supplied in the request, the command lists all types of profiles.Type: String
Valid Values:
LOCAL | PARTNER
Required: No
Response Syntax
{
"NextToken": "string",
"Profiles": [
{
"Arn": "string",
"As2Id": "string",
"ProfileId": "string",
"ProfileType": "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.
- NextToken
-
Returns a token that you can use to call
ListProfiles
again and receive additional results, if there are any.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
- Profiles
-
Returns an array, where each item contains the details of a profile.
Type: Array of ListedProfile objects
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 Amazon 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 AmazonTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AmazonTransfer Family service is not available.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: