Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
Specifies the number of security policies to return as a response to the ListSecurityPolicies query.
-
next_token
(Optional[NextToken], default:
None
)
–
When additional results are obtained from the ListSecurityPolicies command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional security policies.
Raises:
Source code in docs_src/capo_transfer/_services/transfer.py
| def list_security_policies(
self,
*,
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_security_policies_response.ListSecurityPoliciesResponse":
"""<p>Lists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html">Working with security policies for servers</a> or <a href="https://docs.aws.amazon.com/transfer/latest/userguide/security-policies-connectors.html">Working with security policies for SFTP connectors</a>.</p>
Args:
max_results: <p>Specifies the number of security policies to return as a response to the <code>ListSecurityPolicies</code> query.</p>
next_token: <p>When additional results are obtained from the <code>ListSecurityPolicies</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional security policies.</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.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_security_policies_request.ListSecurityPoliciesRequest]",
) -> OperationResponse[
"capo_transfer.types.list_security_policies_response.ListSecurityPoliciesResponse"
]:
import capo_transfer._operations.transfer_service.list_security_policies
output, http_response = (
capo_transfer._operations.transfer_service.list_security_policies.list_security_policies(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSecurityPolicies")
)
input_: capo_transfer.types.list_security_policies_request.ListSecurityPoliciesRequest = {}
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
|