# Preview
<a name="portals-portalid-preview"></a>

Represents a portal preview.

## URI
<a name="portals-portalid-preview-url"></a>

`/v2/portals/portalId/preview`

## HTTP methods
<a name="portals-portalid-preview-http-methods"></a>

### POST
<a name="portals-portalid-previewpost"></a>

**Operation ID:** `PreviewPortal`

Creates a portal preview.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| portalId | String | True | The portal identifier. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 202 | None | 202 response | 
| 400 | BadRequestExceptionResponseContent | One of the parameters in the request is invalid. | 
| 403 | AccessDeniedExceptionResponseContent | 403 response | 
| 404 | NotFoundExceptionResponseContent | The resource specified in the request was not found. | 
| 409 | ConflictExceptionResponseContent | The resource already exists. | 
| 429 | LimitExceededExceptionResponseContent | The client is sending more than the allowed number of requests per unit of time. | 

## Schemas
<a name="portals-portalid-preview-schemas"></a>

### Response bodies
<a name="portals-portalid-preview-response-examples"></a>

#### BadRequestExceptionResponseContent schema
<a name="portals-portalid-preview-response-body-badrequestexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### AccessDeniedExceptionResponseContent schema
<a name="portals-portalid-preview-response-body-accessdeniedexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
<a name="portals-portalid-preview-response-body-notfoundexceptionresponsecontent-example"></a>

```
{
  "message": "string",
  "resourceType": "string"
}
```

#### ConflictExceptionResponseContent schema
<a name="portals-portalid-preview-response-body-conflictexceptionresponsecontent-example"></a>

```
{
  "message": "string"
}
```

#### LimitExceededExceptionResponseContent schema
<a name="portals-portalid-preview-response-body-limitexceededexceptionresponsecontent-example"></a>

```
{
  "message": "string",
  "limitType": "string"
}
```

## Properties
<a name="portals-portalid-preview-properties"></a>

### AccessDeniedExceptionResponseContent
<a name="portals-portalid-preview-model-accessdeniedexceptionresponsecontent"></a>

The error message.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The message. | 

### BadRequestExceptionResponseContent
<a name="portals-portalid-preview-model-badrequestexceptionresponsecontent"></a>

The response content for bad request exception.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The message of the bad request exception response content. | 

### ConflictExceptionResponseContent
<a name="portals-portalid-preview-model-conflictexceptionresponsecontent"></a>

The resource identifier.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The error message. | 

### LimitExceededExceptionResponseContent
<a name="portals-portalid-preview-model-limitexceededexceptionresponsecontent"></a>

The response content for limit exceeded exception.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| limitType | string | False | The limit type of the limit exceeded exception response content. | 
| message | string | False | The message of the limit exceeded exception response content. | 

### NotFoundExceptionResponseContent
<a name="portals-portalid-preview-model-notfoundexceptionresponsecontent"></a>

The response content for not found exception.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| message | string | False | The message of the not found exception response content. | 
| resourceType | string | False | The resource type of the not found exception response content. | 

## See also
<a name="portals-portalid-preview-see-also"></a>

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

### PreviewPortal
<a name="PreviewPortal-see-also"></a>
+ [AWS Command Line Interface V2](/goto/cli2/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for Python](/goto/boto3/apigatewayv2-2018-11-29/PreviewPortal)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/apigatewayv2-2018-11-29/PreviewPortal)