[ aws . glue ]

get-blueprint

Description

Retrieves the details of a blueprint.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-blueprint
--name <value>
[--include-blueprint | --no-include-blueprint]
[--include-parameter-spec | --no-include-parameter-spec]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the blueprint.

--include-blueprint | --no-include-blueprint (boolean)

Specifies whether or not to include the blueprint in the response.

--include-parameter-spec | --no-include-parameter-spec (boolean)

Specifies whether or not to include the parameter specification.

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

See ‘aws help’ for descriptions of global parameters.

Output

Blueprint -> (structure)

Returns a Blueprint object.

Name -> (string)

The name of the blueprint.

Description -> (string)

The description of the blueprint.

CreatedOn -> (timestamp)

The date and time the blueprint was registered.

LastModifiedOn -> (timestamp)

The date and time the blueprint was last modified.

ParameterSpec -> (string)

A JSON string that indicates the list of parameter specifications for the blueprint.

BlueprintLocation -> (string)

Specifies the path in Amazon S3 where the blueprint is published.

BlueprintServiceLocation -> (string)

Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.

Status -> (string)

The status of the blueprint registration.

  • Creating — The blueprint registration is in progress.

  • Active — The blueprint has been successfully registered.

  • Updating — An update to the blueprint registration is in progress.

  • Failed — The blueprint registration failed.

ErrorMessage -> (string)

An error message.

LastActiveDefinition -> (structure)

When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

Description -> (string)

The description of the blueprint.

LastModifiedOn -> (timestamp)

The date and time the blueprint was last modified.

ParameterSpec -> (string)

A JSON string specifying the parameters for the blueprint.

BlueprintLocation -> (string)

Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.

BlueprintServiceLocation -> (string)

Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.