[ aws . apiportal ]

create-product-api-page

Description

Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use status to track it.

See also: AWS API Documentation

Synopsis

  create-product-api-page
--product-id <value>
--managed-api-id <value>
[--display-content <value>]
[--try-it-state <value>]
[--tags <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]

Options

--product-id (string) [required]

The identifier of the product.

Constraints:

  • min: 10
  • max: 30
  • pattern: [a-z0-9]+

--managed-api-id (string) [required]

The Managed API this page documents. It must already be associated with the product, and the page’s API identifier is taken from the Managed API rather than supplied by the caller.

Constraints:

  • min: 10
  • max: 30
  • pattern: [a-z0-9]+

--display-content (tagged union structure)

Exactly one of the members is set: none to use default display content, or overrides to customize it. 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, overrides.

none -> (structure)

Use the content generated from the Managed API.

overrides -> (structure)

Replace the generated content with your own.

operationName -> (string)

The operation name shown as the page title, from 1 to 255 characters.

Constraints:

  • min: 1
  • max: 255

apiUrl -> (string)

The invoke URL shown on the page and used for Try-It and the portal’s allowed-domain list: http(s)://host[:port][/path], with no whitespace, quotes or angle brackets. On this request member only, as ApiEndpoint is also returned in responses.

Constraints:

  • min: 1
  • max: 1024
  • pattern: https?://[A-Za-z0-9.-]+(:[0-9]{1,5})?(/[^\s<>"'`]*)?

body -> (string)

The Markdown body of the page, from 1 to 32,768 characters.

Constraints:

  • min: 1
  • max: 32768

Shorthand Syntax:

none={},overrides={operationName=string,apiUrl=string,body=string}

JSON Syntax:

{
  "none": {

  },
  "overrides": {
    "operationName": "string",
    "apiUrl": "string",
    "body": "string"
  }
}

--try-it-state (string)

Whether readers can call the API from the page with Try-It. Defaults to DISABLED . To enable it, the page’s API URL must use HTTPS on a domain that supports Try-It.

Possible values:

  • ENABLED
  • DISABLED

--tags (map)

Up to 50 tags per request, matching API Gateway’s limit of 50 tags per resource.

Constraints:

  • min: 1
  • max: 50

key -> (string)

A tag key of 1-128 Unicode characters, per the AWS tagging limits.

Constraints:

  • min: 1
  • max: 128

value -> (string)

A tag value of 0-256 Unicode characters, per the AWS tagging limits; an empty value is valid.

Constraints:

  • min: 0
  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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.

Global Options

--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.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--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.

  • on
  • off
  • auto

--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.

  • base64
  • raw-in-base64-out

--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.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

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: 4096

method -> (string) [required]

The HTTP method of the API.

Constraints:

  • min: 1
  • max: 20

resourceArn -> (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: 255

apiUrl -> (string) [required]

The invoke URL shown on the page and used by Try-It.

Constraints:

  • min: 1
  • max: 1024

body -> (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:

  • ENABLED
  • DISABLED

updatedAt -> (timestamp)

When the resource was last updated.

status -> (string)

The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED .

Possible values:

  • AVAILABLE
  • IN_PROGRESS
  • FAILED

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_FAILURE
  • RESOURCE_DELETED
  • MEMBER_LEFT_ORG

message -> (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: 50

key -> (string)

A tag key of 1-128 Unicode characters, per the AWS tagging limits.

Constraints:

  • min: 1
  • max: 128

value -> (string)

A tag value of 0-256 Unicode characters, per the AWS tagging limits; an empty value is valid.

Constraints:

  • min: 0
  • max: 256