[ aws . apiportal ]

get-api-inventory-item

Description

Gets full details of a single API inventory item.

See also: AWS API Documentation

Synopsis

  get-api-inventory-item
--method <value>
--host <value>
--port <value>
--path <value>
--resource-arn <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

--method (string) [required]

The HTTP method of the API.

Possible values:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • ANY
  • HEAD
  • OPTIONS

--host (string) [required]

A discovered API’s front-door hostname (e.g. an ALB, CloudFront, or API Gateway DNS name), bounded by the DNS name limit (RFC 1035). Usually literal, but may contain placeholders: <> - stands for one dot-separated part of the hostname. When 10 or more hosts differ only in that part, they fold into one, e.g. a.example.com, b.example.com, … become “<>.example.com”. Deeper levels fold the same way (“<>.<>.example.com”). The registrable domain never folds. - an IP-literal host.

Constraints:

  • min: 1
  • max: 253
  • pattern: [A-Za-z0-9.<>*-]+

--port (integer) [required]

The port the API listens on, from 0 to 65535.

Constraints:

  • min: 0
  • max: 65535

--path (string) [required]

The request path of the API.

Constraints:

  • min: 1
  • max: 4096

--resource-arn (string) [required]

The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws[a-z\-]*:[a-z0-9\-]+:[a-z0-9\-]*:([0-9]{12})?:.+

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

item -> (structure)

The details of the API inventory item.

method -> (string) [required]

The HTTP method of the API.

Possible values:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • ANY
  • HEAD
  • OPTIONS

host -> (string) [required]

A discovered API’s front-door hostname (e.g. an ALB, CloudFront, or API Gateway DNS name), bounded by the DNS name limit (RFC 1035). Usually literal, but may contain placeholders: <> - stands for one dot-separated part of the hostname. When 10 or more hosts differ only in that part, they fold into one, e.g. a.example.com, b.example.com, … become “<>.example.com”. Deeper levels fold the same way (“<>.<>.example.com”). The registrable domain never folds. - an IP-literal host.

Constraints:

  • min: 1
  • max: 253
  • pattern: [A-Za-z0-9.<>*-]+

port -> (integer) [required]

The port the API listens on, from 0 to 65535.

path -> (string) [required]

The request path of the API.

Constraints:

  • min: 1
  • max: 4096

accountId -> (string) [required]

The AWS account ID that owns the API.

Constraints:

  • pattern: [0-9]{12}

resourceArn -> (string) [required]

The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws[a-z\-]*:[a-z0-9\-]+:[a-z0-9\-]*:([0-9]{12})?:.+

region -> (string) [required]

The AWS Region the API was discovered in.

discoverySource -> (string) [required]

The AWS service that is the SOURCE of discovered APIs — i.e. the front-door service type whose resources discovery crawls to find APIs. New source services may be added over time, so clients MUST treat any unrecognized value gracefully.

Possible values:

  • API_GATEWAY
  • ELB
  • CLOUDFRONT

visibility -> (string)

Whether a discovered API is reachable publicly or only from within a private network.

Possible values:

  • PUBLIC
  • PRIVATE

wafStatus -> (string)

Whether a WAF web ACL is attached to the API’s front-door service.

Possible values:

  • ENABLED
  • DISABLED

classification -> (string)

Whether any account has created a ManagedApi for a discovered API, and for a managed API whether it is unused or no longer in the caller’s organization. SHADOW - no account has created a ManagedApi for this item. MANAGED - some account in the caller’s organization has created a ManagedApi for this item. MANAGED_ZOMBIE - managed and unused: no traffic for at least the account’s no-traffic window. The API is still reachable, so this clears once traffic resumes. MANAGED_ORPHANED - managed, but the account hosting the API has left the caller’s organization or been closed. The item is a last-known snapshot: it is no longer rediscovered, and its findings are not authorized for the caller. An organizational unit move is not a trigger.

MANAGED_ZOMBIE and MANAGED_ORPHANED add detail to a MANAGED item, so neither is returned for an item the caller does not manage, and MANAGED_ORPHANED takes priority over MANAGED_ZOMBIE. Both are derived per request rather than stored, so neither expires on its own.

Possible values:

  • SHADOW
  • MANAGED
  • MANAGED_ZOMBIE
  • MANAGED_ORPHANED

managedBy -> (string)

Who manages a MANAGED item, relative to the caller. Absent when the item is SHADOW. SELF - the caller account has created the ManagedApi. ORGANIZATION - some other account in the caller’s organization has, but the caller has not.

Possible values:

  • SELF
  • ORGANIZATION

workloads -> (list)

AI protocols seen in this API’s traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.

(string)

An AI protocol seen in an API’s traffic, detected by the front door from request or response headers (and, for A2A, a query parameter). MCP - Model Context Protocol. LLM - traffic to or from an LLM inference server or gateway. A2A - Agent2Agent protocol.

Possible values:

  • MCP
  • LLM
  • A2A

managedApiId -> (string)

The identifier of the Managed API created from this API. Absent if there is none.

Constraints:

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