# DescribeAgreement
<a name="API_DescribeAgreement"></a>

Describes the agreement that's identified by the `AgreementId`.

## Request Syntax
<a name="API_DescribeAgreement_RequestSyntax"></a>

```
{
   "AgreementId": "string",
   "ServerId": "string"
}
```

## Request Parameters
<a name="API_DescribeAgreement_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AgreementId](#API_DescribeAgreement_RequestSyntax) **   <a name="TransferFamily-DescribeAgreement-request-AgreementId"></a>
A unique identifier for the agreement. This identifier is returned when you create an agreement.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `a-([0-9a-f]{17})`   
Required: Yes

 ** [ServerId](#API_DescribeAgreement_RequestSyntax) **   <a name="TransferFamily-DescribeAgreement-request-ServerId"></a>
The server identifier that's associated with the agreement.  
Type: String  
Length Constraints: Fixed length of 19.  
Pattern: `s-([0-9a-f]{17})`   
Required: Yes

## Response Syntax
<a name="API_DescribeAgreement_ResponseSyntax"></a>

```
{
   "Agreement": { 
      "AccessRole": "string",
      "AgreementId": "string",
      "Arn": "string",
      "BaseDirectory": "string",
      "CustomDirectories": { 
         "FailedFilesDirectory": "string",
         "MdnFilesDirectory": "string",
         "PayloadFilesDirectory": "string",
         "StatusFilesDirectory": "string",
         "TemporaryFilesDirectory": "string"
      },
      "Description": "string",
      "EnforceMessageSigning": "string",
      "LocalProfileId": "string",
      "PartnerProfileId": "string",
      "PreserveFilename": "string",
      "ServerId": "string",
      "Status": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeAgreement_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Agreement](#API_DescribeAgreement_ResponseSyntax) **   <a name="TransferFamily-DescribeAgreement-response-Agreement"></a>
The details for the specified agreement, returned as a `DescribedAgreement` object.  
Type: [DescribedAgreement](API_DescribedAgreement.md) object

## Errors
<a name="API_DescribeAgreement_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceError **   
This exception is thrown when an error occurs in the AWS Transfer 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
<a name="API_DescribeAgreement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/transfer-2018-11-05/DescribeAgreement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/transfer-2018-11-05/DescribeAgreement)