AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lightsail ]

get-setup-history

Description

Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.

See also: AWS API Documentation

Synopsis

  get-setup-history
--resource-name <value>
[--page-token <value>]
[--cli-input-json <value>]
[--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>]

Options

--resource-name (string)

The name of the resource for which you are requesting information.

--page-token (string)

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetSetupHistory request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

setupHistory -> (list)

The historical information that's returned.

(structure)

Returns a list of the commands that were ran on the target resource.

The status of each command is also returned.

operationId -> (string)

A GUID that's used to identify the operation.

request -> (structure)

Information about the specified request.

instanceName -> (string)

The name of the Lightsail instance.

domainNames -> (list)

The name of the domain and subdomains that the SSL/TLS certificate secures.

(string)

certificateProvider -> (string)

The Certificate Authority (CA) that issues the SSL/TLS certificate.

resource -> (structure)

The target resource name for the request.

name -> (string)

The name of the Lightsail resource.

arn -> (string)

The Amazon Resource Name (ARN) of the Lightsail resource.

createdAt -> (timestamp)

The timestamp for when the resource was created.

location -> (structure)

Describes the resource location.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The Amazon Web Services Region name.

resourceType -> (string)

The Lightsail resource type. For example, Instance .

executionDetails -> (list)

Describes the full details of the request.

(structure)

Returns details about the commands that were run.

command -> (string)

The command that was executed.

dateTime -> (timestamp)

The timestamp for when the request was run.

name -> (string)

The name of the target resource.

status -> (string)

The status of the SetupInstanceHttps request.

standardError -> (string)

The text written by the command to stderr.

standardOutput -> (string)

The text written by the command to stdout.

version -> (string)

The current version of the script..

status -> (string)

The status of the request.

nextPageToken -> (string)

The token to advance to the next page of results from your request.

A next page token is not returned if there are no more results to display.

To get the next page of results, perform another GetSetupHistory request and specify the next page token using the pageToken parameter.