DataZone / Client / list_environment_blueprint_configurations

list_environment_blueprint_configurations

DataZone.Client.list_environment_blueprint_configurations(**kwargs)

Lists blueprint configurations for a Amazon DataZone environment.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain.

• maxResults (integer) – 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'domainId': 'string',
            'enabledRegions': [
                'string',
            ],
            'environmentBlueprintId': 'string',
            'manageAccessRoleArn': 'string',
            'provisioningConfigurations': [
                {
                    'lakeFormationConfiguration': {
                        'locationRegistrationExcludeS3Locations': [
                            'string',
                        ],
                        'locationRegistrationRole': 'string'
                    }
                },
            ],
            'provisioningRoleArn': 'string',
            'regionalParameters': {
                'string': {
                    'string': 'string'
                }
            },
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListEnvironmentBlueprintConfigurations action.

    • (dict) –

      The configuration details of an environment blueprint.

      • createdAt (datetime) –

        The timestamp of when an environment blueprint was created.

      • domainId (string) –

        The identifier of the Amazon DataZone domain in which an environment blueprint exists.

      • enabledRegions (list) –

        The enabled Amazon Web Services Regions specified in a blueprint configuration.

        • (string) –

      • environmentBlueprintId (string) –

        The identifier of the environment blueprint.

      • manageAccessRoleArn (string) –

        The ARN of the manage access role specified in the environment blueprint configuration.

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

            • locationRegistrationExcludeS3Locations (list) –

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

              • (string) –

            • locationRegistrationRole (string) –

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

      • provisioningRoleArn (string) –

        The ARN of the provisioning role specified in the environment blueprint configuration.

      • regionalParameters (dict) –

        The regional parameters of the environment blueprint.

        • (string) –

          • (dict) –

            • (string) –

              • (string) –

      • updatedAt (datetime) –

        The timestamp of when the environment blueprint was updated.

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

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException