Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 3.76 KB

API_DescribeSecurityPolicy.md

File metadata and controls

82 lines (61 loc) · 3.76 KB

DescribeSecurityPolicy

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.

Request Syntax

{
   "SecurityPolicyName": "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.

** SecurityPolicyName ** Specifies the name of the security policy that is attached to the server.
Type: String
Length Constraints: Maximum length of 100.
Pattern: TransferSecurityPolicy-.+
Required: Yes

Response Syntax

{
   "SecurityPolicy": { 
      "Fips": boolean,
      "SecurityPolicyName": "string",
      "SshCiphers": [ "string" ],
      "SshKexs": [ "string" ],
      "SshMacs": [ "string" ],
      "TlsCiphers": [ "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.

** SecurityPolicy ** An array containing the properties of the security policy.
Type: DescribedSecurityPolicy object

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 AWSTransfer Family service.
HTTP Status Code: 500

** 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 AWSTransfer Family service.
HTTP Status Code: 400

** ServiceUnavailableException **
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: