DataZone / Client / update_environment_blueprint

update_environment_blueprint

DataZone.Client.update_environment_blueprint(**kwargs)

Updates an environment blueprint in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.update_environment_blueprint(
    description='string',
    domainIdentifier='string',
    identifier='string',
    provisioningProperties={
        'cloudFormation': {
            'templateUrl': 'string'
        }
    },
    userParameters=[
        {
            'defaultValue': 'string',
            'description': 'string',
            'fieldType': 'string',
            'isEditable': True|False,
            'isOptional': True|False,
            'isUpdateSupported': True|False,
            'keyName': 'string'
        },
    ]
)

Parameters:

• description (string) – The description to be updated as part of the UpdateEnvironmentBlueprint action.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.

• identifier (string) –

  [REQUIRED]

  The identifier of the environment blueprint to be updated.

• provisioningProperties (dict) –

  The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: cloudFormation.

  • cloudFormation (dict) –

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

    • templateUrl (string) – [REQUIRED]

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

• userParameters (list) –

  The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.

  • (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) – [REQUIRED]

      The filed type of the parameter.

    • isEditable (boolean) –

      Specifies whether the parameter is editable.

    • isOptional (boolean) –

      Specifies whether the custom parameter is optional.

    • isUpdateSupported (boolean) –

      Specifies whether a parameter value can be updated after creation.

    • keyName (string) – [REQUIRED]

      The key name of the parameter.

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,
            'isUpdateSupported': True|False,
            'keyName': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • createdAt (datetime) –

    The timestamp of when the environment blueprint was created.

  • deploymentProperties (dict) –

    The deployment properties to be updated as part of the UpdateEnvironmentBlueprint action.

    • endTimeoutMinutes (integer) –

      The end timeout of the environment blueprint deployment.

    • startTimeoutMinutes (integer) –

      The start timeout of the environment blueprint deployment.

  • description (string) –

    The description to be updated as part of the UpdateEnvironmentBlueprint action.

  • glossaryTerms (list) –

    The glossary terms to be updated as part of the UpdateEnvironmentBlueprint action.

    • (string) –

  • id (string) –

    The identifier of the blueprint to be updated.

  • name (string) –

    The name to be updated as part of the UpdateEnvironmentBlueprint action.

  • provider (string) –

    The provider of the blueprint to be udpated.

  • provisioningProperties (dict) –

    The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.

    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 the blueprint was updated.

  • userParameters (list) –

    The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.

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

      • isUpdateSupported (boolean) –

        Specifies whether a parameter value can be updated after creation.

      • keyName (string) –

        The key name of the parameter.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ServiceQuotaExceededException

• DataZone.Client.exceptions.ConflictException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException