Publish
Represents publishing a portal.
URI
/v2/portals/portalId/publish
HTTP methods
POST
Operation ID: PublishPortal
Publishes a portal.
| Name | Type | Required | Description |
|---|---|---|---|
portalId | String | True | The portal identifier. |
| 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. |
DELETE
Operation ID: DisablePortal
Deletes the publication of a portal portal.
| Name | Type | Required | Description |
|---|---|---|---|
portalId | String | True | The portal identifier. |
| Status code | Response model | Description |
|---|---|---|
204 | None | The request has succeeded, and there is no additional content to send in the response payload body. |
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
Request bodies
{ "description": "string" }
Response bodies
{ "message": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
Properties
AccessDeniedExceptionResponseContent
The error message.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | The message. |
BadRequestExceptionResponseContent
The response content for bad request exception.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | The message of the bad request exception response content. |
ConflictExceptionResponseContent
The resource identifier.
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False | The error message. |
LimitExceededExceptionResponseContent
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
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. |
PublishPortalRequestContent
Publish a portal.
| Property | Type | Required | Description |
|---|---|---|---|
description | string MinLength: 0 MaxLength: 1024 | False | The description of the portal. When the portal is published, this description becomes the last published description. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
PublishPortal
DisablePortal
