Amazon DataZone

2024/07/22 - Amazon DataZone - 5 new3 updated api methods

Changes  This release adds 1/ support of register S3 locations of assets in AWS Lake Formation hybrid access mode for DefaultDataLake blueprint. 2/ support of CRUD operations for Asset Filters.

UpdateAssetFilter (new) Link ¶

Updates an asset filter.

See also: AWS API Documentation

Request Syntax

client.update_asset_filter(
    assetIdentifier='string',
    configuration={
        'columnConfiguration': {
            'includedColumnNames': [
                'string',
            ]
        },
        'rowConfiguration': {
            'rowFilter': {
                'and': [
                    {'... recursive ...'},
                ],
                'expression': {
                    'equalTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'in': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'isNotNull': {
                        'columnName': 'string'
                    },
                    'isNull': {
                        'columnName': 'string'
                    },
                    'lessThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'lessThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'like': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notIn': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'notLike': {
                        'columnName': 'string',
                        'value': 'string'
                    }
                },
                'or': [
                    {'... recursive ...'},
                ]
            },
            'sensitive': True|False
        }
    },
    description='string',
    domainIdentifier='string',
    identifier='string',
    name='string'
)
type assetIdentifier:

string

param assetIdentifier:

[REQUIRED]

The ID of the data asset.

type configuration:

dict

param configuration:

The configuration of the asset filter.

  • columnConfiguration (dict) --

    The column configuration of the asset filter.

    • includedColumnNames (list) --

      Specifies whether to include column names.

      • (string) --

  • rowConfiguration (dict) --

    The row configuration of the asset filter.

    • rowFilter (dict) -- [REQUIRED]

      The row filter.

      • and (list) --

        The 'and' clause of the row filter.

        • (dict) --

          The row filter.

      • expression (dict) --

        The expression of the row filter.

        • equalTo (dict) --

          The 'equal to' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be equal to an expression.

        • greaterThan (dict) --

          The 'greater than' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be greater than an expression.

        • greaterThanOrEqualTo (dict) --

          The 'greater than or equal to' clause of the filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be greater than or equal to an expression.

        • in (dict) --

          The 'in' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • values (list) -- [REQUIRED]

            The values that might be in the expression.

            • (string) --

        • isNotNull (dict) --

          The 'is not null' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

        • isNull (dict) --

          The 'is null' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

        • lessThan (dict) --

          The 'less than' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be less than the expression.

        • lessThanOrEqualTo (dict) --

          The 'less than or equal to' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be less than or equal to an expression.

        • like (dict) --

          The 'like' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be like the expression.

        • notEqualTo (dict) --

          The 'no equal to' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might not be equal to the expression.

        • notIn (dict) --

          The 'not in' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • values (list) -- [REQUIRED]

            The value that might not be in the expression.

            • (string) --

        • notLike (dict) --

          The 'not like' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might not be like the expression.

      • or (list) --

        The 'or' clause of the row filter.

        • (dict) --

          The row filter.

    • sensitive (boolean) --

      Specifies whether the row filter is sensitive.

type description:

string

param description:

The description of the asset filter.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where you want to update an asset filter.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the asset filter.

type name:

string

param name:

The name of the asset filter.

rtype:

dict

returns:

Response Syntax

{
    'assetId': 'string',
    'configuration': {
        'columnConfiguration': {
            'includedColumnNames': [
                'string',
            ]
        },
        'rowConfiguration': {
            'rowFilter': {
                'and': [
                    {'... recursive ...'},
                ],
                'expression': {
                    'equalTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'in': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'isNotNull': {
                        'columnName': 'string'
                    },
                    'isNull': {
                        'columnName': 'string'
                    },
                    'lessThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'lessThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'like': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notIn': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'notLike': {
                        'columnName': 'string',
                        'value': 'string'
                    }
                },
                'or': [
                    {'... recursive ...'},
                ]
            },
            'sensitive': True|False
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'domainId': 'string',
    'effectiveColumnNames': [
        'string',
    ],
    'effectiveRowFilter': 'string',
    'errorMessage': 'string',
    'id': 'string',
    'name': 'string',
    'status': 'VALID'|'INVALID'
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the data asset.

    • configuration (dict) --

      The configuration of the asset filter.

      • columnConfiguration (dict) --

        The column configuration of the asset filter.

        • includedColumnNames (list) --

          Specifies whether to include column names.

          • (string) --

      • rowConfiguration (dict) --

        The row configuration of the asset filter.

        • rowFilter (dict) --

          The row filter.

          • and (list) --

            The 'and' clause of the row filter.

            • (dict) --

              The row filter.

          • expression (dict) --

            The expression of the row filter.

            • equalTo (dict) --

              The 'equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be equal to an expression.

            • greaterThan (dict) --

              The 'greater than' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be greater than an expression.

            • greaterThanOrEqualTo (dict) --

              The 'greater than or equal to' clause of the filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be greater than or equal to an expression.

            • in (dict) --

              The 'in' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • values (list) --

                The values that might be in the expression.

                • (string) --

            • isNotNull (dict) --

              The 'is not null' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

            • isNull (dict) --

              The 'is null' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

            • lessThan (dict) --

              The 'less than' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be less than the expression.

            • lessThanOrEqualTo (dict) --

              The 'less than or equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be less than or equal to an expression.

            • like (dict) --

              The 'like' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be like the expression.

            • notEqualTo (dict) --

              The 'no equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might not be equal to the expression.

            • notIn (dict) --

              The 'not in' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • values (list) --

                The value that might not be in the expression.

                • (string) --

            • notLike (dict) --

              The 'not like' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might not be like the expression.

          • or (list) --

            The 'or' clause of the row filter.

            • (dict) --

              The row filter.

        • sensitive (boolean) --

          Specifies whether the row filter is sensitive.

    • createdAt (datetime) --

      The timestamp at which the asset filter was created.

    • description (string) --

      The description of the asset filter.

    • domainId (string) --

      The ID of the domain where the asset filter was created.

    • effectiveColumnNames (list) --

      The column names of the asset filter.

      • (string) --

    • effectiveRowFilter (string) --

      The row filter of the asset filter.

    • errorMessage (string) --

      The error message that is displayed if the action is not completed successfully.

    • id (string) --

      The ID of the asset filter.

    • name (string) --

      The name of the asset filter.

    • status (string) --

      The status of the asset filter.

ListAssetFilters (new) Link ¶

Lists asset filters.

See also: AWS API Documentation

Request Syntax

client.list_asset_filters(
    assetIdentifier='string',
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    status='VALID'|'INVALID'
)
type assetIdentifier:

string

param assetIdentifier:

[REQUIRED]

The ID of the data asset.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where you want to list asset filters.

type maxResults:

integer

param maxResults:

The maximum number of asset filters to return in a single call to ListAssetFilters. When the number of asset filters 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 ListAssetFilters to list the next set of asset filters.

type nextToken:

string

param nextToken:

When the number of asset filters 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 asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

type status:

string

param status:

The status of the asset filter.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'assetId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'domainId': 'string',
            'effectiveColumnNames': [
                'string',
            ],
            'effectiveRowFilter': 'string',
            'errorMessage': 'string',
            'id': 'string',
            'name': 'string',
            'status': 'VALID'|'INVALID'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The results of the ListAssetFilters action.

      • (dict) --

        The summary of the asset filter.

        • assetId (string) --

          The ID of the data asset.

        • createdAt (datetime) --

          The timestamp at which the asset filter was created.

        • description (string) --

          The description of the asset filter.

        • domainId (string) --

          The ID of the domain where the asset filter lives.

        • effectiveColumnNames (list) --

          The effective column names of the asset filter.

          • (string) --

        • effectiveRowFilter (string) --

          The effective row filter of the asset filter.

        • errorMessage (string) --

          The error message that is displayed if the action does not succeed.

        • id (string) --

          The ID of the asset filter.

        • name (string) --

          The name of the asset filter.

        • status (string) --

          The status of the asset filter.

    • nextToken (string) --

      When the number of asset filters 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 asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

CreateAssetFilter (new) Link ¶

Creates a data asset filter.

See also: AWS API Documentation

Request Syntax

client.create_asset_filter(
    assetIdentifier='string',
    clientToken='string',
    configuration={
        'columnConfiguration': {
            'includedColumnNames': [
                'string',
            ]
        },
        'rowConfiguration': {
            'rowFilter': {
                'and': [
                    {'... recursive ...'},
                ],
                'expression': {
                    'equalTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'in': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'isNotNull': {
                        'columnName': 'string'
                    },
                    'isNull': {
                        'columnName': 'string'
                    },
                    'lessThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'lessThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'like': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notIn': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'notLike': {
                        'columnName': 'string',
                        'value': 'string'
                    }
                },
                'or': [
                    {'... recursive ...'},
                ]
            },
            'sensitive': True|False
        }
    },
    description='string',
    domainIdentifier='string',
    name='string'
)
type assetIdentifier:

string

param assetIdentifier:

[REQUIRED]

The ID of the data asset.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

This field is autopopulated if not provided.

type configuration:

dict

param configuration:

[REQUIRED]

The configuration of the asset filter.

  • columnConfiguration (dict) --

    The column configuration of the asset filter.

    • includedColumnNames (list) --

      Specifies whether to include column names.

      • (string) --

  • rowConfiguration (dict) --

    The row configuration of the asset filter.

    • rowFilter (dict) -- [REQUIRED]

      The row filter.

      • and (list) --

        The 'and' clause of the row filter.

        • (dict) --

          The row filter.

      • expression (dict) --

        The expression of the row filter.

        • equalTo (dict) --

          The 'equal to' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be equal to an expression.

        • greaterThan (dict) --

          The 'greater than' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be greater than an expression.

        • greaterThanOrEqualTo (dict) --

          The 'greater than or equal to' clause of the filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be greater than or equal to an expression.

        • in (dict) --

          The 'in' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • values (list) -- [REQUIRED]

            The values that might be in the expression.

            • (string) --

        • isNotNull (dict) --

          The 'is not null' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

        • isNull (dict) --

          The 'is null' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

        • lessThan (dict) --

          The 'less than' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be less than the expression.

        • lessThanOrEqualTo (dict) --

          The 'less than or equal to' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be less than or equal to an expression.

        • like (dict) --

          The 'like' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might be like the expression.

        • notEqualTo (dict) --

          The 'no equal to' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might not be equal to the expression.

        • notIn (dict) --

          The 'not in' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • values (list) -- [REQUIRED]

            The value that might not be in the expression.

            • (string) --

        • notLike (dict) --

          The 'not like' clause of the row filter expression.

          • columnName (string) -- [REQUIRED]

            The name of the column.

          • value (string) -- [REQUIRED]

            The value that might not be like the expression.

      • or (list) --

        The 'or' clause of the row filter.

        • (dict) --

          The row filter.

    • sensitive (boolean) --

      Specifies whether the row filter is sensitive.

type description:

string

param description:

The description of the asset filter.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain in which you want to create an asset filter.

type name:

string

param name:

[REQUIRED]

The name of the asset filter.

rtype:

dict

returns:

Response Syntax

{
    'assetId': 'string',
    'configuration': {
        'columnConfiguration': {
            'includedColumnNames': [
                'string',
            ]
        },
        'rowConfiguration': {
            'rowFilter': {
                'and': [
                    {'... recursive ...'},
                ],
                'expression': {
                    'equalTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'in': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'isNotNull': {
                        'columnName': 'string'
                    },
                    'isNull': {
                        'columnName': 'string'
                    },
                    'lessThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'lessThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'like': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notIn': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'notLike': {
                        'columnName': 'string',
                        'value': 'string'
                    }
                },
                'or': [
                    {'... recursive ...'},
                ]
            },
            'sensitive': True|False
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'domainId': 'string',
    'effectiveColumnNames': [
        'string',
    ],
    'effectiveRowFilter': 'string',
    'errorMessage': 'string',
    'id': 'string',
    'name': 'string',
    'status': 'VALID'|'INVALID'
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the asset.

    • configuration (dict) --

      The configuration of the asset filter.

      • columnConfiguration (dict) --

        The column configuration of the asset filter.

        • includedColumnNames (list) --

          Specifies whether to include column names.

          • (string) --

      • rowConfiguration (dict) --

        The row configuration of the asset filter.

        • rowFilter (dict) --

          The row filter.

          • and (list) --

            The 'and' clause of the row filter.

            • (dict) --

              The row filter.

          • expression (dict) --

            The expression of the row filter.

            • equalTo (dict) --

              The 'equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be equal to an expression.

            • greaterThan (dict) --

              The 'greater than' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be greater than an expression.

            • greaterThanOrEqualTo (dict) --

              The 'greater than or equal to' clause of the filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be greater than or equal to an expression.

            • in (dict) --

              The 'in' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • values (list) --

                The values that might be in the expression.

                • (string) --

            • isNotNull (dict) --

              The 'is not null' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

            • isNull (dict) --

              The 'is null' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

            • lessThan (dict) --

              The 'less than' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be less than the expression.

            • lessThanOrEqualTo (dict) --

              The 'less than or equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be less than or equal to an expression.

            • like (dict) --

              The 'like' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be like the expression.

            • notEqualTo (dict) --

              The 'no equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might not be equal to the expression.

            • notIn (dict) --

              The 'not in' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • values (list) --

                The value that might not be in the expression.

                • (string) --

            • notLike (dict) --

              The 'not like' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might not be like the expression.

          • or (list) --

            The 'or' clause of the row filter.

            • (dict) --

              The row filter.

        • sensitive (boolean) --

          Specifies whether the row filter is sensitive.

    • createdAt (datetime) --

      The timestamp at which the asset filter was created.

    • description (string) --

      The description of the asset filter.

    • domainId (string) --

      The ID of the domain where the asset filter is created.

    • effectiveColumnNames (list) --

      The column names in the asset filter.

      • (string) --

    • effectiveRowFilter (string) --

      The row filter in the asset filter.

    • errorMessage (string) --

      The error message that is displayed if the asset filter is not created successfully.

    • id (string) --

      The ID of the asset filter.

    • name (string) --

      The name of the asset filter.

    • status (string) --

      The status of the asset filter.

DeleteAssetFilter (new) Link ¶

Deletes an asset filter.

See also: AWS API Documentation

Request Syntax

client.delete_asset_filter(
    assetIdentifier='string',
    domainIdentifier='string',
    identifier='string'
)
type assetIdentifier:

string

param assetIdentifier:

[REQUIRED]

The ID of the data asset.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where you want to delete an asset filter.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the asset filter that you want to delete.

returns:

None

GetAssetFilter (new) Link ¶

Gets an asset filter.

See also: AWS API Documentation

Request Syntax

client.get_asset_filter(
    assetIdentifier='string',
    domainIdentifier='string',
    identifier='string'
)
type assetIdentifier:

string

param assetIdentifier:

[REQUIRED]

The ID of the data asset.

type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The ID of the domain where you want to get an asset filter.

type identifier:

string

param identifier:

[REQUIRED]

The ID of the asset filter.

rtype:

dict

returns:

Response Syntax

{
    'assetId': 'string',
    'configuration': {
        'columnConfiguration': {
            'includedColumnNames': [
                'string',
            ]
        },
        'rowConfiguration': {
            'rowFilter': {
                'and': [
                    {'... recursive ...'},
                ],
                'expression': {
                    'equalTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'greaterThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'in': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'isNotNull': {
                        'columnName': 'string'
                    },
                    'isNull': {
                        'columnName': 'string'
                    },
                    'lessThan': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'lessThanOrEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'like': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notEqualTo': {
                        'columnName': 'string',
                        'value': 'string'
                    },
                    'notIn': {
                        'columnName': 'string',
                        'values': [
                            'string',
                        ]
                    },
                    'notLike': {
                        'columnName': 'string',
                        'value': 'string'
                    }
                },
                'or': [
                    {'... recursive ...'},
                ]
            },
            'sensitive': True|False
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'description': 'string',
    'domainId': 'string',
    'effectiveColumnNames': [
        'string',
    ],
    'effectiveRowFilter': 'string',
    'errorMessage': 'string',
    'id': 'string',
    'name': 'string',
    'status': 'VALID'|'INVALID'
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the data asset.

    • configuration (dict) --

      The configuration of the asset filter.

      • columnConfiguration (dict) --

        The column configuration of the asset filter.

        • includedColumnNames (list) --

          Specifies whether to include column names.

          • (string) --

      • rowConfiguration (dict) --

        The row configuration of the asset filter.

        • rowFilter (dict) --

          The row filter.

          • and (list) --

            The 'and' clause of the row filter.

            • (dict) --

              The row filter.

          • expression (dict) --

            The expression of the row filter.

            • equalTo (dict) --

              The 'equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be equal to an expression.

            • greaterThan (dict) --

              The 'greater than' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be greater than an expression.

            • greaterThanOrEqualTo (dict) --

              The 'greater than or equal to' clause of the filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be greater than or equal to an expression.

            • in (dict) --

              The 'in' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • values (list) --

                The values that might be in the expression.

                • (string) --

            • isNotNull (dict) --

              The 'is not null' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

            • isNull (dict) --

              The 'is null' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

            • lessThan (dict) --

              The 'less than' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be less than the expression.

            • lessThanOrEqualTo (dict) --

              The 'less than or equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be less than or equal to an expression.

            • like (dict) --

              The 'like' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might be like the expression.

            • notEqualTo (dict) --

              The 'no equal to' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might not be equal to the expression.

            • notIn (dict) --

              The 'not in' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • values (list) --

                The value that might not be in the expression.

                • (string) --

            • notLike (dict) --

              The 'not like' clause of the row filter expression.

              • columnName (string) --

                The name of the column.

              • value (string) --

                The value that might not be like the expression.

          • or (list) --

            The 'or' clause of the row filter.

            • (dict) --

              The row filter.

        • sensitive (boolean) --

          Specifies whether the row filter is sensitive.

    • createdAt (datetime) --

      The timestamp at which the asset filter was created.

    • description (string) --

      The description of the asset filter.

    • domainId (string) --

      The ID of the domain where you want to get an asset filter.

    • effectiveColumnNames (list) --

      The column names of the asset filter.

      • (string) --

    • effectiveRowFilter (string) --

      The row filter of the asset filter.

    • errorMessage (string) --

      The error message that is displayed if the action does not complete successfully.

    • id (string) --

      The ID of the asset filter.

    • name (string) --

      The name of the asset filter.

    • status (string) --

      The status of the asset filter.

GetEnvironmentBlueprintConfiguration (updated) Link ¶
Changes (response) 
{'provisioningConfigurations': [{'lakeFormationConfiguration': {'locationRegistrationExcludeS3Locations': ['string'],
                                                                'locationRegistrationRole': '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

{
    '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)
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when this blueprint was created.

    • domainId (string) --

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

    • enabledRegions (list) --

      The Amazon Web Services regions in which this blueprint is enabled.

      • (string) --

    • environmentBlueprintId (string) --

      The ID of the blueprint.

    • manageAccessRoleArn (string) --

      The ARN of the manage access role with which this blueprint is created.

    • provisioningConfigurations (list) --

      The provisioning configuration of a blueprint.

      • (dict) --

        The provisioning configuration of the blueprint.

        • 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 with which this blueprint is created.

    • regionalParameters (dict) --

      The regional parameters of the blueprint.

      • (string) --

        • (dict) --

          • (string) --

            • (string) --

    • updatedAt (datetime) --

      The timestamp of when this blueprint was upated.

ListEnvironmentBlueprintConfigurations (updated) Link ¶
Changes (response) 
{'items': {'provisioningConfigurations': [{'lakeFormationConfiguration': {'locationRegistrationExcludeS3Locations': ['string'],
                                                                          'locationRegistrationRole': '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': [
        {
            '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.

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

PutEnvironmentBlueprintConfiguration (updated) Link ¶
Changes (both) 
{'provisioningConfigurations': [{'lakeFormationConfiguration': {'locationRegistrationExcludeS3Locations': ['string'],
                                                                'locationRegistrationRole': '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',
    enabledRegions=[
        'string',
    ],
    environmentBlueprintIdentifier='string',
    manageAccessRoleArn='string',
    provisioningConfigurations=[
        {
            'lakeFormationConfiguration': {
                'locationRegistrationExcludeS3Locations': [
                    'string',
                ],
                'locationRegistrationRole': 'string'
            }
        },
    ],
    provisioningRoleArn='string',
    regionalParameters={
        'string': {
            'string': 'string'
        }
    }
)
type domainIdentifier:

string

param domainIdentifier:

[REQUIRED]

The identifier of the Amazon DataZone domain.

type enabledRegions:

list

param enabledRegions:

[REQUIRED]

Specifies the enabled Amazon Web Services Regions.

  • (string) --

type environmentBlueprintIdentifier:

string

param environmentBlueprintIdentifier:

[REQUIRED]

The identifier of the environment blueprint.

type manageAccessRoleArn:

string

param manageAccessRoleArn:

The ARN of the manage access role.

type provisioningConfigurations:

list

param provisioningConfigurations:

The provisioning configuration of a blueprint.

  • (dict) --

    The provisioning configuration of the blueprint.

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

type provisioningRoleArn:

string

param provisioningRoleArn:

The ARN of the provisioning role.

type regionalParameters:

dict

param regionalParameters:

The regional parameters in the environment blueprint.

  • (string) --

    • (dict) --

      • (string) --

        • (string) --

rtype:

dict

returns:

Response Syntax

{
    '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)
}

Response Structure

  • (dict) --

    • createdAt (datetime) --

      The timestamp of when the environment blueprint was created.

    • domainId (string) --

      The identifier of the Amazon DataZone domain.

    • enabledRegions (list) --

      Specifies the enabled Amazon Web Services Regions.

      • (string) --

    • environmentBlueprintId (string) --

      The identifier of the environment blueprint.

    • manageAccessRoleArn (string) --

      The ARN of the manage access role.

    • provisioningConfigurations (list) --

      The provisioning configuration of a blueprint.

      • (dict) --

        The provisioning configuration of the blueprint.

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

    • regionalParameters (dict) --

      The regional parameters in the environment blueprint.

      • (string) --

        • (dict) --

          • (string) --

            • (string) --

    • updatedAt (datetime) --

      The timestamp of when the environment blueprint was updated.