

# DescribeReportPlan
<a name="API_DescribeReportPlan"></a>

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

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

```
GET /audit/report-plans/{{reportPlanName}} HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeReportPlan_RequestParameters"></a>

The request uses the following URI parameters.

 ** [reportPlanName](#API_DescribeReportPlan_RequestSyntax) **   <a name="Backup-DescribeReportPlan-request-uri-ReportPlanName"></a>
The unique name of a report plan.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z][_a-zA-Z0-9]*`   
Required: Yes

## Request Body
<a name="API_DescribeReportPlan_RequestBody"></a>

The request does not have a request body.

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

```
HTTP/1.1 200
Content-type: application/json

{
   "ReportPlan": { 
      "CreationTime": number,
      "DeploymentStatus": "string",
      "LastAttemptedExecutionTime": number,
      "LastSuccessfulExecutionTime": number,
      "ReportDeliveryChannel": { 
         "Formats": [ "string" ],
         "S3BucketName": "string",
         "S3KeyPrefix": "string"
      },
      "ReportPlanArn": "string",
      "ReportPlanDescription": "string",
      "ReportPlanName": "string",
      "ReportSetting": { 
         "Accounts": [ "string" ],
         "FrameworkArns": [ "string" ],
         "NumberOfFrameworks": number,
         "OrganizationUnits": [ "string" ],
         "Regions": [ "string" ],
         "ReportTemplate": "string"
      }
   }
}
```

## Response Elements
<a name="API_DescribeReportPlan_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.

 ** [ReportPlan](#API_DescribeReportPlan_ResponseSyntax) **   <a name="Backup-DescribeReportPlan-response-ReportPlan"></a>
Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.  
Type: [ReportPlan](API_ReportPlan.md) object

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

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

 ** InvalidParameterValueException **   
Indicates that something is wrong with a parameter's value. For example, the value is out of range.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 400

 ** MissingParameterValueException **   
Indicates that a required parameter is missing.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 400

 ** ResourceNotFoundException **   
A resource that is required for the action doesn't exist.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 400

 ** ServiceUnavailableException **   
The request failed due to a temporary failure of the server.    
 ** Context **   
  
 ** Type **   

HTTP Status Code: 500

## See Also
<a name="API_DescribeReportPlan_SeeAlso"></a>

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