get-on-premises-instance¶

Description¶

Gets information about an on-premises instance.

Synopsis¶

  get-on-premises-instance
--instance-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--instance-name (string)

The name of the on-premises instance about which to get information.

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

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about an on-premises instance

The following get-on-premises-instance example retrieves information about the specified on-premises instance.

aws deploy get-on-premises-instance --instance-name AssetTag12010298EX

Output:

{
    "instanceInfo": {
    "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX",
        "tags": [
        {
            "Value": "CodeDeployDemo-OnPrem",
            "Key": "Name"
        }
        ],
        "instanceName": "AssetTag12010298EX",
        "registerTime": 1425579465.228,
        "instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh"
    }
}

Output¶

instanceInfo -> (structure)

Information about the on-premises instance.

instanceName -> (string)

The name of the on-premises instance.

iamSessionArn -> (string)

The ARN of the IAM session associated with the on-premises instance.

iamUserArn -> (string)

The IAM user ARN associated with the on-premises instance.

instanceArn -> (string)

The ARN of the on-premises instance.

registerTime -> (timestamp)

The time at which the on-premises instance was registered.

deregisterTime -> (timestamp)

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

tags -> (list)

The tags currently associated with the on-premises instance.

(structure)

Information about a tag.

Key -> (string)

The tag’s key.

Value -> (string)

The tag’s value.

Table of Contents

Feedback

User Guide