Transfer / Client / describe_security_policy

describe_security_policy#

Transfer.Client.describe_security_policy(**kwargs)#

Describes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy’s properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.

See also: AWS API Documentation

Request Syntax

response = client.describe_security_policy(
    SecurityPolicyName='string'
)
Parameters:

SecurityPolicyName (string) –

[REQUIRED]

Specify the text name of the security policy for which you want the details.

Return type:

dict

Returns:

Response Syntax

{
    'SecurityPolicy': {
        'Fips': True|False,
        'SecurityPolicyName': 'string',
        'SshCiphers': [
            'string',
        ],
        'SshKexs': [
            'string',
        ],
        'SshMacs': [
            'string',
        ],
        'TlsCiphers': [
            'string',
        ],
        'SshHostKeyAlgorithms': [
            'string',
        ],
        'Type': 'SERVER'|'CONNECTOR',
        'Protocols': [
            'SFTP'|'FTPS',
        ]
    }
}

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). This parameter applies to both server and connector security policies.

      • SecurityPolicyName (string) –

        The text name of the specified security policy.

      • SshCiphers (list) –

        Lists the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

        • (string) –

      • SshKexs (list) –

        Lists the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

        • (string) –

      • SshMacs (list) –

        Lists the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server or connector. This parameter applies to both server and connector security policies.

        • (string) –

      • TlsCiphers (list) –

        Lists the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

        Note

        This parameter only applies to security policies for servers.

        • (string) –

      • SshHostKeyAlgorithms (list) –

        Lists the host key algorithms for the security policy.

        Note

        This parameter only applies to security policies for connectors.

        • (string) –

      • Type (string) –

        The resource type to which the security policy applies, either server or connector.

      • Protocols (list) –

        Lists the file transfer protocols that the security policy applies to.

        • (string) –

Exceptions

  • Transfer.Client.exceptions.ResourceNotFoundException

  • Transfer.Client.exceptions.InvalidRequestException

  • Transfer.Client.exceptions.InternalServiceError

  • Transfer.Client.exceptions.ServiceUnavailableException