[ aws . greengrassv2 ]

get-component

Description

Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-component
[--recipe-output-format <value>]
--arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--recipe-output-format (string)

The format of the recipe.

Possible values:

• JSON

• YAML

--arn (string)

The ARN of the component version.

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

See ‘aws help’ for descriptions of global parameters.

Output

recipeOutputFormat -> (string)

The format of the recipe.

recipe -> (blob)

The recipe of the component version.

tags -> (map)

A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide .

key -> (string)

value -> (string)