Transfer / Client / describe_security_policy
describe_security_policy#
- Transfer.Client.describe_security_policy(**kwargs)#
Describes the security policy that is attached to your file transfer protocol-enabled server. The response contains a description of the security policy’s properties. For more information about security policies, see Working with security policies.
See also: AWS API Documentation
Request Syntax
response = client.describe_security_policy( SecurityPolicyName='string' )
- Parameters:
SecurityPolicyName (string) –
[REQUIRED]
Specifies the name of the security policy that is attached to the server.
- Return type:
dict
- Returns:
Response Syntax
{ 'SecurityPolicy': { 'Fips': True|False, 'SecurityPolicyName': 'string', 'SshCiphers': [ 'string', ], 'SshKexs': [ 'string', ], 'SshMacs': [ 'string', ], 'TlsCiphers': [ 'string', ] } }
Response Structure
(dict) –
SecurityPolicy (dict) –
An array containing the properties of the security policy.
Fips (boolean) –
Specifies whether this policy enables Federal Information Processing Standards (FIPS).
SecurityPolicyName (string) –
Specifies the name of the security policy that is attached to the server.
SshCiphers (list) –
Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.
(string) –
SshKexs (list) –
Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.
(string) –
SshMacs (list) –
Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.
(string) –
TlsCiphers (list) –
Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
(string) –
Exceptions
Transfer.Client.exceptions.ResourceNotFoundException
Transfer.Client.exceptions.InvalidRequestException
Transfer.Client.exceptions.InternalServiceError
Transfer.Client.exceptions.ServiceUnavailableException