Glue / Client / batch_get_blueprints

batch_get_blueprints#

Glue.Client.batch_get_blueprints(**kwargs)#

Retrieves information about a list of blueprints.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_blueprints(
    Names=[
        'string',
    ],
    IncludeBlueprint=True|False,
    IncludeParameterSpec=True|False
)
Parameters:

  • Names (list) –

    [REQUIRED]

    A list of blueprint names.

    • (string) –

  • IncludeBlueprint (boolean) – Specifies whether or not to include the blueprint in the response.

  • IncludeParameterSpec (boolean) – Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.

Return type:

dict

Returns:

Response Syntax

{
    'Blueprints': [
        {
            'Name': 'string',
            'Description': 'string',
            'CreatedOn': datetime(2015, 1, 1),
            'LastModifiedOn': datetime(2015, 1, 1),
            'ParameterSpec': 'string',
            'BlueprintLocation': 'string',
            'BlueprintServiceLocation': 'string',
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'FAILED',
            'ErrorMessage': 'string',
            'LastActiveDefinition': {
                'Description': 'string',
                'LastModifiedOn': datetime(2015, 1, 1),
                'ParameterSpec': 'string',
                'BlueprintLocation': 'string',
                'BlueprintServiceLocation': 'string'
            }
        },
    ],
    'MissingBlueprints': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • Blueprints (list) –

      Returns a list of blueprint as a Blueprints object.

      • (dict) –

        The details of a blueprint.

        • Name (string) –

          The name of the blueprint.

        • Description (string) –

          The description of the blueprint.

        • CreatedOn (datetime) –

          The date and time the blueprint was registered.

        • LastModifiedOn (datetime) –

          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 (dict) –

          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 (datetime) –

            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.

    • MissingBlueprints (list) –

      Returns a list of BlueprintNames that were not found.

      • (string) –

Exceptions