[ aws . apigateway ]
get-sdk-type¶
Synopsis¶
get-sdk-type
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--id (string)
[Required] The identifier of the queried SdkType instance.
--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¶
id -> (string)
The identifier of an SdkType instance.
friendlyName -> (string)
The user-friendly name of an SdkType instance.
description -> (string)
The description of an SdkType .
configurationProperties -> (list)
A list of configuration properties of an SdkType .
(structure)
A configuration property of an SDK type.
name -> (string)
The name of a an SdkType configuration property.
friendlyName -> (string)
The user-friendly name of an SdkType configuration property.
description -> (string)
The description of an SdkType configuration property.
required -> (boolean)
A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (
true) or not (false).defaultValue -> (string)
The default value of an SdkType configuration property.