CreateAssetFilterCommand

Suggest an Edit

Creates a data asset filter.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, CreateAssetFilterCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateAssetFilterCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateAssetFilterInput
  domainIdentifier: "STRING_VALUE", // required
  assetIdentifier: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  description: "STRING_VALUE",
  configuration: { // AssetFilterConfiguration Union: only one key present
    columnConfiguration: { // ColumnFilterConfiguration
      includedColumnNames: [ // ColumnNameList
        "STRING_VALUE",
      ],
    },
    rowConfiguration: { // RowFilterConfiguration
      rowFilter: { // RowFilter Union: only one key present
        expression: { // RowFilterExpression Union: only one key present
          equalTo: { // EqualToExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          notEqualTo: { // NotEqualToExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          greaterThan: { // GreaterThanExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          lessThan: { // LessThanExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          lessThanOrEqualTo: { // LessThanOrEqualToExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          isNull: { // IsNullExpression
            columnName: "STRING_VALUE", // required
          },
          isNotNull: { // IsNotNullExpression
            columnName: "STRING_VALUE", // required
          },
          in: { // InExpression
            columnName: "STRING_VALUE", // required
            values: [ // StringList // required
              "STRING_VALUE",
            ],
          },
          notIn: { // NotInExpression
            columnName: "STRING_VALUE", // required
            values: [ // required
              "STRING_VALUE",
            ],
          },
          like: { // LikeExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
          notLike: { // NotLikeExpression
            columnName: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
          },
        },
        and: [ // RowFilterList
          {//  Union: only one key present
            expression: {//  Union: only one key present
              equalTo: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              notEqualTo: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              greaterThan: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              lessThan: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              greaterThanOrEqualTo: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              lessThanOrEqualTo: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              isNull: {
                columnName: "STRING_VALUE", // required
              },
              isNotNull: {
                columnName: "STRING_VALUE", // required
              },
              in: {
                columnName: "STRING_VALUE", // required
                values: [ // required
                  "STRING_VALUE",
                ],
              },
              notIn: {
                columnName: "STRING_VALUE", // required
                values: [ // required
                  "STRING_VALUE",
                ],
              },
              like: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
              notLike: {
                columnName: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
              },
            },
            and: [
              "<RowFilter>",
            ],
            or: [
              "<RowFilter>",
            ],
          },
        ],
        or: [
          "<RowFilter>",
        ],
      },
      sensitive: true || false,
    },
  },
  clientToken: "STRING_VALUE",
};
const command = new CreateAssetFilterCommand(input);
const response = await client.send(command);
// { // CreateAssetFilterOutput
//   id: "STRING_VALUE", // required
//   domainId: "STRING_VALUE", // required
//   assetId: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   status: "VALID" || "INVALID",
//   configuration: { // AssetFilterConfiguration Union: only one key present
//     columnConfiguration: { // ColumnFilterConfiguration
//       includedColumnNames: [ // ColumnNameList
//         "STRING_VALUE",
//       ],
//     },
//     rowConfiguration: { // RowFilterConfiguration
//       rowFilter: { // RowFilter Union: only one key present
//         expression: { // RowFilterExpression Union: only one key present
//           equalTo: { // EqualToExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           notEqualTo: { // NotEqualToExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           greaterThan: { // GreaterThanExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           lessThan: { // LessThanExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           lessThanOrEqualTo: { // LessThanOrEqualToExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           isNull: { // IsNullExpression
//             columnName: "STRING_VALUE", // required
//           },
//           isNotNull: { // IsNotNullExpression
//             columnName: "STRING_VALUE", // required
//           },
//           in: { // InExpression
//             columnName: "STRING_VALUE", // required
//             values: [ // StringList // required
//               "STRING_VALUE",
//             ],
//           },
//           notIn: { // NotInExpression
//             columnName: "STRING_VALUE", // required
//             values: [ // required
//               "STRING_VALUE",
//             ],
//           },
//           like: { // LikeExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//           notLike: { // NotLikeExpression
//             columnName: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//         },
//         and: [ // RowFilterList
//           {//  Union: only one key present
//             expression: {//  Union: only one key present
//               equalTo: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               notEqualTo: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               greaterThan: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               lessThan: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               greaterThanOrEqualTo: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               lessThanOrEqualTo: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               isNull: {
//                 columnName: "STRING_VALUE", // required
//               },
//               isNotNull: {
//                 columnName: "STRING_VALUE", // required
//               },
//               in: {
//                 columnName: "STRING_VALUE", // required
//                 values: [ // required
//                   "STRING_VALUE",
//                 ],
//               },
//               notIn: {
//                 columnName: "STRING_VALUE", // required
//                 values: [ // required
//                   "STRING_VALUE",
//                 ],
//               },
//               like: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//               notLike: {
//                 columnName: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//               },
//             },
//             and: [
//               "<RowFilter>",
//             ],
//             or: [
//               "<RowFilter>",
//             ],
//           },
//         ],
//         or: [
//           "<RowFilter>",
//         ],
//       },
//       sensitive: true || false,
//     },
//   },
//   createdAt: new Date("TIMESTAMP"),
//   errorMessage: "STRING_VALUE",
//   effectiveColumnNames: [
//     "STRING_VALUE",
//   ],
//   effectiveRowFilter: "STRING_VALUE",
// };

CreateAssetFilterCommand Input

See CreateAssetFilterCommandInput for more details

Parameter
Type
Description
assetIdentifier
Required
string | undefined

The ID of the data asset.

configuration
Required
AssetFilterConfiguration | undefined

The configuration of the asset filter.

domainIdentifier
Required
string | undefined

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

name
Required
string | undefined

The name of the asset filter.

clientToken
string | undefined

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

description
string | undefined

The description of the asset filter.

CreateAssetFilterCommand Output

See CreateAssetFilterCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
assetId
Required
string | undefined

The ID of the asset.

configuration
Required
AssetFilterConfiguration | undefined

The configuration of the asset filter.

domainId
Required
string | undefined

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

id
Required
string | undefined

The ID of the asset filter.

name
Required
string | undefined

The name of the asset filter.

createdAt
Date | undefined

The timestamp at which the asset filter was created.

description
string | undefined

The description of the asset filter.

effectiveColumnNames
string[] | undefined

The column names in the asset filter.

effectiveRowFilter
string | undefined

The row filter in the asset filter.

errorMessage
string | undefined

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

status
FilterStatus | undefined

The status of the asset filter.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

There is a conflict while performing this action.

InternalServerException
server

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The specified resource cannot be found.

ServiceQuotaExceededException
client

The request has exceeded the specified service quota.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.