[ aws . apiportal ]

create-product¶

Description¶

Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.

See also: AWS API Documentation

Synopsis¶

  create-product
--display-name <value>
[--description <value>]
[--tags <value>]
[--api-selection-configuration <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¶

--display-name (string) [required]

The name of the product, from 1 to 255 characters.

Constraints:

  • min: 1
  • max: 255

--description (string)

A description of the product, up to 1024 characters.

Constraints:

  • min: 0
  • max: 1024

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

--api-selection-configuration (structure)

How Managed APIs are selected for the product. The selection mode can’t be changed after the product is created.

apiSelectionMode -> (string) [required]

How a product’s member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

Fixed at create time. UpdateProduct cannot change the mode of an existing product.

Possible values:

  • CUSTOM
  • RULE_BASED

ruleFilters -> (list)

Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account’s Managed APIs. Replaced as a whole on update, not merged.

Constraints:

  • min: 1
  • max: 6

(structure)

Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

key -> (string) [required]

The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

Possible values:

  • RESOURCE_ARN
  • HOST
  • METHOD
  • PATH
  • PORT
  • ACCOUNT

values -> (list) [required]

The values to match. The filter matches when the attribute equals any of them.

Constraints:

  • min: 1
  • max: 10

(string)

Bounded by the longest matchable attribute, apiSignature.path.

No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

Constraints:

  • min: 1
  • max: 4096
  • pattern: \S+

JSON Syntax:

{
  "apiSelectionMode": "CUSTOM"|"RULE_BASED",
  "ruleFilters": [
    {
      "key": "RESOURCE_ARN"|"HOST"|"METHOD"|"PATH"|"PORT"|"ACCOUNT",
      "values": ["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¶

productId -> (string)

The identifier of the product.

Constraints:

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

productArn -> (string)

The ARN of the product.

Constraints:

  • min: 20
  • max: 1011
  • pattern: arn:aws[a-z\-]*:apiportal:[a-z0-9\-]+:[0-9]{12}:products/[a-z0-9]{10,30}

displayName -> (string)

The name of the product, from 1 to 255 characters.

Constraints:

  • min: 1
  • max: 255

displayOrder -> (structure)

The order of the product’s pages and API page sections in the portal navigation.

overviewPageArn -> (string)

The ARN of the product page shown as the product overview.

Constraints:

  • min: 20
  • max: 1011
  • pattern: arn:aws[a-z\-]*:apiportal:[a-z0-9\-]+:[0-9]{12}:products/[a-z0-9]{10,30}/productpages/[a-z0-9]{10,30}

productPageArns -> (list)

A product has at most DocHubLimits.DEFAULT_PAGES_PER_PRODUCT_LIMIT (40) pages, enforced by LimitsHelper.

Constraints:

  • min: 0
  • max: 40

(string)

Constraints:

  • min: 20
  • max: 1011
  • pattern: arn:aws[a-z\-]*:apiportal:[a-z0-9\-]+:[0-9]{12}:products/[a-z0-9]{10,30}/productpages/[a-z0-9]{10,30}

contents -> (list)

Sections in a product’s navigation. No service-side limit exists today; this bound caps request size.

Constraints:

  • min: 0
  • max: 100

(structure)

A named group of API pages in the portal navigation.

sectionName -> (string)

Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).

Constraints:

  • min: 1
  • max: 255
  • pattern: [^\u0000-\u001F\u007F]+

productApiPageArns -> (list)

API pages in one section. No service-side limit exists today; this bound caps request size.

Constraints:

  • min: 0
  • max: 1000

(string)

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}

description -> (string)

A description of the product, up to 1024 characters.

Constraints:

  • min: 0
  • max: 1024

updatedAt -> (timestamp)

When the resource was last updated.

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

apiSelectionConfiguration -> (structure)

How Managed APIs are selected for the product.

apiSelectionMode -> (string) [required]

How a product’s member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

Fixed at create time. UpdateProduct cannot change the mode of an existing product.

Possible values:

  • CUSTOM
  • RULE_BASED

ruleFilters -> (list)

Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account’s Managed APIs. Replaced as a whole on update, not merged.

Constraints:

  • min: 1
  • max: 6

(structure)

Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

key -> (string) [required]

The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

Possible values:

  • RESOURCE_ARN
  • HOST
  • METHOD
  • PATH
  • PORT
  • ACCOUNT

values -> (list) [required]

The values to match. The filter matches when the attribute equals any of them.

Constraints:

  • min: 1
  • max: 10

(string)

Bounded by the longest matchable attribute, apiSignature.path.

No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

Constraints:

  • min: 1
  • max: 4096
  • pattern: \S+

status -> (string)

Whether the product’s member APIs match its apiSelectionConfiguration. ACTIVE - membership matches. The only status a CUSTOM product reports. IN_PROGRESS - ruleFilters changed and membership is still being evaluated. FAILED - evaluation could not finish and membership is incomplete; failureReason says why.

Possible values:

  • ACTIVE
  • IN_PROGRESS
  • FAILED

failureReason -> (string)

Reason a product’s rules could not be fully applied, present only when status is FAILED . New reasons may be added over time, so clients MUST treat any unrecognized value as UNKNOWN and fall back to generic handling.

Possible values:

  • API_PAGE_ATTACHED
  • EVALUATION_ERROR