AWS API Changes

2026/05/26 - Amazon DataZone - 3 updated api methods

Changes Added resourceConfigurations and allowUserProvidedConfigurations fields to environment blueprint configuration APIs, enabling customers who migrated from V1 to V2 domains to update resource configurations (such as lineage schedules) programmatically via the SDK.

GetEnvironmentBlueprintConfiguration (updated)

Link ¶
Changes (response)

{'allowUserProvidedConfigurations': 'boolean',
 'resourceConfigurations': [{'description': 'string',
                             'identifier': 'string',
                             'name': 'string',
                             'parameters': {'string': 'string'},
                             'region': 'string'}]}

Gets the blueprint configuration in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

client.get_environment_blueprint_configuration(
    domainIdentifier='string',
    environmentBlueprintIdentifier='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the Amazon DataZone domain where this blueprint exists.

type environmentBlueprintIdentifier:

string

param environmentBlueprintIdentifier:

[REQUIRED]

He ID of the blueprint.

rtype:

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 ID of the Amazon DataZone domain where this blueprint exists.
- environmentBlueprintId (string) --
  
  The ID of the blueprint.
- provisioningRoleArn (string) --
  
  The ARN of the provisioning role with which this blueprint is created.
- environmentRolePermissionBoundary (string) --
  
  The environment role permissions boundary.
- manageAccessRoleArn (string) --
  
  The ARN of the manage access role with which this blueprint is created.
- enabledRegions (list) --
  
  The Amazon Web Services regions in which this blueprint is enabled.
  - (string) --
- regionalParameters (dict) --
  
  The regional parameters of the 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 this blueprint was created.
- updatedAt (datetime) --
  
  The timestamp of when this blueprint was upated.
- 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) --

ListEnvironmentBlueprintConfigurations (updated)

Link ¶
Changes (response)

{'items': {'allowUserProvidedConfigurations': 'boolean',
           'resourceConfigurations': [{'description': 'string',
                                       'identifier': 'string',
                                       'name': 'string',
                                       'parameters': {'string': 'string'},
                                       'region': 'string'}]}}

Lists blueprint configurations for a Amazon DataZone environment.

See also: AWS API Documentation

Request Syntax

client.list_environment_blueprint_configurations(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string'
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type maxResults:

integer

param maxResults:

The maximum number of blueprint configurations to return in a single call to ListEnvironmentBlueprintConfigurations. When the number of configurations to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

type nextToken:

string

param nextToken:

When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            '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',
                        ]
                    }
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  The results of the ListEnvironmentBlueprintConfigurations action.
  - (dict) --
    
    The configuration details of an environment blueprint.
    - domainId (string) --
      
      The identifier of the Amazon DataZone domain in which an environment blueprint exists.
    - environmentBlueprintId (string) --
      
      The identifier of the environment blueprint.
    - provisioningRoleArn (string) --
      
      The ARN of the provisioning role specified in the environment blueprint configuration.
    - environmentRolePermissionBoundary (string) --
      
      The environment role permission boundary.
    - manageAccessRoleArn (string) --
      
      The ARN of the manage access role specified in the environment blueprint configuration.
    - enabledRegions (list) --
      
      The enabled Amazon Web Services Regions specified in a blueprint configuration.
      - (string) --
    - regionalParameters (dict) --
      
      The regional parameters of 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 an 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) --
- nextToken (string) --
  
  When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

PutEnvironmentBlueprintConfiguration (updated)

Link ¶
Changes (request, response)
Request

{'allowUserProvidedConfigurations': 'boolean',
 'resourceConfigurations': [{'description': 'string',
                             'name': 'string',
                             'parameters': {'string': 'string'},
                             'region': 'string'}]}

Response

{'allowUserProvidedConfigurations': 'boolean',
 'resourceConfigurations': [{'description': 'string',
                             'identifier': 'string',
                             'name': 'string',
                             'parameters': {'string': 'string'},
                             'region': 'string'}]}

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

See also: AWS API Documentation

Request Syntax

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',
                ]
            }
        },
    ]
)

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type environmentBlueprintIdentifier:

string

param environmentBlueprintIdentifier:

[REQUIRED]

The identifier of the environment blueprint.

type provisioningRoleArn:

string

param provisioningRoleArn:

The ARN of the provisioning role.

type manageAccessRoleArn:

string

param manageAccessRoleArn:

The ARN of the manage access role.

type environmentRolePermissionBoundary:

string

param environmentRolePermissionBoundary:

The environment role permissions boundary.

type enabledRegions:

list

param enabledRegions:

[REQUIRED]

Specifies the enabled Amazon Web Services Regions.

(string) --

type regionalParameters:

dict

param regionalParameters:

The regional parameters in the environment blueprint.

(string) --
- (dict) --
  - (string) --
    - (string) --

type resourceConfigurations:

list

param resourceConfigurations:

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

type allowUserProvidedConfigurations:

boolean

param allowUserProvidedConfigurations:

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

type globalParameters:

dict

param globalParameters:

Region-agnostic environment blueprint parameters.

(string) --
- (string) --

type provisioningConfigurations:

list

param provisioningConfigurations:

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

rtype:

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