Returns the configuration, publish status, and preview status of a portal.
See also: AWS API Documentation
get-portal
--portal-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
--portal-id (string) [required]
The identifier of the portal.
Constraints:
- min:
10- max:
30- pattern:
[a-z0-9]+
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
portalId -> (string)
The identifier of the portal.
Constraints:
- min:
10- max:
30- pattern:
[a-z0-9]+
portalArn -> (string)
The ARN of the portal.
Constraints:
- min:
20- max:
1011
endpointConfiguration -> (structure)
The domain configuration of the portal.
domainName -> (string)
The custom domain name of the portal. Absent if the portal has no custom domain.
Constraints:
- min:
3- max:
256- pattern:
(([a-z0-9-]+\.)+[a-z0-9-]+)certificateArn -> (string)
The ARN of the ACM certificate for the custom domain. Absent if the portal has no custom domain.
Constraints:
- min:
10- max:
2048- pattern:
arn:aws[a-z\-]*:acm:[a-z0-9\-]+:[0-9]{12}:certificate/[a-zA-Z0-9\-]+portalDomainHostedZoneId -> (string) [required]
The ID of the hosted zone for the portal’s distribution. Use it to create an alias record for a custom domain.
Constraints:
- min:
1- max:
64portalDefaultDomainName -> (string) [required]
The default domain name assigned to the portal.
Constraints:
- min:
3- max:
256- pattern:
(([a-z0-9-]+\.)+[a-z0-9-]+)
authorization -> (structure)
How readers sign in to the portal, and whether fine-grained access control is on.
authorizationConfig -> (tagged union structure) [required]
Exactly one of the members is set:
nonefor no authorization, orcognitoConfigfor Cognito. Modeled as a union so the “exactly one” choice is enforced by type.Note
This is a Tagged Union structure. Only one of the following top level keys can be set:none,cognitoConfig.none -> (structure)
The portal is public and readers do not sign in.cognitoConfig -> (structure)
Readers sign in through an Amazon Cognito user pool.
userPoolArn -> (string) [required]
The ARN of the Cognito user pool.
Constraints:
- min:
20- max:
2048- pattern:
arn:aws[a-z\-]*:cognito-idp:[a-z0-9\-]+:[0-9]{12}:userpool/[\w-]+_[0-9a-zA-Z]+appClientId -> (string) [required]
The ID of the user pool app client the portal uses.
Constraints:
- min:
1- max:
128- pattern:
[\w+]+userPoolDomain -> (string) [required]
The domain of the user pool’s hosted sign-in pages.
Constraints:
- min:
20- max:
2048- pattern:
(([a-zA-Z0-9-]+\.)+[a-zA-Z0-9-]+)identityPoolId -> (string)
The ID of the Cognito identity pool. Required only for fine-grained access control.
Constraints:
- min:
1- max:
64- pattern:
[\w-]+:[0-9a-f-]+fineGrainedAccessControl -> (string) [required]
Whether access to individual products in the portal is controlled per reader.
Possible values:
ENABLEDDISABLED
portalContent -> (structure)
The portal’s display name, description, and theme.
displayName -> (string) [required]
The name shown in the portal, from 3 to 255 characters.
Constraints:
- min:
3- max:
255description -> (string)
A description of the portal, up to 1024 characters.
Constraints:
- min:
0- max:
1024theme -> (structure) [required]
The colors and logo of the portal.
customColors -> (structure) [required]
The colors used in the portal.
backgroundColor -> (string) [required]
The page background color.
Constraints:
- min:
1- max:
16navigationColor -> (string) [required]
The navigation pane color.
Constraints:
- min:
1- max:
16headerColor -> (string) [required]
The header color.
Constraints:
- min:
1- max:
16textColor -> (string) [required]
The text color.
Constraints:
- min:
1- max:
16accentColor -> (string) [required]
The color of links, buttons, and other highlighted elements.
Constraints:
- min:
1- max:
16errorValidationColor -> (string) [required]
The color of error and validation messages.
Constraints:
- min:
1- max:
16logoUploadedAt -> (timestamp)
When the portal logo was last uploaded. Absent if the portal has no logo.
includedProductArns -> (list)
The ARNs of the products the portal includes.
Constraints:
- min:
0- max:
200(string)
Constraints:
- min:
20- max:
1011- pattern:
arn:aws[a-z\-]*:apiportal:[a-z0-9\-]+:[0-9]{12}:products/[a-z0-9]{10,30}
publishStatus -> (string)
The publish status of the portal. Absent if the portal has never been published.
Possible values:
PUBLISHEDPUBLISH_IN_PROGRESSPUBLISH_FAILEDDISABLE_IN_PROGRESSDISABLE_FAILEDDISABLED
statusException -> (structure)
Failure detail attached to a Portal’s publish/preview status: a typed reason plus an optional human-readable message.
exception -> (string)
Treat any unrecognized value as INTERNAL_FAILURE.
Possible values:
INTERNAL_FAILUREUNSHARED_PRODUCT_EXCEPTIONCLOUDFRONT_DOMAIN_IN_USEMISSING_CLOUDFRONT_PERMISSIONSmessage -> (string)
A description of the failure.
Constraints:
- min:
1- max:
2048
updatedAt -> (timestamp)
When the resource was last updated.
publishedAt -> (timestamp)
When the portal was last published.
publishDescription -> (string)
The description supplied with the most recent publish request.
Constraints:
- min:
0- max:
1024
rumAppMonitorName -> (string)
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
Constraints:
- min:
0- max:
255
preview -> (structure)
The most recent preview of the portal. Absent if no preview has been created.
previewStatus -> (string) [required]
The status of the preview.
Possible values:
PREVIEW_IN_PROGRESSPREVIEW_FAILEDPREVIEW_READYstatusException -> (structure)
Failure detail attached to a Portal’s publish/preview status: a typed reason plus an optional human-readable message.
exception -> (string)
Treat any unrecognized value as INTERNAL_FAILURE.
Possible values:
INTERNAL_FAILUREUNSHARED_PRODUCT_EXCEPTIONCLOUDFRONT_DOMAIN_IN_USEMISSING_CLOUDFRONT_PERMISSIONSmessage -> (string)
A description of the failure.
Constraints:
- min:
1- max:
2048previewUrl -> (string)
The URL to view the preview. Present whenpreviewStatusisPREVIEW_READY.
tags -> (map)
Up to 50 tags per request, matching API Gateway’s limit of 50 tags per resource.
Constraints:
- min:
1- max:
50key -> (string)
A tag key of 1-128 Unicode characters, per the AWS tagging limits.
Constraints:
- min:
1- max:
128value -> (string)
A tag value of 0-256 Unicode characters, per the AWS tagging limits; an empty value is valid.
Constraints:
- min:
0- max:
256