list-computation-model-data-binding-usages¶

Description¶

Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

Synopsis¶

  list-computation-model-data-binding-usages
--data-binding-value-filter <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--data-binding-value-filter (structure)

A filter used to limit the returned data binding usages based on specific data binding values. You can filter by asset, asset model, asset property, or asset model property to find all computation models using these specific data sources.

asset -> (structure)

Filter criteria for matching data bindings based on a specific asset. Used to list all data bindings referencing a particular asset or its properties.

assetId -> (string)

The ID of the asset to filter data bindings by. Only data bindings referencing this specific asset are matched.

assetModel -> (structure)

Filter criteria for matching data bindings based on a specific asset model. Used to list all data bindings referencing a particular asset model or its properties.

assetModelId -> (string)

The ID of the asset model to filter data bindings by. Only data bindings referemncing this specific asset model are matched.

assetProperty -> (structure)

Filter criteria for matching data bindings based on a specific asset property. Used to list all data bindings referencing a particular property of an asset.

assetId -> (string)

The ID of the asset containing the property to filter by. This identifies the specific asset instance containing the property of interest.

propertyId -> (string)

The ID of the property within the asset to filter by. Only data bindings referencing this specific property of the specified asset are matched.

assetModelProperty -> (structure)

Filter criteria for matching data bindings based on a specific asset model property. Used to list all data bindings referencing a particular property of an asset model.

assetModelId -> (string)

The ID of the asset model containing the filter property. This identifies the specific asset model that contains the property of interest.

propertyId -> (string)

The ID of the property within the asset model to filter by. Only data bindings referencing this specific property of the specified asset model are matched.

Shorthand Syntax:

asset={assetId=string},assetModel={assetModelId=string},assetProperty={assetId=string,propertyId=string},assetModelProperty={assetModelId=string,propertyId=string}

JSON Syntax:

{
  "asset": {
    "assetId": "string"
  },
  "assetModel": {
    "assetModelId": "string"
  },
  "assetProperty": {
    "assetId": "string",
    "propertyId": "string"
  },
  "assetModelProperty": {
    "assetModelId": "string",
    "propertyId": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

dataBindingUsageSummaries -> (list)

A list of summaries describing the data binding usages across computation models. Each summary includes the computation model IDs and the matched data binding details.

(structure)

A summary of how a specific data binding is used across computation models. This tracks dependencies between data sources and computation models, allowing you to understand the impact of changes to data sources.

computationModelIds -> (list)

The list of computation model IDs that use this data binding. This allows identification of all computation models affected by changes to the referenced data source.

(string)

matchedDataBinding -> (structure)

The data binding matched by the filter criteria. Contains details about specific data binding values used by the computation models.

value -> (structure)

The value of the matched data binding.

assetModelProperty -> (structure)

Contains information about an assetModelProperty binding value.

assetModelId -> (string)

The ID of the asset model, in UUID format.

propertyId -> (string)

The ID of the asset model property used in data binding value.

assetProperty -> (structure)

The asset property value used in the data binding.

assetId -> (string)

The ID of the asset containing the property. This identifies the specific asset instance’s property value used in the computation model.

propertyId -> (string)

The ID of the property within the asset. This identifies the specific property’s value used in the computation model.

nextToken -> (string)

The token for the next set of paginated results, or null if there are no additional results.

Table of Contents

Feedback

User Guide