ListSecurityPolicies
Lists the security policies that are attached to your file transfer protocol-enabled servers.
Request Syntax
{
"MaxResults": number
,
"NextToken": "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
-
Specifies the number of security policies to return as a response to the
ListSecurityPolicies
query.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
When additional results are obtained from the
ListSecurityPolicies
command, aNextToken
parameter is returned in the output. You can then pass theNextToken
parameter in a subsequent command to continue listing additional security policies.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
Required: No
Response Syntax
{
"NextToken": "string",
"SecurityPolicyNames": [ "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
-
When you can get additional results from the
ListSecurityPolicies
operation, aNextToken
parameter is returned in the output. In a following command, you can pass in theNextToken
parameter to continue listing security policies.Type: String
Length Constraints: Minimum length of 1. Maximum length of 6144.
- SecurityPolicyNames
-
An array of security policies that were listed.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 100.
Pattern:
TransferSecurityPolicy-.+
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
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
Examples
Example
The following example lists the names for all available security policies.
Sample Request
aws transfer list-security-policies
Sample Response
{
"SecurityPolicyNames": [
"TransferSecurityPolicy-2022-03",
"TransferSecurityPolicy-FIPS-2020-06",
"TransferSecurityPolicy-2018-11",
"TransferSecurityPolicy-2023-05",
"TransferSecurityPolicy-FIPS-2023-05",
"TransferSecurityPolicy-2020-06"
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: