DataZone / Client / get_environment_blueprint

get_environment_blueprint#

DataZone.Client.get_environment_blueprint(**kwargs)#

Gets an Amazon DataZone blueprint.

See also: AWS API Documentation

Request Syntax

response = client.get_environment_blueprint(
    domainIdentifier='string',
    identifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the domain in which this blueprint exists.

  • identifier (string) –

    [REQUIRED]

    The ID of this Amazon DataZone blueprint.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'deploymentProperties': {
        'endTimeoutMinutes': 123,
        'startTimeoutMinutes': 123
    },
    'description': 'string',
    'glossaryTerms': [
        'string',
    ],
    'id': 'string',
    'name': 'string',
    'provider': 'string',
    'provisioningProperties': {
        'cloudFormation': {
            'templateUrl': 'string'
        }
    },
    'updatedAt': datetime(2015, 1, 1),
    'userParameters': [
        {
            'defaultValue': 'string',
            'description': 'string',
            'fieldType': 'string',
            'isEditable': True|False,
            'isOptional': True|False,
            'keyName': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • createdAt (datetime) –

      A timestamp of when this blueprint was created.

    • deploymentProperties (dict) –

      The deployment properties of this Amazon DataZone blueprint.

      • endTimeoutMinutes (integer) –

        The end timeout of the environment blueprint deployment.

      • startTimeoutMinutes (integer) –

        The start timeout of the environment blueprint deployment.

    • description (string) –

      The description of this Amazon DataZone blueprint.

    • glossaryTerms (list) –

      The glossary terms attached to this Amazon DataZone blueprint.

      • (string) –

    • id (string) –

      The ID of this Amazon DataZone blueprint.

    • name (string) –

      The name of this Amazon DataZone blueprint.

    • provider (string) –

      The provider of this Amazon DataZone blueprint.

    • provisioningProperties (dict) –

      The provisioning properties of this Amazon DataZone blueprint.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: cloudFormation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • cloudFormation (dict) –

        The cloud formation properties included as part of the provisioning properties of an environment blueprint.

        • templateUrl (string) –

          The template URL of the cloud formation provisioning properties of the environment blueprint.

    • updatedAt (datetime) –

      The timestamp of when this blueprint was updated.

    • userParameters (list) –

      The user parameters of this blueprint.

      • (dict) –

        The details of user parameters of an environment blueprint.

        • defaultValue (string) –

          The default value of the parameter.

        • description (string) –

          The description of the parameter.

        • fieldType (string) –

          The filed type of the parameter.

        • isEditable (boolean) –

          Specifies whether the parameter is editable.

        • isOptional (boolean) –

          Specifies whether the custom parameter is optional.

        • keyName (string) –

          The key name of the parameter.

Exceptions