pcluster get-image-log-events - Amazon ParallelCluster
Named arguments
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

pcluster get-image-log-events

Retrieve the events associated with an image build.

pcluster get-image-log-events [-h] 
                 --image-id IMAGE_ID                               
                 --log-stream-name LOG_STREAM_NAME
                [--debug]
                [--end-time END_TIME]
                [--limit LIMIT]
                [--next-token NEXT_TOKEN]                              
                [--query QUERY]                               
                [--region REGION]                              
                [--start-from-head START_FROM_HEAD]
                [--start-time START_TIME]

Named arguments

-h, --help

Shows the help text for pcluster get-image-log-events.

--image-id, -i IMAGE_ID

Specifies the Id of the image.

--log-stream-name LOG_STREAM_NAME

Specifies the name of the log stream. You can use the list-image-log-streams command to retrieve a log stream associated with an event or events.

--debug

Enables debug logging.

--end-time END_TIME

Specifies the end of the time range, expressed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ, for example 2021-01-01T20:00:00Z). Events with a timestamp equal to or later than this time are not included.

--limit LIMIT

Specifies the maximum number of log events returned. If a value is not specified, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

--next-token NEXT_TOKEN

Specifies the token to use for paginated requests.

--query QUERY

Specifies the JMESPath query to perform on the output.

--region, -r REGION

Specifies the Amazon Web Services Region to use. The Amazon Web Services Region must be specified, using the AWS_DEFAULT_REGION environment variable, the region setting in the [default] section of the ~/.aws/config file, or the --region parameter.

--start-from-head START_FROM_HEAD

If the value is true, the earliest log events are returned first. If the value is false, the most recent log events are returned first. (Defaults to false.)

--start-time START_TIME

Specifies the start of the time range, expressed in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ, for example 2021-01-01T20:00:00Z). Events with a timestamp equal to or later than this time are included.

Example using Amazon ParallelCluster version 3.1.2:

$ pcluster get-image-log-events --image-id custom-alinux2-image --region us-east-1 --log-stream-name 3.1.2/1 --limit 3
   {
  "nextToken": "f/36778317771100849897800729464621464113270312017760944178/s",
  "prevToken": "b/36778317766952911290874033560295820514557716777648586800/s",
  "events": [
    {
      "message": "ExecuteBash: FINISHED EXECUTION",
      "timestamp": "2022-04-05T22:13:26.633Z"
    },
    {
      "message": "Document arn:aws:imagebuilder:us-east-1:123456789012:component/parallelclusterimage-test-1234abcd-56ef-78gh-90ij-abcd1234efgh/3.1.2/1",
      "timestamp": "2022-04-05T22:13:26.741Z"
    },
    {
      "message": "TOE has completed execution successfully",
      "timestamp": "2022-04-05T22:13:26.819Z"
    }
  ]
}