get-product-api-page
--product-id <value>
--product-api-page-id <value>
[--resource-owner-account-id <value>]
[--include-raw-display-content | --no-include-raw-display-content]
[--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]
--product-id (string) [required]
The identifier of the product.
Constraints:
- min:
10- max:
30- pattern:
[a-z0-9]+
--product-api-page-id (string) [required]
The identifier of the API page.
Constraints:
- min:
10- max:
30- pattern:
[a-z0-9]+
--resource-owner-account-id (string)
The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.
Constraints:
- pattern:
[0-9]{12}
--include-raw-display-content | --no-include-raw-display-content (boolean)
Set totrueto also return the page body inrawDisplayContent.
--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.
productApiPageId -> (string)
The identifier of the API page.
Constraints:
- min:
10- max:
30- pattern:
[a-z0-9]+
productApiPageArn -> (string)
The ARN of the API page.
Constraints:
- min:
20- max:
1011- pattern:
arn:aws[a-z\-]*:apiportal:[a-z0-9\-]+:[0-9]{12}:products/[a-z0-9]{10,30}/apipages/[a-z0-9]{10,30}
apiId -> (structure)
The API the page documents.
identifierParts -> (structure)
The resource, method, and path that identify the API.
path -> (string) [required]
The request path of the API.
Constraints:
- min:
1- max:
4096method -> (string) [required]
The HTTP method of the API.
Constraints:
- min:
1- max:
20resourceArn -> (string) [required]
The ARN of the resource that serves the API.
Constraints:
- min:
20- max:
2048- pattern:
arn:aws[a-z\-]*:[a-z0-9\-]+:[a-z0-9\-]*:([0-9]{12})?:.+
displayContent -> (structure)
The content shown on the page.
operationName -> (string)
The operation name shown as the page title.
Constraints:
- min:
1- max:
255apiUrl -> (string) [required]
The invoke URL shown on the page and used by Try-It.
Constraints:
- min:
1- max:
1024body -> (string)
The Markdown body of the page. Absent while the page is
IN_PROGRESS.Constraints:
- min:
1- max:
32768
tryItState -> (string)
Whether Try-It is enabled on the page.
Possible values:
ENABLEDDISABLED
updatedAt -> (timestamp)
When the resource was last updated.
status -> (string)
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED.Possible values:
AVAILABLEIN_PROGRESSFAILED
rawDisplayContent -> (string)
The Markdown body of the page. Returned only whenincludeRawDisplayContentistrue.
statusException -> (structure)
Failure detail attached to a ProductApiPage’s status: a typed reason plus an optional human-readable message.
exception -> (string)
treat any unrecognized value as INTERNAL_FAILURE.
Possible values:
INTERNAL_FAILURERESOURCE_DELETEDMEMBER_LEFT_ORGmessage -> (string)
A description of the failure.
Constraints:
- min:
1- max:
2048
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