DataZone / Client / put_environment_blueprint_configuration

put_environment_blueprint_configuration

DataZone.Client.put_environment_blueprint_configuration(**kwargs)

Writes the configuration for the specified environment blueprint in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.put_environment_blueprint_configuration(
    domainIdentifier='string',
    environmentBlueprintIdentifier='string',
    provisioningRoleArn='string',
    manageAccessRoleArn='string',
    environmentRolePermissionBoundary='string',
    enabledRegions=[
        'string',
    ],
    regionalParameters={
        'string': {
            'string': 'string'
        }
    },
    resourceConfigurations=[
        {
            'name': 'string',
            'description': 'string',
            'region': 'string',
            'parameters': {
                'string': 'string'
            }
        },
    ],
    allowUserProvidedConfigurations=True|False,
    globalParameters={
        'string': 'string'
    },
    provisioningConfigurations=[
        {
            'lakeFormationConfiguration': {
                'locationRegistrationRole': 'string',
                'locationRegistrationExcludeS3Locations': [
                    'string',
                ]
            }
        },
    ]
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain.

  • environmentBlueprintIdentifier (string) –

    [REQUIRED]

    The identifier of the environment blueprint.

  • provisioningRoleArn (string) – The ARN of the provisioning role.

  • manageAccessRoleArn (string) – The ARN of the manage access role.

  • environmentRolePermissionBoundary (string) – The environment role permissions boundary.

  • enabledRegions (list) –

    [REQUIRED]

    Specifies the enabled Amazon Web Services Regions.

    • (string) –

  • regionalParameters (dict) –

    The regional parameters in the environment blueprint.

    • (string) –

      • (dict) –

        • (string) –

          • (string) –

  • resourceConfigurations (list) –

    The resource configurations of the environment blueprint.

    • (dict) –

      The resource configuration that is used to configure the environment blueprint.

      • name (string) – [REQUIRED]

        The name of the resource configuration.

      • description (string) –

        The description of the resource configuration.

      • region (string) – [REQUIRED]

        The Amazon Web Services Region of the resource configuration.

      • parameters (dict) – [REQUIRED]

        The parameters of the resource configuration.

        • (string) –

          • (string) –

  • allowUserProvidedConfigurations (boolean) – Specifies whether user-provided resource configurations are allowed for the environment blueprint.

  • globalParameters (dict) –

    Region-agnostic environment blueprint parameters.

    • (string) –

      • (string) –

  • provisioningConfigurations (list) –

    The provisioning configuration of a blueprint.

    • (dict) –

      The provisioning configuration of the blueprint.

      Note

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

      • lakeFormationConfiguration (dict) –

        The Lake Formation configuration of the Data Lake blueprint.

        • locationRegistrationRole (string) –

          The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode.

        • locationRegistrationExcludeS3Locations (list) –

          Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

          • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'environmentBlueprintId': 'string',
    'provisioningRoleArn': 'string',
    'environmentRolePermissionBoundary': 'string',
    'manageAccessRoleArn': 'string',
    'enabledRegions': [
        'string',
    ],
    'regionalParameters': {
        'string': {
            'string': 'string'
        }
    },
    'allowUserProvidedConfigurations': True|False,
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'resourceConfigurations': [
        {
            'identifier': 'string',
            'name': 'string',
            'description': 'string',
            'region': 'string',
            'parameters': {
                'string': 'string'
            }
        },
    ],
    'provisioningConfigurations': [
        {
            'lakeFormationConfiguration': {
                'locationRegistrationRole': 'string',
                'locationRegistrationExcludeS3Locations': [
                    'string',
                ]
            }
        },
    ]
}

Response Structure

  • (dict) –

    • domainId (string) –

      The identifier of the Amazon DataZone domain.

    • environmentBlueprintId (string) –

      The identifier of the environment blueprint.

    • provisioningRoleArn (string) –

      The ARN of the provisioning role.

    • environmentRolePermissionBoundary (string) –

      The environment role permissions boundary.

    • manageAccessRoleArn (string) –

      The ARN of the manage access role.

    • enabledRegions (list) –

      Specifies the enabled Amazon Web Services Regions.

      • (string) –

    • regionalParameters (dict) –

      The regional parameters in the environment blueprint.

      • (string) –

        • (dict) –

          • (string) –

            • (string) –

    • allowUserProvidedConfigurations (boolean) –

      Specifies whether user-provided resource configurations are allowed for the environment blueprint.

    • createdAt (datetime) –

      The timestamp of when the environment blueprint was created.

    • updatedAt (datetime) –

      The timestamp of when the environment blueprint was updated.

    • resourceConfigurations (list) –

      The resource configurations of the environment blueprint.

      • (dict) –

        The details of the resource configuration.

        • identifier (string) –

          The identifier of the resource configuration.

        • name (string) –

          The name of the resource configuration.

        • description (string) –

          The description of the resource configuration.

        • region (string) –

          The Amazon Web Services Region of the resource configuration.

        • parameters (dict) –

          The parameters of the resource configuration.

          • (string) –

            • (string) –

    • provisioningConfigurations (list) –

      The provisioning configuration of a blueprint.

      • (dict) –

        The provisioning configuration of the blueprint.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: lakeFormationConfiguration. 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'}

        • lakeFormationConfiguration (dict) –

          The Lake Formation configuration of the Data Lake blueprint.

          • locationRegistrationRole (string) –

            The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode.

          • locationRegistrationExcludeS3Locations (list) –

            Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

            • (string) –

Exceptions