get-extension¶
Description¶
Returns information about an AppConfig extension.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-extension
--extension-identifier <value>
[--version-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--extension-identifier (string)
The name, the ID, or the Amazon Resource Name (ARN) of the extension.
--version-number (integer)
The extension version number. If no version number was defined, AppConfig uses the highest 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. 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.
See ‘aws help’ for descriptions of global parameters.
Output¶
Id -> (string)
The system-generated ID of the extension.
Name -> (string)
The extension name.
VersionNumber -> (integer)
The extension version number.
Arn -> (string)
The system-generated Amazon Resource Name (ARN) for the extension.
Description -> (string)
Information about the extension.
Actions -> (map)
The actions defined in the extension.
key -> (string)
value -> (list)
(structure)
An action defines the tasks the extension performs during the AppConfig workflow. Each action includes an action point such as
ON_CREATE_HOSTED_CONFIGURATION,PRE_DEPLOYMENT, orON_DEPLOYMENT. Each action also includes a name, a URI to an Lambda function, and an Amazon Resource Name (ARN) for an Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACKName -> (string)
The action name.
Description -> (string)
Information about the action.
Uri -> (string)
The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.
RoleArn -> (string)
An Amazon Resource Name (ARN) for an Identity and Access Management assume role.
Parameters -> (map)
The parameters accepted by the extension. You specify parameter values when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociationAPI action. For Lambda extension actions, these parameters are included in the Lambda request object.key -> (string)
value -> (structure)
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide .
Description -> (string)
Information about the parameter.
Required -> (boolean)
A parameter value must be specified in the extension association.