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

get-blueprint-runs

Description

Retrieves the details of blueprint runs for a specified blueprint.

See also: AWS API Documentation

Synopsis

  get-blueprint-runs
--blueprint-name <value>
[--next-token <value>]
[--max-results <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

--blueprint-name (string)

The name of the blueprint.

--next-token (string)

A continuation token, if this is a continuation request.

--max-results (integer)

The maximum size of a list to return.

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

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

BlueprintRuns -> (list)

Returns a list of BlueprintRun objects.

(structure)

The details of a blueprint run.

BlueprintName -> (string)

The name of the blueprint.

RunId -> (string)

The run ID for this blueprint run.

WorkflowName -> (string)

The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.

State -> (string)

The state of the blueprint run. Possible values are:

  • Running — The blueprint run is in progress.
  • Succeeded — The blueprint run completed successfully.
  • Failed — The blueprint run failed and rollback is complete.
  • Rolling Back — The blueprint run failed and rollback is in progress.

StartedOn -> (timestamp)

The date and time that the blueprint run started.

CompletedOn -> (timestamp)

The date and time that the blueprint run completed.

ErrorMessage -> (string)

Indicates any errors that are seen while running the blueprint.

RollbackErrorMessage -> (string)

If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.

Parameters -> (string)

The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec .

RoleArn -> (string)

The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.

NextToken -> (string)

A continuation token, if not all blueprint runs have been returned.