Class: Aws::DataZone::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb

Overview

An API client for DataZone. To construct a client, you need to configure a :region and :credentials.

client = Aws::DataZone::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::DataZone::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::DataZone::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#accept_predictions(params = {}) ⇒ Types::AcceptPredictionsOutput

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

Examples:

Request syntax with placeholder values


resp = client.accept_predictions({
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  revision: "Revision",
  accept_rule: {
    rule: "ALL", # accepts ALL, NONE
    threshold: 1.0,
  },
  accept_choices: [
    {
      prediction_target: "String", # required
      prediction_choice: 1,
      edited_value: "EditedValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.asset_id #=> String
resp.revision #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :identifier (required, String) —

    The identifier of the asset.

  • :revision (String) —

    The revision that is to be made to the asset.

  • :accept_rule (Types::AcceptRule) —

    Specifies the rule (or the conditions) under which a prediction can be accepted.

  • :accept_choices (Array<Types::AcceptChoice>) —

    Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



543
544
545
546
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 543

def accept_predictions(params = {}, options = {})
  req = build_request(:accept_predictions, params)
  req.send_request(options)
end

#accept_subscription_request(params = {}) ⇒ Types::AcceptSubscriptionRequestOutput

Accepts a subscription request to a specific asset.

Examples:

Request syntax with placeholder values


resp = client.accept_subscription_request({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
  decision_comment: "DecisionComment",
  asset_scopes: [
    {
      asset_id: "AssetId", # required
      filter_ids: ["FilterId"], # required
    },
  ],
  asset_permissions: [
    {
      asset_id: "AssetId", # required
      permissions: { # required
        s3: ["READ"], # accepts READ, WRITE
      },
    },
  ],
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.request_reason #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.subscribed_principals[0].user.id #=> String
resp.subscribed_principals[0].user.details.iam.arn #=> String
resp.subscribed_principals[0].user.details.iam.principal_id #=> String
resp.subscribed_principals[0].user.details.sso.username #=> String
resp.subscribed_principals[0].user.details.sso.first_name #=> String
resp.subscribed_principals[0].user.details.sso.last_name #=> String
resp.subscribed_principals[0].group.id #=> String
resp.subscribed_principals[0].group.name #=> String
resp.subscribed_principals[0].iam.principal_arn #=> String
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_listings[0].name #=> String
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.subscribed_listings[0].item.asset_listing.forms #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.status #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listings[0].item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listings[0].item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listings[0].item.product_listing.entity_id #=> String
resp.subscribed_listings[0].item.product_listing.entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.product_listing.name #=> String
resp.subscribed_listings[0].item.product_listing.description #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings #=> Array
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.reviewer_id #=> String
resp.decision_comment #=> String
resp.existing_subscription_id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.metadata_forms[0].content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The Amazon DataZone domain where the specified subscription request is being accepted.

  • :identifier (required, String) —

    The unique identifier of the subscription request that is to be accepted.

  • :decision_comment (String) —

    A description that specifies the reason for accepting the specified subscription request.

  • :asset_scopes (Array<Types::AcceptedAssetScope>) —

    The asset scopes of the accept subscription request.

  • :asset_permissions (Array<Types::AssetPermission>) —

    The asset permissions of the accept subscription request.

Returns:

See Also:



674
675
676
677
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 674

def accept_subscription_request(params = {}, options = {})
  req = build_request(:accept_subscription_request, params)
  req.send_request(options)
end

#add_entity_owner(params = {}) ⇒ Struct

Adds the owner of an entity (a domain unit).

Examples:

Request syntax with placeholder values


resp = client.add_entity_owner({
  domain_identifier: "DomainId", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  entity_identifier: "String", # required
  owner: { # required
    user: {
      user_identifier: "UserIdentifier", # required
    },
    group: {
      group_identifier: "GroupIdentifier", # required
    },
  },
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which you want to add the entity owner.

  • :entity_type (required, String) —

    The type of an entity.

  • :entity_identifier (required, String) —

    The ID of the entity to which you want to add an owner.

  • :owner (required, Types::OwnerProperties) —

    The owner that you want to add to the entity.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



723
724
725
726
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 723

def add_entity_owner(params = {}, options = {})
  req = build_request(:add_entity_owner, params)
  req.send_request(options)
end

#add_policy_grant(params = {}) ⇒ Types::AddPolicyGrantOutput

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

Examples:

Request syntax with placeholder values


resp = client.add_policy_grant({
  domain_identifier: "DomainId", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE, ASSET_TYPE
  entity_identifier: "String", # required
  policy_type: "CREATE_DOMAIN_UNIT", # required, accepts CREATE_DOMAIN_UNIT, OVERRIDE_DOMAIN_UNIT_OWNERS, ADD_TO_PROJECT_MEMBER_POOL, OVERRIDE_PROJECT_OWNERS, CREATE_GLOSSARY, CREATE_FORM_TYPE, CREATE_ASSET_TYPE, CREATE_PROJECT, CREATE_ENVIRONMENT_PROFILE, DELEGATE_CREATE_ENVIRONMENT_PROFILE, CREATE_ENVIRONMENT, CREATE_ENVIRONMENT_FROM_BLUEPRINT, CREATE_PROJECT_FROM_PROJECT_PROFILE, USE_ASSET_TYPE
  principal: { # required
    user: {
      user_identifier: "UserIdentifier",
      all_users_grant_filter: {
      },
    },
    group: {
      group_identifier: "GroupIdentifier",
    },
    project: {
      project_designation: "OWNER", # required, accepts OWNER, CONTRIBUTOR, PROJECT_CATALOG_STEWARD
      project_identifier: "ProjectId",
      project_grant_filter: {
        domain_unit_filter: {
          domain_unit: "DomainUnitId", # required
          include_child_domain_units: false,
        },
      },
    },
    domain_unit: {
      domain_unit_designation: "OWNER", # required, accepts OWNER
      domain_unit_identifier: "DomainUnitId",
      domain_unit_grant_filter: {
        all_domain_units_grant_filter: {
        },
      },
    },
  },
  detail: { # required
    create_domain_unit: {
      include_child_domain_units: false,
    },
    override_domain_unit_owners: {
      include_child_domain_units: false,
    },
    add_to_project_member_pool: {
      include_child_domain_units: false,
    },
    override_project_owners: {
      include_child_domain_units: false,
    },
    create_glossary: {
      include_child_domain_units: false,
    },
    create_form_type: {
      include_child_domain_units: false,
    },
    create_asset_type: {
      include_child_domain_units: false,
    },
    create_project: {
      include_child_domain_units: false,
    },
    create_environment_profile: {
      domain_unit_id: "DomainUnitId",
    },
    delegate_create_environment_profile: {
    },
    create_environment: {
    },
    create_environment_from_blueprint: {
    },
    create_project_from_project_profile: {
      include_child_domain_units: false,
      project_profiles: ["String"],
    },
    use_asset_type: {
      domain_unit_id: "DomainUnitId",
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.grant_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to add a policy grant.

  • :entity_type (required, String) —

    The type of entity (resource) to which the grant is added.

  • :entity_identifier (required, String) —

    The ID of the entity (resource) to which you want to add a policy grant.

  • :policy_type (required, String) —

    The type of policy that you want to grant.

  • :principal (required, Types::PolicyGrantPrincipal) —

    The principal to whom the permissions are granted.

  • :detail (required, Types::PolicyGrantDetail) —

    The details of the policy grant.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



850
851
852
853
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 850

def add_policy_grant(params = {}, options = {})
  req = build_request(:add_policy_grant, params)
  req.send_request(options)
end

#associate_environment_role(params = {}) ⇒ Struct

Associates the environment role in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.associate_environment_role({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  environment_role_arn: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the environment role is associated.

  • :environment_identifier (required, String) —

    The ID of the Amazon DataZone environment.

  • :environment_role_arn (required, String) —

    The ARN of the environment role.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



881
882
883
884
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 881

def associate_environment_role(params = {}, options = {})
  req = build_request(:associate_environment_role, params)
  req.send_request(options)
end

#associate_governed_terms(params = {}) ⇒ Struct

Associates governed terms with an asset.

Examples:

Request syntax with placeholder values


resp = client.associate_governed_terms({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET
  governed_glossary_terms: ["GlossaryTermId"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where governed terms are to be associated with an asset.

  • :entity_identifier (required, String) —

    The ID of the asset with which you want to associate a governed term.

  • :entity_type (required, String) —

    The type of the asset with which you want to associate a governed term.

  • :governed_glossary_terms (required, Array<String>) —

    The glossary terms in a restricted glossary.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



917
918
919
920
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 917

def associate_governed_terms(params = {}, options = {})
  req = build_request(:associate_governed_terms, params)
  req.send_request(options)
end

#batch_get_attributes_metadata(params = {}) ⇒ Types::BatchGetAttributesMetadataOutput

Gets the attribute metadata.

Examples:

Request syntax with placeholder values


resp = client.batch_get_attributes_metadata({
  domain_identifier: "DomainId", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  entity_identifier: "EntityId", # required
  entity_revision: "Revision",
  attribute_identifiers: ["AttributeIdentifier"], # required
})

Response structure


resp.attributes #=> Array
resp.attributes[0].attribute_identifier #=> String
resp.attributes[0].forms #=> Array
resp.attributes[0].forms[0].form_name #=> String
resp.attributes[0].forms[0].type_name #=> String
resp.attributes[0].forms[0].type_revision #=> String
resp.attributes[0].forms[0].content #=> String
resp.errors #=> Array
resp.errors[0].attribute_identifier #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The domain ID where you want to get the attribute metadata.

  • :entity_type (required, String) —

    The entity type for which you want to get attribute metadata.

  • :entity_identifier (required, String) —

    The entity ID for which you want to get attribute metadata.

  • :entity_revision (String) —

    The entity revision for which you want to get attribute metadata.

  • :attribute_identifiers (required, Array<String>) —

    The attribute identifier.

Returns:

See Also:



972
973
974
975
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 972

def batch_get_attributes_metadata(params = {}, options = {})
  req = build_request(:batch_get_attributes_metadata, params)
  req.send_request(options)
end

#batch_put_attributes_metadata(params = {}) ⇒ Types::BatchPutAttributesMetadataOutput

Writes the attribute metadata.

Examples:

Request syntax with placeholder values


resp = client.batch_put_attributes_metadata({
  domain_identifier: "DomainId", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  entity_identifier: "EntityId", # required
  client_token: "ClientToken",
  attributes: [ # required
    {
      attribute_identifier: "AttributeIdentifier", # required
      forms: [ # required
        {
          form_name: "FormName", # required
          type_identifier: "FormTypeIdentifier",
          type_revision: "RevisionInput",
          content: "FormInputContentString",
        },
      ],
    },
  ],
})

Response structure


resp.errors #=> Array
resp.errors[0].attribute_identifier #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String
resp.attributes #=> Array
resp.attributes[0].attribute_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The domain ID where you want to write the attribute metadata.

  • :entity_type (required, String) —

    The entity type for which you want to write the attribute metadata.

  • :entity_identifier (required, String) —

    The entity ID for which you want to write the attribute metadata.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :attributes (required, Array<Types::AttributeInput>) —

    The attributes of the metadata.

Returns:

See Also:



1038
1039
1040
1041
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1038

def batch_put_attributes_metadata(params = {}, options = {})
  req = build_request(:batch_put_attributes_metadata, params)
  req.send_request(options)
end

#cancel_metadata_generation_run(params = {}) ⇒ Struct

Cancels the metadata generation run.

Prerequisites:

  • The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS).

  • Runs in SUCCEEDED status cannot be cancelled.

  • User must have access to the run and cancel permissions.

Examples:

Request syntax with placeholder values


resp = client.cancel_metadata_generation_run({
  domain_identifier: "DomainId", # required
  identifier: "MetadataGenerationRunIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

  • :identifier (required, String) —

    The ID of the metadata generation run.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1074
1075
1076
1077
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1074

def cancel_metadata_generation_run(params = {}, options = {})
  req = build_request(:cancel_metadata_generation_run, params)
  req.send_request(options)
end

#cancel_subscription(params = {}) ⇒ Types::CancelSubscriptionOutput

Cancels the subscription to the specified asset.

Examples:

Request syntax with placeholder values


resp = client.cancel_subscription({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionId", # required
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.subscribed_principal.project.id #=> String
resp.subscribed_principal.project.name #=> String
resp.subscribed_principal.user.id #=> String
resp.subscribed_principal.user.details.iam.arn #=> String
resp.subscribed_principal.user.details.iam.principal_id #=> String
resp.subscribed_principal.user.details.sso.username #=> String
resp.subscribed_principal.user.details.sso.first_name #=> String
resp.subscribed_principal.user.details.sso.last_name #=> String
resp.subscribed_principal.group.id #=> String
resp.subscribed_principal.group.name #=> String
resp.subscribed_principal.iam.principal_arn #=> String
resp.subscribed_listing.id #=> String
resp.subscribed_listing.revision #=> String
resp.subscribed_listing.name #=> String
resp.subscribed_listing.description #=> String
resp.subscribed_listing.item.asset_listing.entity_id #=> String
resp.subscribed_listing.item.asset_listing.entity_revision #=> String
resp.subscribed_listing.item.asset_listing.entity_type #=> String
resp.subscribed_listing.item.asset_listing.forms #=> String
resp.subscribed_listing.item.asset_listing.glossary_terms #=> Array
resp.subscribed_listing.item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listing.item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listing.item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.status #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listing.item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listing.item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listing.item.product_listing.entity_id #=> String
resp.subscribed_listing.item.product_listing.entity_revision #=> String
resp.subscribed_listing.item.product_listing.glossary_terms #=> Array
resp.subscribed_listing.item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listing.item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listing.item.product_listing.name #=> String
resp.subscribed_listing.item.product_listing.description #=> String
resp.subscribed_listing.item.product_listing.asset_listings #=> Array
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listing.owner_project_id #=> String
resp.subscribed_listing.owner_project_name #=> String
resp.subscription_request_id #=> String
resp.retain_permissions #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

  • :identifier (required, String) —

    The unique identifier of the subscription that is being cancelled.

Returns:

See Also:



1167
1168
1169
1170
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1167

def cancel_subscription(params = {}, options = {})
  req = build_request(:cancel_subscription, params)
  req.send_request(options)
end

#create_account_pool(params = {}) ⇒ Types::CreateAccountPoolOutput

Creates an account pool.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  name: "AccountPoolName", # required
  description: "Description",
  resolution_strategy: "MANUAL", # required, accepts MANUAL
  account_source: { # required
    accounts: [
      {
        aws_account_id: "AwsAccountId", # required
        supported_regions: ["AwsRegion"], # required
        aws_account_name: "AwsAccountName",
      },
    ],
    custom_account_pool_handler: {
      lambda_function_arn: "LambdaFunctionArn", # required
      lambda_execution_role_arn: "LambdaExecutionRoleArn",
    },
  },
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.id #=> String
resp.description #=> String
resp.resolution_strategy #=> String, one of "MANUAL"
resp..accounts #=> Array
resp..accounts[0]. #=> String
resp..accounts[0].supported_regions #=> Array
resp..accounts[0].supported_regions[0] #=> String
resp..accounts[0]. #=> String
resp...lambda_function_arn #=> String
resp...lambda_execution_role_arn #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.updated_by #=> String
resp.domain_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the account pool is created.

  • :name (required, String) —

    The name of the account pool.

  • :description (String) —

    The description of the account pool.

  • :resolution_strategy (required, String) —

    The mechanism used to resolve the account selection from the account pool.

  • :account_source (required, Types::AccountSource) —

    The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

Returns:

See Also:



1252
1253
1254
1255
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1252

def (params = {}, options = {})
  req = build_request(:create_account_pool, params)
  req.send_request(options)
end

#create_asset(params = {}) ⇒ Types::CreateAssetOutput

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:

  • --domain-identifier must refer to an existing domain.

  • --owning-project-identifier must be a valid project within the domain.

  • Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type.

  • --type-revision (if used) must match a valid revision of the asset type.

  • formsInput is required when it is associated as required in the asset-type. For more information, see create-form-type.

  • Form content must include all required fields as per the form schema (e.g., bucketArn).

You must invoke the following pre-requisite commands before invoking this API:

Examples:

Request syntax with placeholder values


resp = client.create_asset({
  name: "AssetName", # required
  domain_identifier: "DomainId", # required
  external_identifier: "ExternalIdentifier",
  type_identifier: "AssetTypeIdentifier", # required
  type_revision: "Revision",
  description: "Description",
  glossary_terms: ["GlossaryTermId"],
  forms_input: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  owning_project_identifier: "ProjectId", # required
  prediction_configuration: {
    business_name_generation: {
      enabled: false,
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type_identifier #=> String
resp.type_revision #=> String
resp.external_identifier #=> String
resp.revision #=> String
resp.description #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.first_revision_created_at #=> Time
resp.first_revision_created_by #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.governed_glossary_terms #=> Array
resp.governed_glossary_terms[0] #=> String
resp.owning_project_id #=> String
resp.domain_id #=> String
resp.listing.listing_id #=> String
resp.listing.listing_status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.read_only_forms_output #=> Array
resp.read_only_forms_output[0].form_name #=> String
resp.read_only_forms_output[0].type_name #=> String
resp.read_only_forms_output[0].type_revision #=> String
resp.read_only_forms_output[0].content #=> String
resp.latest_time_series_data_point_forms_output #=> Array
resp.latest_time_series_data_point_forms_output[0].form_name #=> String
resp.latest_time_series_data_point_forms_output[0].type_identifier #=> String
resp.latest_time_series_data_point_forms_output[0].type_revision #=> String
resp.latest_time_series_data_point_forms_output[0].timestamp #=> Time
resp.latest_time_series_data_point_forms_output[0].content_summary #=> String
resp.latest_time_series_data_point_forms_output[0].id #=> String
resp.prediction_configuration.business_name_generation.enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Asset name.

  • :domain_identifier (required, String) —

    Amazon DataZone domain where the asset is created.

  • :external_identifier (String) —

    The external identifier of the asset.

    If the value for the externalIdentifier parameter is specified, it must be a unique value.

  • :type_identifier (required, String) —

    The unique identifier of this asset's type.

  • :type_revision (String) —

    The revision of this asset's type.

  • :description (String) —

    Asset description.

  • :glossary_terms (Array<String>) —

    Glossary terms attached to the asset.

  • :forms_input (Array<Types::FormInput>) —

    Metadata forms attached to the asset.

  • :owning_project_identifier (required, String) —

    The unique identifier of the project that owns this asset.

  • :prediction_configuration (Types::PredictionConfiguration) —

    The configuration of the automatically generated business-friendly metadata for the asset.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1429
1430
1431
1432
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1429

def create_asset(params = {}, options = {})
  req = build_request(:create_asset, params)
  req.send_request(options)
end

#create_asset_filter(params = {}) ⇒ Types::CreateAssetFilterOutput

Creates a data asset filter.

Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying row-level filters. This capability is crucial for organizations that need to share data while maintaining security and privacy controls. For example, your database might be filtered to show only non-PII fields to certain users, or sales data might be filtered by region for different regional teams. Asset filters enable fine-grained access control while maintaining a single source of truth.

Prerequisites:

  • A valid domain (--domain-identifier) must exist.

  • A data asset (--asset-identifier) must already be created under that domain.

  • The asset must have the referenced columns available in its schema for column-based filtering.

  • You cannot specify both (columnConfiguration, rowConfiguration)at the same time.

Examples:

Request syntax with placeholder values


resp = client.create_asset_filter({
  domain_identifier: "DomainId", # required
  asset_identifier: "AssetId", # required
  name: "FilterName", # required
  description: "Description",
  configuration: { # required
    column_configuration: {
      included_column_names: ["String"],
    },
    row_configuration: {
      row_filter: { # required
        expression: {
          equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          not_equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          greater_than: {
            column_name: "String", # required
            value: "String", # required
          },
          less_than: {
            column_name: "String", # required
            value: "String", # required
          },
          greater_than_or_equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          less_than_or_equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          is_null: {
            column_name: "String", # required
          },
          is_not_null: {
            column_name: "String", # required
          },
          in: {
            column_name: "String", # required
            values: ["String"], # required
          },
          not_in: {
            column_name: "String", # required
            values: ["String"], # required
          },
          like: {
            column_name: "String", # required
            value: "String", # required
          },
          not_like: {
            column_name: "String", # required
            value: "String", # required
          },
        },
        and: [
          {
            # recursive RowFilter
          },
        ],
        or: [
          {
            # recursive RowFilter
          },
        ],
      },
      sensitive: false,
    },
  },
  client_token: "String",
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.asset_id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "VALID", "INVALID"
resp.configuration.column_configuration.included_column_names #=> Array
resp.configuration.column_configuration.included_column_names[0] #=> String
resp.configuration.row_configuration.row_filter.expression.equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.not_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than.value #=> String
resp.configuration.row_configuration.row_filter.expression.less_than.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.less_than.value #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than_or_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than_or_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.less_than_or_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.less_than_or_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.is_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.is_not_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.in.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.in.values #=> Array
resp.configuration.row_configuration.row_filter.expression.in.values[0] #=> String
resp.configuration.row_configuration.row_filter.expression.not_in.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_in.values #=> Array
resp.configuration.row_configuration.row_filter.expression.not_in.values[0] #=> String
resp.configuration.row_configuration.row_filter.expression.like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.like.value #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.value #=> String
resp.configuration.row_configuration.row_filter.and #=> Array
resp.configuration.row_configuration.row_filter.and[0] #=> Types::RowFilter
resp.configuration.row_configuration.row_filter.or #=> Array
resp.configuration.row_configuration.row_filter.or[0] #=> Types::RowFilter
resp.configuration.row_configuration.sensitive #=> Boolean
resp.created_at #=> Time
resp.error_message #=> String
resp.effective_column_names #=> Array
resp.effective_column_names[0] #=> String
resp.effective_row_filter #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :name (required, String) —

    The name of the asset filter.

  • :description (String) —

    The description of the asset filter.

  • :configuration (required, Types::AssetFilterConfiguration) —

    The configuration of the asset filter.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1621
1622
1623
1624
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1621

def create_asset_filter(params = {}, options = {})
  req = build_request(:create_asset_filter, params)
  req.send_request(options)
end

#create_asset_revision(params = {}) ⇒ Types::CreateAssetRevisionOutput

Creates a revision of the asset.

Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary.

Prerequisites:

  • Asset must already exist in the domain with identifier.

  • formsInput is required when asset has the form type. typeRevision should be the latest version of form type.

  • The form content must include all required fields (e.g., bucketArn for S3ObjectCollectionForm).

  • The owning project of the original asset must still exist and be active.

  • User must have write access to the project and domain.

Examples:

Request syntax with placeholder values


resp = client.create_asset_revision({
  name: "AssetName", # required
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  type_revision: "Revision",
  description: "Description",
  glossary_terms: ["GlossaryTermId"],
  forms_input: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  prediction_configuration: {
    business_name_generation: {
      enabled: false,
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type_identifier #=> String
resp.type_revision #=> String
resp.external_identifier #=> String
resp.revision #=> String
resp.description #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.first_revision_created_at #=> Time
resp.first_revision_created_by #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.governed_glossary_terms #=> Array
resp.governed_glossary_terms[0] #=> String
resp.owning_project_id #=> String
resp.domain_id #=> String
resp.listing.listing_id #=> String
resp.listing.listing_status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.read_only_forms_output #=> Array
resp.read_only_forms_output[0].form_name #=> String
resp.read_only_forms_output[0].type_name #=> String
resp.read_only_forms_output[0].type_revision #=> String
resp.read_only_forms_output[0].content #=> String
resp.latest_time_series_data_point_forms_output #=> Array
resp.latest_time_series_data_point_forms_output[0].form_name #=> String
resp.latest_time_series_data_point_forms_output[0].type_identifier #=> String
resp.latest_time_series_data_point_forms_output[0].type_revision #=> String
resp.latest_time_series_data_point_forms_output[0].timestamp #=> Time
resp.latest_time_series_data_point_forms_output[0].content_summary #=> String
resp.latest_time_series_data_point_forms_output[0].id #=> String
resp.prediction_configuration.business_name_generation.enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Te revised name of the asset.

  • :domain_identifier (required, String) —

    The unique identifier of the domain where the asset is being revised.

  • :identifier (required, String) —

    The identifier of the asset.

  • :type_revision (String) —

    The revision type of the asset.

  • :description (String) —

    The revised description of the asset.

  • :glossary_terms (Array<String>) —

    The glossary terms to be attached to the asset as part of asset revision.

  • :forms_input (Array<Types::FormInput>) —

    The metadata forms to be attached to the asset as part of asset revision.

  • :prediction_configuration (Types::PredictionConfiguration) —

    The configuration of the automatically generated business-friendly metadata for the asset.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1776
1777
1778
1779
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1776

def create_asset_revision(params = {}, options = {})
  req = build_request(:create_asset_revision, params)
  req.send_request(options)
end

#create_asset_type(params = {}) ⇒ Types::CreateAssetTypeOutput

Creates a custom asset type.

Prerequisites:

  • The formsInput field is required, however, can be passed as empty (e.g. -forms-input {}).

  • You must have CreateAssetType permissions.

  • The domain-identifier and owning-project-identifier must be valid and active.

  • The name of the asset type must be unique within the domain — duplicate names will cause failure.

  • JSON input must be valid — incorrect formatting causes Invalid JSON errors.

Examples:

Request syntax with placeholder values


resp = client.create_asset_type({
  domain_identifier: "DomainId", # required
  name: "TypeName", # required
  description: "Description",
  forms_input: { # required
    "FormName" => {
      type_identifier: "FormTypeIdentifier", # required
      type_revision: "Revision", # required
      required: false,
    },
  },
  owning_project_identifier: "ProjectId", # required
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.revision #=> String
resp.description #=> String
resp.forms_output #=> Hash
resp.forms_output["FormName"].type_name #=> String
resp.forms_output["FormName"].type_revision #=> String
resp.forms_output["FormName"].required #=> Boolean
resp.owning_project_id #=> String
resp.origin_domain_id #=> String
resp.origin_project_id #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The unique identifier of the Amazon DataZone domain where the custom asset type is being created.

  • :name (required, String) —

    The name of the custom asset type.

  • :description (String) —

    The descripton of the custom asset type.

  • :forms_input (required, Hash<String,Types::FormEntryInput>) —

    The metadata forms that are to be attached to the custom asset type.

  • :owning_project_identifier (required, String) —

    The identifier of the Amazon DataZone project that is to own the custom asset type.

Returns:

See Also:



1869
1870
1871
1872
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1869

def create_asset_type(params = {}, options = {})
  req = build_request(:create_asset_type, params)
  req.send_request(options)
end

#create_connection(params = {}) ⇒ Types::CreateConnectionOutput

Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  aws_location: {
    access_role: "AwsLocationAccessRoleString",
    aws_account_id: "AwsAccountId",
    aws_region: "AwsRegion",
    iam_connection_id: "ConnectionId",
  },
  client_token: "String",
  description: "CreateConnectionInputDescriptionString",
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId",
  name: "ConnectionName", # required
  props: {
    athena_properties: {
      workgroup_name: "AthenaPropertiesInputWorkgroupNameString",
    },
    glue_properties: {
      glue_connection_input: {
        connection_properties: {
          "String" => "ConnectionPropertiesValueString",
        },
        physical_connection_requirements: {
          subnet_id: "SubnetId",
          subnet_id_list: ["SubnetId"],
          security_group_id_list: ["SecurityGroupIdListMemberString"],
          availability_zone: "PhysicalConnectionRequirementsAvailabilityZoneString",
        },
        name: "GlueConnectionInputNameString",
        description: "String",
        connection_type: "SNOWFLAKE", # accepts SNOWFLAKE, BIGQUERY, DOCUMENTDB, DYNAMODB, MYSQL, OPENSEARCH, ORACLE, POSTGRESQL, REDSHIFT, SAPHANA, SQLSERVER, TERADATA, VERTICA
        match_criteria: "GlueConnectionInputMatchCriteriaString",
        validate_credentials: false,
        validate_for_compute_environments: ["SPARK"], # accepts SPARK, ATHENA, PYTHON
        spark_properties: {
          "PropertyMapKeyString" => "PropertyMapValueString",
        },
        athena_properties: {
          "PropertyMapKeyString" => "PropertyMapValueString",
        },
        python_properties: {
          "PropertyMapKeyString" => "PropertyMapValueString",
        },
        authentication_configuration: {
          authentication_type: "BASIC", # accepts BASIC, OAUTH2, CUSTOM
          o_auth_2_properties: {
            o_auth_2_grant_type: "AUTHORIZATION_CODE", # accepts AUTHORIZATION_CODE, CLIENT_CREDENTIALS, JWT_BEARER
            o_auth_2_client_application: {
              user_managed_client_application_client_id: "OAuth2ClientApplicationUserManagedClientApplicationClientIdString",
              a_ws_managed_client_application_reference: "OAuth2ClientApplicationAWSManagedClientApplicationReferenceString",
            },
            token_url: "OAuth2PropertiesTokenUrlString",
            token_url_parameters_map: {
              "TokenUrlParametersMapKeyString" => "TokenUrlParametersMapValueString",
            },
            authorization_code_properties: {
              authorization_code: "AuthorizationCodePropertiesAuthorizationCodeString",
              redirect_uri: "AuthorizationCodePropertiesRedirectUriString",
            },
            o_auth_2_credentials: {
              user_managed_client_application_client_secret: "GlueOAuth2CredentialsUserManagedClientApplicationClientSecretString",
              access_token: "GlueOAuth2CredentialsAccessTokenString",
              refresh_token: "GlueOAuth2CredentialsRefreshTokenString",
              jwt_token: "GlueOAuth2CredentialsJwtTokenString",
            },
          },
          secret_arn: "AuthenticationConfigurationInputSecretArnString",
          kms_key_arn: "AuthenticationConfigurationInputKmsKeyArnString",
          basic_authentication_credentials: {
            user_name: "BasicAuthenticationCredentialsUserNameString",
            password: "BasicAuthenticationCredentialsPasswordString",
          },
          custom_authentication_credentials: {
            "CredentialMapKeyString" => "CredentialMapValueString",
          },
        },
      },
    },
    hyper_pod_properties: {
      cluster_name: "HyperPodPropertiesInputClusterNameString", # required
    },
    iam_properties: {
      glue_lineage_sync_enabled: false,
    },
    redshift_properties: {
      storage: {
        cluster_name: "RedshiftStoragePropertiesClusterNameString",
        workgroup_name: "RedshiftStoragePropertiesWorkgroupNameString",
      },
      database_name: "RedshiftPropertiesInputDatabaseNameString",
      host: "RedshiftPropertiesInputHostString",
      port: 1,
      credentials: {
        secret_arn: "RedshiftCredentialsSecretArnString",
        username_password: {
          password: "Password", # required
          username: "Username", # required
        },
      },
      lineage_sync: {
        enabled: false,
        schedule: {
          schedule: "LineageSyncScheduleScheduleString",
        },
      },
    },
    spark_emr_properties: {
      compute_arn: "SparkEmrPropertiesInputComputeArnString",
      instance_profile_arn: "SparkEmrPropertiesInputInstanceProfileArnString",
      java_virtual_env: "SparkEmrPropertiesInputJavaVirtualEnvString",
      log_uri: "SparkEmrPropertiesInputLogUriString",
      python_virtual_env: "SparkEmrPropertiesInputPythonVirtualEnvString",
      runtime_role: "SparkEmrPropertiesInputRuntimeRoleString",
      trusted_certificates_s3_uri: "SparkEmrPropertiesInputTrustedCertificatesS3UriString",
      managed_endpoint_arn: "SparkEmrPropertiesInputManagedEndpointArnString",
    },
    spark_glue_properties: {
      additional_args: {
        connection: "String",
      },
      glue_connection_name: "SparkGluePropertiesInputGlueConnectionNameString",
      glue_version: "SparkGluePropertiesInputGlueVersionString",
      idle_timeout: 1,
      java_virtual_env: "SparkGluePropertiesInputJavaVirtualEnvString",
      number_of_workers: 1,
      python_virtual_env: "SparkGluePropertiesInputPythonVirtualEnvString",
      worker_type: "SparkGluePropertiesInputWorkerTypeString",
    },
    s3_properties: {
      s3_uri: "S3Uri", # required
      s3_access_grant_location_id: "S3AccessGrantLocationId",
    },
    amazon_q_properties: {
      is_enabled: false, # required
      profile_arn: "AmazonQPropertiesInputProfileArnString",
      auth_mode: "AmazonQPropertiesInputAuthModeString",
    },
    mlflow_properties: {
      tracking_server_arn: "String",
    },
  },
  enable_trusted_identity_propagation: false,
  scope: "DOMAIN", # accepts DOMAIN, PROJECT
})

Response structure


resp.connection_id #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.environment_id #=> String
resp.name #=> String
resp.physical_endpoints #=> Array
resp.physical_endpoints[0].aws_location.access_role #=> String
resp.physical_endpoints[0].aws_location. #=> String
resp.physical_endpoints[0].aws_location.aws_region #=> String
resp.physical_endpoints[0].aws_location.iam_connection_id #=> String
resp.physical_endpoints[0].glue_connection_name #=> String
resp.physical_endpoints[0].glue_connection.name #=> String
resp.physical_endpoints[0].glue_connection.description #=> String
resp.physical_endpoints[0].glue_connection.connection_type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.physical_endpoints[0].glue_connection.match_criteria #=> Array
resp.physical_endpoints[0].glue_connection.match_criteria[0] #=> String
resp.physical_endpoints[0].glue_connection.connection_properties #=> Hash
resp.physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.physical_endpoints[0].glue_connection.spark_properties #=> Hash
resp.physical_endpoints[0].glue_connection.spark_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.athena_properties #=> Hash
resp.physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.python_properties #=> Hash
resp.physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list #=> Array
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list[0] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list #=> Array
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list[0] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> String
resp.physical_endpoints[0].glue_connection.creation_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.physical_endpoints[0].glue_connection.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.physical_endpoints[0].glue_connection.status_reason #=> String
resp.physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
resp.physical_endpoints[0].glue_connection.authentication_configuration.secret_arn #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_grant_type #=> String, one of "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "JWT_BEARER"
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.user_managed_client_application_client_id #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.a_ws_managed_client_application_reference #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map #=> Hash
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map["TokenUrlParametersMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.authorization_code #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.redirect_uri #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.user_managed_client_application_client_secret #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.access_token #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.refresh_token #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.jwt_token #=> String
resp.physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
resp.physical_endpoints[0].glue_connection.compatible_compute_environments #=> Array
resp.physical_endpoints[0].glue_connection.compatible_compute_environments[0] #=> String, one of "SPARK", "ATHENA", "PYTHON"
resp.physical_endpoints[0].enable_trusted_identity_propagation #=> Boolean
resp.physical_endpoints[0].host #=> String
resp.physical_endpoints[0].port #=> Integer
resp.physical_endpoints[0].protocol #=> String, one of "ATHENA", "GLUE_INTERACTIVE_SESSION", "HTTPS", "JDBC", "LIVY", "ODBC", "PRISM"
resp.physical_endpoints[0].stage #=> String
resp.project_id #=> String
resp.props.athena_properties.workgroup_name #=> String
resp.props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.glue_properties.error_message #=> String
resp.props.hyper_pod_properties.cluster_name #=> String
resp.props.hyper_pod_properties.cluster_arn #=> String
resp.props.hyper_pod_properties.orchestrator #=> String, one of "EKS", "SLURM"
resp.props.iam_properties.environment_id #=> String
resp.props.iam_properties.glue_lineage_sync_enabled #=> Boolean
resp.props.redshift_properties.storage.cluster_name #=> String
resp.props.redshift_properties.storage.workgroup_name #=> String
resp.props.redshift_properties.credentials.secret_arn #=> String
resp.props.redshift_properties.credentials.username_password.password #=> String
resp.props.redshift_properties.credentials.username_password.username #=> String
resp.props.redshift_properties.is_provisioned_secret #=> Boolean
resp.props.redshift_properties.jdbc_iam_url #=> String
resp.props.redshift_properties.jdbc_url #=> String
resp.props.redshift_properties.redshift_temp_dir #=> String
resp.props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.props.redshift_properties.lineage_sync.enabled #=> Boolean
resp.props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.redshift_properties.database_name #=> String
resp.props.spark_emr_properties.compute_arn #=> String
resp.props.spark_emr_properties.credentials.password #=> String
resp.props.spark_emr_properties.credentials.username #=> String
resp.props.spark_emr_properties.credentials_expiration #=> Time
resp.props.spark_emr_properties.governance_type #=> String, one of "AWS_MANAGED", "USER_MANAGED"
resp.props.spark_emr_properties.instance_profile_arn #=> String
resp.props.spark_emr_properties.java_virtual_env #=> String
resp.props.spark_emr_properties.livy_endpoint #=> String
resp.props.spark_emr_properties.log_uri #=> String
resp.props.spark_emr_properties.python_virtual_env #=> String
resp.props.spark_emr_properties.runtime_role #=> String
resp.props.spark_emr_properties.trusted_certificates_s3_uri #=> String
resp.props.spark_emr_properties.certificate_data #=> String
resp.props.spark_emr_properties.managed_endpoint_arn #=> String
resp.props.spark_emr_properties.managed_endpoint_credentials.id #=> String
resp.props.spark_emr_properties.managed_endpoint_credentials.token #=> String
resp.props.spark_glue_properties.additional_args.connection #=> String
resp.props.spark_glue_properties.glue_connection_name #=> String
resp.props.spark_glue_properties.glue_version #=> String
resp.props.spark_glue_properties.idle_timeout #=> Integer
resp.props.spark_glue_properties.java_virtual_env #=> String
resp.props.spark_glue_properties.number_of_workers #=> Integer
resp.props.spark_glue_properties.python_virtual_env #=> String
resp.props.spark_glue_properties.worker_type #=> String
resp.props.s3_properties.s3_uri #=> String
resp.props.s3_properties.s3_access_grant_location_id #=> String
resp.props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.s3_properties.error_message #=> String
resp.props.amazon_q_properties.is_enabled #=> Boolean
resp.props.amazon_q_properties.profile_arn #=> String
resp.props.amazon_q_properties.auth_mode #=> String
resp.props.mlflow_properties.tracking_server_arn #=> String
resp.type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.scope #=> String, one of "DOMAIN", "PROJECT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :aws_location (Types::AwsLocation) —

    The location where the connection is created.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A connection description.

  • :domain_identifier (required, String) —

    The ID of the domain where the connection is created.

  • :environment_identifier (String) —

    The ID of the environment where the connection is created.

  • :name (required, String) —

    The connection name.

  • :props (Types::ConnectionPropertiesInput) —

    The connection props.

  • :enable_trusted_identity_propagation (Boolean) —

    Specifies whether the trusted identity propagation is enabled.

  • :scope (String) —

    The scope of the connection.

Returns:

See Also:



2192
2193
2194
2195
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2192

def create_connection(params = {}, options = {})
  req = build_request(:create_connection, params)
  req.send_request(options)
end

#create_data_product(params = {}) ⇒ Types::CreateDataProductOutput

Creates a data product.

A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.

Prerequisites:

  • The domain must exist and be accessible.

  • The owning project must be valid and active.

  • The name must be unique within the domain (no existing data product with the same name).

  • User must have create permissions for data products in the project.

Examples:

Request syntax with placeholder values


resp = client.create_data_product({
  domain_identifier: "DomainId", # required
  name: "DataProductName", # required
  owning_project_identifier: "ProjectId", # required
  description: "DataProductDescription",
  glossary_terms: ["GlossaryTermId"],
  forms_input: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  items: [
    {
      item_type: "ASSET", # required, accepts ASSET
      identifier: "EntityIdentifier", # required
      revision: "Revision",
      glossary_terms: ["GlossaryTermId"],
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.revision #=> String
resp.owning_project_id #=> String
resp.name #=> String
resp.status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED"
resp.description #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.items #=> Array
resp.items[0].item_type #=> String, one of "ASSET"
resp.items[0].identifier #=> String
resp.items[0].revision #=> String
resp.items[0].glossary_terms #=> Array
resp.items[0].glossary_terms[0] #=> String
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.first_revision_created_at #=> Time
resp.first_revision_created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the data product is created.

  • :name (required, String) —

    The name of the data product.

  • :owning_project_identifier (required, String) —

    The ID of the owning project of the data product.

  • :description (String) —

    The description of the data product.

  • :glossary_terms (Array<String>) —

    The glossary terms of the data product.

  • :forms_input (Array<Types::FormInput>) —

    The metadata forms of the data product.

  • :items (Array<Types::DataProductItem>) —

    The data assets of the data product.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2321
2322
2323
2324
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2321

def create_data_product(params = {}, options = {})
  req = build_request(:create_data_product, params)
  req.send_request(options)
end

#create_data_product_revision(params = {}) ⇒ Types::CreateDataProductRevisionOutput

Creates a data product revision.

Prerequisites:

  • The original data product must exist in the given domain.

  • User must have permissions on the data product.

  • The domain must be valid and accessible.

  • The new revision name must comply with naming constraints (if required).

Examples:

Request syntax with placeholder values


resp = client.create_data_product_revision({
  domain_identifier: "DomainId", # required
  identifier: "DataProductId", # required
  name: "DataProductName", # required
  description: "DataProductDescription",
  glossary_terms: ["GlossaryTermId"],
  items: [
    {
      item_type: "ASSET", # required, accepts ASSET
      identifier: "EntityIdentifier", # required
      revision: "Revision",
      glossary_terms: ["GlossaryTermId"],
    },
  ],
  forms_input: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.revision #=> String
resp.owning_project_id #=> String
resp.name #=> String
resp.status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED"
resp.description #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.items #=> Array
resp.items[0].item_type #=> String, one of "ASSET"
resp.items[0].identifier #=> String
resp.items[0].revision #=> String
resp.items[0].glossary_terms #=> Array
resp.items[0].glossary_terms[0] #=> String
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.first_revision_created_at #=> Time
resp.first_revision_created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the data product revision is created.

  • :identifier (required, String) —

    The ID of the data product revision.

  • :name (required, String) —

    The name of the data product revision.

  • :description (String) —

    The description of the data product revision.

  • :glossary_terms (Array<String>) —

    The glossary terms of the data product revision.

  • :items (Array<Types::DataProductItem>) —

    The data assets of the data product revision.

  • :forms_input (Array<Types::FormInput>) —

    The metadata forms of the data product revision.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2442
2443
2444
2445
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2442

def create_data_product_revision(params = {}, options = {})
  req = build_request(:create_data_product_revision, params)
  req.send_request(options)
end

#create_data_source(params = {}) ⇒ Types::CreateDataSourceOutput

Creates an Amazon DataZone data source.

Examples:

Request syntax with placeholder values


resp = client.create_data_source({
  name: "Name", # required
  description: "Description",
  domain_identifier: "DomainId", # required
  project_identifier: "CreateDataSourceInputProjectIdentifierString", # required
  environment_identifier: "CreateDataSourceInputEnvironmentIdentifierString",
  connection_identifier: "CreateDataSourceInputConnectionIdentifierString",
  type: "DataSourceType", # required
  configuration: {
    glue_run_configuration: {
      data_access_role: "GlueRunConfigurationInputDataAccessRoleString",
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          schema_name: "RelationalFilterConfigurationSchemaNameString",
          filter_expressions: [
            {
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
              expression: "FilterExpressionExpressionString", # required
            },
          ],
        },
      ],
      auto_import_data_quality_result: false,
      catalog_name: "GlueRunConfigurationInputCatalogNameString",
    },
    redshift_run_configuration: {
      data_access_role: "RedshiftRunConfigurationInputDataAccessRoleString",
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          schema_name: "RelationalFilterConfigurationSchemaNameString",
          filter_expressions: [
            {
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
              expression: "FilterExpressionExpressionString", # required
            },
          ],
        },
      ],
      redshift_credential_configuration: {
        secret_manager_arn: "RedshiftCredentialConfigurationSecretManagerArnString", # required
      },
      redshift_storage: {
        redshift_cluster_source: {
          cluster_name: "RedshiftClusterStorageClusterNameString", # required
        },
        redshift_serverless_source: {
          workgroup_name: "RedshiftServerlessStorageWorkgroupNameString", # required
        },
      },
    },
    sage_maker_run_configuration: {
      tracking_assets: { # required
        "SageMakerAssetType" => ["SageMakerResourceArn"],
      },
    },
  },
  recommendation: {
    enable_business_name_generation: false,
  },
  enable_setting: "ENABLED", # accepts ENABLED, DISABLED
  schedule: {
    timezone: "UTC", # accepts UTC, AFRICA_JOHANNESBURG, AMERICA_MONTREAL, AMERICA_SAO_PAULO, ASIA_BAHRAIN, ASIA_BANGKOK, ASIA_CALCUTTA, ASIA_DUBAI, ASIA_HONG_KONG, ASIA_JAKARTA, ASIA_KUALA_LUMPUR, ASIA_SEOUL, ASIA_SHANGHAI, ASIA_SINGAPORE, ASIA_TAIPEI, ASIA_TOKYO, AUSTRALIA_MELBOURNE, AUSTRALIA_SYDNEY, CANADA_CENTRAL, CET, CST6CDT, ETC_GMT, ETC_GMT0, ETC_GMT_ADD_0, ETC_GMT_ADD_1, ETC_GMT_ADD_10, ETC_GMT_ADD_11, ETC_GMT_ADD_12, ETC_GMT_ADD_2, ETC_GMT_ADD_3, ETC_GMT_ADD_4, ETC_GMT_ADD_5, ETC_GMT_ADD_6, ETC_GMT_ADD_7, ETC_GMT_ADD_8, ETC_GMT_ADD_9, ETC_GMT_NEG_0, ETC_GMT_NEG_1, ETC_GMT_NEG_10, ETC_GMT_NEG_11, ETC_GMT_NEG_12, ETC_GMT_NEG_13, ETC_GMT_NEG_14, ETC_GMT_NEG_2, ETC_GMT_NEG_3, ETC_GMT_NEG_4, ETC_GMT_NEG_5, ETC_GMT_NEG_6, ETC_GMT_NEG_7, ETC_GMT_NEG_8, ETC_GMT_NEG_9, EUROPE_DUBLIN, EUROPE_LONDON, EUROPE_PARIS, EUROPE_STOCKHOLM, EUROPE_ZURICH, ISRAEL, MEXICO_GENERAL, MST7MDT, PACIFIC_AUCKLAND, US_CENTRAL, US_EASTERN, US_MOUNTAIN, US_PACIFIC
    schedule: "CronString",
  },
  publish_on_import: false,
  asset_forms_input: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  client_token: "String",
})

Response structure


resp.id #=> String
resp.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.name #=> String
resp.description #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.connection_id #=> String
resp.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.region #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.region #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.redshift_run_configuration.redshift_credential_configuration.secret_manager_arn #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_cluster_source.cluster_name #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_serverless_source.workgroup_name #=> String
resp.configuration.sage_maker_run_configuration. #=> String
resp.configuration.sage_maker_run_configuration.region #=> String
resp.configuration.sage_maker_run_configuration.tracking_assets #=> Hash
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"] #=> Array
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"][0] #=> String
resp.recommendation.enable_business_name_generation #=> Boolean
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.publish_on_import #=> Boolean
resp.asset_forms_output #=> Array
resp.asset_forms_output[0].form_name #=> String
resp.asset_forms_output[0].type_name #=> String
resp.asset_forms_output[0].type_revision #=> String
resp.asset_forms_output[0].content #=> String
resp.schedule.timezone #=> String, one of "UTC", "AFRICA_JOHANNESBURG", "AMERICA_MONTREAL", "AMERICA_SAO_PAULO", "ASIA_BAHRAIN", "ASIA_BANGKOK", "ASIA_CALCUTTA", "ASIA_DUBAI", "ASIA_HONG_KONG", "ASIA_JAKARTA", "ASIA_KUALA_LUMPUR", "ASIA_SEOUL", "ASIA_SHANGHAI", "ASIA_SINGAPORE", "ASIA_TAIPEI", "ASIA_TOKYO", "AUSTRALIA_MELBOURNE", "AUSTRALIA_SYDNEY", "CANADA_CENTRAL", "CET", "CST6CDT", "ETC_GMT", "ETC_GMT0", "ETC_GMT_ADD_0", "ETC_GMT_ADD_1", "ETC_GMT_ADD_10", "ETC_GMT_ADD_11", "ETC_GMT_ADD_12", "ETC_GMT_ADD_2", "ETC_GMT_ADD_3", "ETC_GMT_ADD_4", "ETC_GMT_ADD_5", "ETC_GMT_ADD_6", "ETC_GMT_ADD_7", "ETC_GMT_ADD_8", "ETC_GMT_ADD_9", "ETC_GMT_NEG_0", "ETC_GMT_NEG_1", "ETC_GMT_NEG_10", "ETC_GMT_NEG_11", "ETC_GMT_NEG_12", "ETC_GMT_NEG_13", "ETC_GMT_NEG_14", "ETC_GMT_NEG_2", "ETC_GMT_NEG_3", "ETC_GMT_NEG_4", "ETC_GMT_NEG_5", "ETC_GMT_NEG_6", "ETC_GMT_NEG_7", "ETC_GMT_NEG_8", "ETC_GMT_NEG_9", "EUROPE_DUBLIN", "EUROPE_LONDON", "EUROPE_PARIS", "EUROPE_STOCKHOLM", "EUROPE_ZURICH", "ISRAEL", "MEXICO_GENERAL", "MST7MDT", "PACIFIC_AUCKLAND", "US_CENTRAL", "US_EASTERN", "US_MOUNTAIN", "US_PACIFIC"
resp.schedule.schedule #=> String
resp.last_run_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.last_run_at #=> Time
resp.last_run_error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.last_run_error_message.error_detail #=> String
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.error_message.error_detail #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the data source.

  • :description (String) —

    The description of the data source.

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where the data source is created.

  • :project_identifier (required, String) —

    The identifier of the Amazon DataZone project in which you want to add this data source.

  • :environment_identifier (String) —

    The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

  • :connection_identifier (String) —

    The ID of the connection.

  • :type (required, String) —

    The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.

  • :configuration (Types::DataSourceConfigurationInput) —

    Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

  • :recommendation (Types::RecommendationConfiguration) —

    Specifies whether the business name generation is to be enabled for this data source.

  • :enable_setting (String) —

    Specifies whether the data source is enabled.

  • :schedule (Types::ScheduleConfiguration) —

    The schedule of the data source runs.

  • :publish_on_import (Boolean) —

    Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

  • :asset_forms_input (Array<Types::FormInput>) —

    The metadata forms that are to be attached to the assets that this data source works with.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2671
2672
2673
2674
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2671

def create_data_source(params = {}, options = {})
  req = build_request(:create_data_source, params)
  req.send_request(options)
end

#create_domain(params = {}) ⇒ Types::CreateDomainOutput

Creates an Amazon DataZone domain.

Examples:

Request syntax with placeholder values


resp = client.create_domain({
  name: "String", # required
  description: "String",
  single_sign_on: {
    type: "IAM_IDC", # accepts IAM_IDC, DISABLED
    user_assignment: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
    idc_instance_arn: "SingleSignOnIdcInstanceArnString",
  },
  domain_execution_role: "RoleArn", # required
  kms_key_identifier: "KmsKeyArn",
  tags: {
    "TagKey" => "TagValue",
  },
  domain_version: "V1", # accepts V1, V2
  service_role: "RoleArn",
  client_token: "String",
})

Response structure


resp.id #=> String
resp.root_domain_unit_id #=> String
resp.name #=> String
resp.description #=> String
resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED"
resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL"
resp.single_sign_on.idc_instance_arn #=> String
resp.domain_execution_role #=> String
resp.arn #=> String
resp.kms_key_identifier #=> String
resp.status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED"
resp.portal_url #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.domain_version #=> String, one of "V1", "V2"
resp.service_role #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the Amazon DataZone domain.

  • :description (String) —

    The description of the Amazon DataZone domain.

  • :single_sign_on (Types::SingleSignOn) —

    The single-sign on configuration of the Amazon DataZone domain.

  • :domain_execution_role (required, String) —

    The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

  • :kms_key_identifier (String) —

    The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

  • :tags (Hash<String,String>) —

    The tags specified for the Amazon DataZone domain.

  • :domain_version (String) —

    The version of the domain that is created.

  • :service_role (String) —

    The service role of the domain that is created.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2772
2773
2774
2775
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2772

def create_domain(params = {}, options = {})
  req = build_request(:create_domain, params)
  req.send_request(options)
end

#create_domain_unit(params = {}) ⇒ Types::CreateDomainUnitOutput

Creates a domain unit in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.create_domain_unit({
  domain_identifier: "DomainId", # required
  name: "DomainUnitName", # required
  parent_domain_unit_identifier: "DomainUnitId", # required
  description: "DomainUnitDescription",
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.name #=> String
resp.parent_domain_unit_id #=> String
resp.description #=> String
resp.owners #=> Array
resp.owners[0].user.user_id #=> String
resp.owners[0].group.group_id #=> String
resp.ancestor_domain_unit_ids #=> Array
resp.ancestor_domain_unit_ids[0] #=> String
resp.created_at #=> Time
resp.created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to crate a domain unit.

  • :name (required, String) —

    The name of the domain unit.

  • :parent_domain_unit_identifier (required, String) —

    The ID of the parent domain unit.

  • :description (String) —

    The description of the domain unit.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



2839
2840
2841
2842
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2839

def create_domain_unit(params = {}, options = {})
  req = build_request(:create_domain_unit, params)
  req.send_request(options)
end

#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput

Create an Amazon DataZone environment.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  project_identifier: "ProjectId", # required
  domain_identifier: "DomainId", # required
  description: "String",
  name: "String", # required
  environment_profile_identifier: "EnvironmentProfileId",
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
  glossary_terms: ["GlossaryTermId"],
  environment_account_identifier: "String",
  environment_account_region: "String",
  environment_blueprint_identifier: "String",
  deployment_order: 1,
  environment_configuration_id: "String",
})

Response structure


resp.project_id #=> String
resp.id #=> String
resp.domain_id #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.name #=> String
resp.description #=> String
resp.environment_profile_id #=> String
resp. #=> String
resp. #=> String
resp.provider #=> String
resp.provisioned_resources #=> Array
resp.provisioned_resources[0].provider #=> String
resp.provisioned_resources[0].name #=> String
resp.provisioned_resources[0].value #=> String
resp.provisioned_resources[0].type #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "VALIDATION_FAILED", "SUSPENDED", "DISABLED", "EXPIRED", "DELETED", "INACCESSIBLE"
resp.environment_actions #=> Array
resp.environment_actions[0].type #=> String
resp.environment_actions[0].auth #=> String, one of "IAM", "HTTPS"
resp.environment_actions[0].parameters #=> Array
resp.environment_actions[0].parameters[0].key #=> String
resp.environment_actions[0].parameters[0].value #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean
resp.last_deployment.deployment_id #=> String
resp.last_deployment.deployment_type #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.last_deployment.deployment_status #=> String, one of "IN_PROGRESS", "SUCCESSFUL", "FAILED", "PENDING_DEPLOYMENT"
resp.last_deployment.failure_reason.code #=> String
resp.last_deployment.failure_reason.message #=> String
resp.last_deployment.messages #=> Array
resp.last_deployment.messages[0] #=> String
resp.last_deployment.is_deployment_complete #=> Boolean
resp.provisioning_properties.cloud_formation.template_url #=> String
resp.deployment_properties.start_timeout_minutes #=> Integer
resp.deployment_properties.end_timeout_minutes #=> Integer
resp.environment_blueprint_id #=> String
resp.environment_configuration_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_identifier (required, String) —

    The identifier of the Amazon DataZone project in which this environment is created.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which the environment is created.

  • :description (String) —

    The description of the Amazon DataZone environment.

  • :name (required, String) —

    The name of the Amazon DataZone environment.

  • :environment_profile_identifier (String) —

    The identifier of the environment profile that is used to create this Amazon DataZone environment.

  • :user_parameters (Array<Types::EnvironmentParameter>) —

    The user parameters of this Amazon DataZone environment.

  • :glossary_terms (Array<String>) —

    The glossary terms that can be used in this Amazon DataZone environment.

  • :environment_account_identifier (String) —

    The ID of the account in which the environment is being created.

  • :environment_account_region (String) —

    The region of the account in which the environment is being created.

  • :environment_blueprint_identifier (String) —

    The ID of the blueprint with which the environment is being created.

  • :deployment_order (Integer) —

    The deployment order of the environment.

  • :environment_configuration_id (String) —

    The configuration ID of the environment.

Returns:

See Also:



2987
2988
2989
2990
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2987

def create_environment(params = {}, options = {})
  req = build_request(:create_environment, params)
  req.send_request(options)
end

#create_environment_action(params = {}) ⇒ Types::CreateEnvironmentActionOutput

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

Examples:

Request syntax with placeholder values


resp = client.create_environment_action({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  name: "String", # required
  parameters: { # required
    aws_console_link: {
      uri: "String",
    },
  },
  description: "String",
})

Response structure


resp.domain_id #=> String
resp.environment_id #=> String
resp.id #=> String
resp.name #=> String
resp.parameters.aws_console_link.uri #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the environment action is created.

  • :environment_identifier (required, String) —

    The ID of the environment in which the environment action is created.

  • :name (required, String) —

    The name of the environment action.

  • :parameters (required, Types::ActionParameters) —

    The parameters of the environment action.

  • :description (String) —

    The description of the environment action that is being created in the environment.

Returns:

See Also:



3048
3049
3050
3051
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3048

def create_environment_action(params = {}, options = {})
  req = build_request(:create_environment_action, params)
  req.send_request(options)
end

#create_environment_blueprint(params = {}) ⇒ Types::CreateEnvironmentBlueprintOutput

Creates a Amazon DataZone blueprint.

Examples:

Request syntax with placeholder values


resp = client.create_environment_blueprint({
  domain_identifier: "DomainId", # required
  name: "EnvironmentBlueprintName", # required
  description: "Description",
  provisioning_properties: { # required
    cloud_formation: {
      template_url: "String", # required
    },
  },
  user_parameters: [
    {
      key_name: "CustomParameterKeyNameString", # required
      description: "Description",
      field_type: "String", # required
      default_value: "String",
      is_editable: false,
      is_optional: false,
      is_update_supported: false,
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.provider #=> String
resp.provisioning_properties.cloud_formation.template_url #=> String
resp.deployment_properties.start_timeout_minutes #=> Integer
resp.deployment_properties.end_timeout_minutes #=> Integer
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain in which this blueprint is created.

  • :name (required, String) —

    The name of this Amazon DataZone blueprint.

  • :description (String) —

    The description of the Amazon DataZone blueprint.

  • :provisioning_properties (required, Types::ProvisioningProperties) —

    The provisioning properties of this Amazon DataZone blueprint.

  • :user_parameters (Array<Types::CustomParameter>) —

    The user parameters of this Amazon DataZone blueprint.

Returns:

See Also:



3133
3134
3135
3136
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3133

def create_environment_blueprint(params = {}, options = {})
  req = build_request(:create_environment_blueprint, params)
  req.send_request(options)
end

#create_environment_profile(params = {}) ⇒ Types::CreateEnvironmentProfileOutput

Creates an Amazon DataZone environment profile.

Examples:

Request syntax with placeholder values


resp = client.create_environment_profile({
  domain_identifier: "DomainId", # required
  name: "EnvironmentProfileName", # required
  description: "Description",
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
  project_identifier: "ProjectId", # required
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp. #=> String
resp. #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.name #=> String
resp.description #=> String
resp.environment_blueprint_id #=> String
resp.project_id #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this environment profile is created.

  • :name (required, String) —

    The name of this Amazon DataZone environment profile.

  • :description (String) —

    The description of this Amazon DataZone environment profile.

  • :environment_blueprint_identifier (required, String) —

    The ID of the blueprint with which this environment profile is created.

  • :project_identifier (required, String) —

    The identifier of the project in which to create the environment profile.

  • :user_parameters (Array<Types::EnvironmentParameter>) —

    The user parameters of this Amazon DataZone environment profile.

  • :aws_account_id (String) —

    The Amazon Web Services account in which the Amazon DataZone environment is created.

  • :aws_account_region (String) —

    The Amazon Web Services region in which this environment profile is created.

Returns:

See Also:



3228
3229
3230
3231
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3228

def create_environment_profile(params = {}, options = {})
  req = build_request(:create_environment_profile, params)
  req.send_request(options)
end

#create_form_type(params = {}) ⇒ Types::CreateFormTypeOutput

Creates a metadata form type.

Prerequisites:

  • The domain must exist and be in an ENABLED state.

  • The owning project must exist and be accessible.

  • The name must be unique within the domain.

For custom form types, to indicate that a field should be searchable, annotate it with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. To indicate that a field should be indexed for lexical search (which disables semantic search but supports stemmed and partial matches), annotate it with @amazon.datazone#searchable(modes:["LEXICAL"]). To indicate that a field should be indexed for technical identifier search (for more information on technical identifier search, see: https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/), annotate it with @amazon.datazone#searchable(modes:["TECHNICAL"]).

To denote that a field will store glossary term ids (which are filterable via the Search/SearchListings APIs), annotate it with @amazon.datazone#glossaryterm("${GLOSSARY_ID}"), where ${GLOSSARY_ID} is the id of the glossary that the glossary terms stored in the field belong to.

Examples:

Request syntax with placeholder values


resp = client.create_form_type({
  domain_identifier: "DomainId", # required
  name: "FormTypeName", # required
  model: { # required
    smithy: "Smithy",
  },
  owning_project_identifier: "ProjectId", # required
  status: "ENABLED", # accepts ENABLED, DISABLED
  description: "Description",
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.revision #=> String
resp.description #=> String
resp.owning_project_id #=> String
resp.origin_domain_id #=> String
resp.origin_project_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this metadata form type is created.

  • :name (required, String) —

    The name of this Amazon DataZone metadata form type.

  • :model (required, Types::Model) —

    The model of this Amazon DataZone metadata form type.

  • :owning_project_identifier (required, String) —

    The ID of the Amazon DataZone project that owns this metadata form type.

  • :status (String) —

    The status of this Amazon DataZone metadata form type.

  • :description (String) —

    The description of this Amazon DataZone metadata form type.

Returns:

See Also:



3323
3324
3325
3326
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3323

def create_form_type(params = {}, options = {})
  req = build_request(:create_form_type, params)
  req.send_request(options)
end

#create_glossary(params = {}) ⇒ Types::CreateGlossaryOutput

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:

  • Domain must exist and be in an active state.

  • Owning project must exist and be accessible by the caller.

  • The glossary name must be unique within the domain.

Examples:

Request syntax with placeholder values


resp = client.create_glossary({
  domain_identifier: "DomainId", # required
  name: "GlossaryName", # required
  owning_project_identifier: "ProjectId", # required
  description: "GlossaryDescription",
  status: "DISABLED", # accepts DISABLED, ENABLED
  usage_restrictions: ["ASSET_GOVERNED_TERMS"], # accepts ASSET_GOVERNED_TERMS
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> String
resp.description #=> String
resp.status #=> String, one of "DISABLED", "ENABLED"
resp.usage_restrictions #=> Array
resp.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this business glossary is created.

  • :name (required, String) —

    The name of this business glossary.

  • :owning_project_identifier (required, String) —

    The ID of the project that currently owns business glossary.

  • :description (String) —

    The description of this business glossary.

  • :status (String) —

    The status of this business glossary.

  • :usage_restrictions (Array<String>) —

    The usage restriction of the restricted glossary.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



3412
3413
3414
3415
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3412

def create_glossary(params = {}, options = {})
  req = build_request(:create_glossary, params)
  req.send_request(options)
end

#create_glossary_term(params = {}) ⇒ Types::CreateGlossaryTermOutput

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:

  • Domain must exist.

  • Glossary must exist.

  • The term name must be unique within the glossary.

  • Ensure term does not conflict with existing terms in hierarchy.

Examples:

Request syntax with placeholder values


resp = client.create_glossary_term({
  domain_identifier: "DomainId", # required
  glossary_identifier: "GlossaryTermId", # required
  name: "GlossaryTermName", # required
  status: "ENABLED", # accepts ENABLED, DISABLED
  short_description: "ShortDescription",
  long_description: "LongDescription",
  term_relations: {
    is_a: ["GlossaryTermId"],
    classifies: ["GlossaryTermId"],
  },
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.glossary_id #=> String
resp.name #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.short_description #=> String
resp.long_description #=> String
resp.term_relations.is_a #=> Array
resp.term_relations.is_a[0] #=> String
resp.term_relations.classifies #=> Array
resp.term_relations.classifies[0] #=> String
resp.usage_restrictions #=> Array
resp.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this business glossary term is created.

  • :glossary_identifier (required, String) —

    The ID of the business glossary in which this term is created.

  • :name (required, String) —

    The name of this business glossary term.

  • :status (String) —

    The status of this business glossary term.

  • :short_description (String) —

    The short description of this business glossary term.

  • :long_description (String) —

    The long description of this business glossary term.

  • :term_relations (Types::TermRelations) —

    The term relations of this business glossary term.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



3517
3518
3519
3520
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3517

def create_glossary_term(params = {}, options = {})
  req = build_request(:create_glossary_term, params)
  req.send_request(options)
end

#create_group_profile(params = {}) ⇒ Types::CreateGroupProfileOutput

Creates a group profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.create_group_profile({
  domain_identifier: "DomainId", # required
  group_identifier: "GroupIdentifier", # required
  client_token: "String",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"
resp.group_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which the group profile is created.

  • :group_identifier (required, String) —

    The identifier of the group for which the group profile is created.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



3564
3565
3566
3567
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3564

def create_group_profile(params = {}, options = {})
  req = build_request(:create_group_profile, params)
  req.send_request(options)
end

#create_listing_change_set(params = {}) ⇒ Types::CreateListingChangeSetOutput

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

Examples:

Request syntax with placeholder values


resp = client.create_listing_change_set({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, DATA_PRODUCT
  entity_revision: "Revision",
  action: "PUBLISH", # required, accepts PUBLISH, UNPUBLISH
  client_token: "ClientToken",
})

Response structure


resp.listing_id #=> String
resp.listing_revision #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain.

  • :entity_identifier (required, String) —

    The ID of the asset.

  • :entity_type (required, String) —

    The type of an entity.

  • :entity_revision (String) —

    The revision of an asset.

  • :action (required, String) —

    Specifies whether to publish or unpublish a listing.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



3621
3622
3623
3624
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3621

def create_listing_change_set(params = {}, options = {})
  req = build_request(:create_listing_change_set, params)
  req.send_request(options)
end

#create_project(params = {}) ⇒ Types::CreateProjectOutput

Creates an Amazon DataZone project.

Examples:

Request syntax with placeholder values


resp = client.create_project({
  domain_identifier: "DomainId", # required
  name: "ProjectName", # required
  description: "Description",
  resource_tags: {
    "TagKey" => "TagValue",
  },
  glossary_terms: ["GlossaryTermId"],
  domain_unit_id: "DomainUnitId",
  project_profile_id: "ProjectProfileId",
  user_parameters: [
    {
      environment_id: "EnvironmentId",
      environment_resolved_account: {
        aws_account_id: "AwsAccountId", # required
        region_name: "AwsRegion", # required
        source_account_pool_id: "AccountPoolId",
      },
      environment_configuration_name: "EnvironmentConfigurationName",
      environment_parameters: [
        {
          name: "String",
          value: "String",
        },
      ],
    },
  ],
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.failure_reasons #=> Array
resp.failure_reasons[0].code #=> String
resp.failure_reasons[0].message #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.resource_tags #=> Array
resp.resource_tags[0].key #=> String
resp.resource_tags[0].value #=> String
resp.resource_tags[0].source #=> String, one of "PROJECT", "PROJECT_PROFILE"
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.domain_unit_id #=> String
resp.project_profile_id #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].environment_id #=> String
resp.user_parameters[0].. #=> String
resp.user_parameters[0]..region_name #=> String
resp.user_parameters[0].. #=> String
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_parameters #=> Array
resp.user_parameters[0].environment_parameters[0].name #=> String
resp.user_parameters[0].environment_parameters[0].value #=> String
resp.environment_deployment_details.overall_deployment_status #=> String, one of "PENDING_DEPLOYMENT", "IN_PROGRESS", "SUCCESSFUL", "FAILED_VALIDATION", "FAILED_DEPLOYMENT"
resp.environment_deployment_details.environment_failure_reasons #=> Hash
resp.environment_deployment_details.environment_failure_reasons["String"] #=> Array
resp.environment_deployment_details.environment_failure_reasons["String"][0].code #=> String
resp.environment_deployment_details.environment_failure_reasons["String"][0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this project is created.

  • :name (required, String) —

    The name of the Amazon DataZone project.

  • :description (String) —

    The description of the Amazon DataZone project.

  • :resource_tags (Hash<String,String>) —

    The resource tags of the project.

  • :glossary_terms (Array<String>) —

    The glossary terms that can be used in this Amazon DataZone project.

  • :domain_unit_id (String) —

    The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

  • :project_profile_id (String) —

    The ID of the project profile.

  • :user_parameters (Array<Types::EnvironmentConfigurationUserParameter>) —

    The user parameters of the project.

Returns:

See Also:



3743
3744
3745
3746
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3743

def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end

#create_project_membership(params = {}) ⇒ Struct

Creates a project membership in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.create_project_membership({
  domain_identifier: "DomainId", # required
  project_identifier: "ProjectId", # required
  member: { # required
    user_identifier: "String",
    group_identifier: "String",
  },
  designation: "PROJECT_OWNER", # required, accepts PROJECT_OWNER, PROJECT_CONTRIBUTOR, PROJECT_CATALOG_VIEWER, PROJECT_CATALOG_CONSUMER, PROJECT_CATALOG_STEWARD
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which project membership is created.

  • :project_identifier (required, String) —

    The ID of the project for which this project membership was created.

  • :member (required, Types::Member) —

    The project member whose project membership was created.

  • :designation (required, String) —

    The designation of the project membership.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3781
3782
3783
3784
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3781

def create_project_membership(params = {}, options = {})
  req = build_request(:create_project_membership, params)
  req.send_request(options)
end

#create_project_profile(params = {}) ⇒ Types::CreateProjectProfileOutput

Creates a project profile.

Examples:

Request syntax with placeholder values


resp = client.create_project_profile({
  domain_identifier: "DomainId", # required
  name: "ProjectProfileName", # required
  description: "Description",
  status: "ENABLED", # accepts ENABLED, DISABLED
  project_resource_tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
      is_value_editable: false, # required
    },
  ],
  allow_custom_project_resource_tags: false,
  project_resource_tags_description: "Description",
  environment_configurations: [
    {
      name: "EnvironmentConfigurationName", # required
      id: "EnvironmentConfigurationId",
      environment_blueprint_id: "EnvironmentBlueprintId", # required
      description: "Description",
      deployment_mode: "ON_CREATE", # accepts ON_CREATE, ON_DEMAND
      configuration_parameters: {
        ssm_path: "ParameterStorePath",
        parameter_overrides: [
          {
            name: "EnvironmentConfigurationParameterName",
            value: "String",
            is_editable: false,
          },
        ],
        resolved_parameters: [
          {
            name: "EnvironmentConfigurationParameterName",
            value: "String",
            is_editable: false,
          },
        ],
      },
      aws_account: {
        aws_account_id: "AwsAccountId",
        aws_account_id_path: "ParameterStorePath",
      },
      account_pools: ["AccountPoolId"],
      aws_region: {
        region_name: "RegionName",
        region_name_path: "ParameterStorePath",
      },
      deployment_order: 1,
    },
  ],
  domain_unit_identifier: "DomainUnitId",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.project_resource_tags #=> Array
resp.project_resource_tags[0].key #=> String
resp.project_resource_tags[0].value #=> String
resp.project_resource_tags[0].is_value_editable #=> Boolean
resp.allow_custom_project_resource_tags #=> Boolean
resp.project_resource_tags_description #=> String
resp.environment_configurations #=> Array
resp.environment_configurations[0].name #=> String
resp.environment_configurations[0].id #=> String
resp.environment_configurations[0].environment_blueprint_id #=> String
resp.environment_configurations[0].description #=> String
resp.environment_configurations[0].deployment_mode #=> String, one of "ON_CREATE", "ON_DEMAND"
resp.environment_configurations[0].configuration_parameters.ssm_path #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides #=> Array
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].name #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].value #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].is_editable #=> Boolean
resp.environment_configurations[0].configuration_parameters.resolved_parameters #=> Array
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].name #=> String
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].value #=> String
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].is_editable #=> Boolean
resp.environment_configurations[0].. #=> String
resp.environment_configurations[0].. #=> String
resp.environment_configurations[0]. #=> Array
resp.environment_configurations[0].[0] #=> String
resp.environment_configurations[0].aws_region.region_name #=> String
resp.environment_configurations[0].aws_region.region_name_path #=> String
resp.environment_configurations[0].deployment_order #=> Integer
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.domain_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    A domain ID of the project profile.

  • :name (required, String) —

    Project profile name.

  • :description (String) —

    A description of a project profile.

  • :status (String) —

    Project profile status.

  • :project_resource_tags (Array<Types::ResourceTagParameter>) —

    The resource tags of the project profile.

  • :allow_custom_project_resource_tags (Boolean) —

    Specifies whether custom project resource tags are supported.

  • :project_resource_tags_description (String) —

    Field viewable through the UI that provides a project user with the allowed resource tag specifications.

  • :environment_configurations (Array<Types::EnvironmentConfiguration>) —

    Environment configurations of the project profile.

  • :domain_unit_identifier (String) —

    A domain unit ID of the project profile.

Returns:

See Also:



3931
3932
3933
3934
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3931

def create_project_profile(params = {}, options = {})
  req = build_request(:create_project_profile, params)
  req.send_request(options)
end

#create_rule(params = {}) ⇒ Types::CreateRuleOutput

Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Examples:

Request syntax with placeholder values


resp = client.create_rule({
  domain_identifier: "DomainId", # required
  name: "RuleName", # required
  target: { # required
    domain_unit_target: {
      domain_unit_id: "DomainUnitId", # required
      include_child_domain_units: false,
    },
  },
  action: "CREATE_LISTING_CHANGE_SET", # required, accepts CREATE_LISTING_CHANGE_SET, CREATE_SUBSCRIPTION_REQUEST
  scope: { # required
    asset_type: {
      selection_mode: "ALL", # required, accepts ALL, SPECIFIC
      specific_asset_types: ["AssetTypeIdentifier"],
    },
    data_product: false,
    project: {
      selection_mode: "ALL", # required, accepts ALL, SPECIFIC
      specific_projects: ["ProjectId"],
    },
  },
  detail: { # required
    metadata_form_enforcement_detail: {
      required_metadata_forms: [
        {
          type_identifier: "FormTypeIdentifier", # required
          type_revision: "Revision", # required
        },
      ],
    },
    glossary_term_enforcement_detail: {
      required_glossary_term_ids: ["GlossaryTermId"],
    },
  },
  description: "Description",
  client_token: "ClientToken",
})

Response structure


resp.identifier #=> String
resp.name #=> String
resp.rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT", "GLOSSARY_TERM_ENFORCEMENT"
resp.target.domain_unit_target.domain_unit_id #=> String
resp.target.domain_unit_target.include_child_domain_units #=> Boolean
resp.action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.scope.asset_type.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.scope.asset_type.specific_asset_types #=> Array
resp.scope.asset_type.specific_asset_types[0] #=> String
resp.scope.data_product #=> Boolean
resp.scope.project.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.scope.project.specific_projects #=> Array
resp.scope.project.specific_projects[0] #=> String
resp.detail.metadata_form_enforcement_detail.required_metadata_forms #=> Array
resp.detail.metadata_form_enforcement_detail.required_metadata_forms[0].type_identifier #=> String
resp.detail.metadata_form_enforcement_detail.required_metadata_forms[0].type_revision #=> String
resp.detail.glossary_term_enforcement_detail.required_glossary_term_ids #=> Array
resp.detail.glossary_term_enforcement_detail.required_glossary_term_ids[0] #=> String
resp.target_type #=> String, one of "DOMAIN_UNIT"
resp.description #=> String
resp.created_at #=> Time
resp.created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the rule is created.

  • :name (required, String) —

    The name of the rule.

  • :target (required, Types::RuleTarget) —

    The target of the rule.

  • :action (required, String) —

    The action of the rule.

  • :scope (required, Types::RuleScope) —

    The scope of the rule.

  • :detail (required, Types::RuleDetail) —

    The detail of the rule.

  • :description (String) —

    The description of the rule.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4057
4058
4059
4060
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4057

def create_rule(params = {}, options = {})
  req = build_request(:create_rule, params)
  req.send_request(options)
end

#create_subscription_grant(params = {}) ⇒ Types::CreateSubscriptionGrantOutput

Creates a subsscription grant in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.create_subscription_grant({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  subscription_target_identifier: "SubscriptionTargetId",
  granted_entity: { # required
    listing: {
      identifier: "ListingId", # required
      revision: "Revision", # required
    },
  },
  asset_target_names: [
    {
      asset_id: "AssetId", # required
      target_name: "String", # required
    },
  ],
  client_token: "String",
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.environment_id #=> String
resp.subscription_target_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "REVOKED", "GRANT_FAILED", "REVOKE_FAILED"
resp.assets[0].target_name #=> String
resp.assets[0].failure_cause.message #=> String
resp.assets[0].granted_timestamp #=> Time
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.filter_ids #=> Array
resp.assets[0].asset_scope.filter_ids[0] #=> String
resp.assets[0].asset_scope.status #=> String
resp.assets[0].asset_scope.error_message #=> String
resp.assets[0].permissions.s3 #=> Array
resp.assets[0].permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscription_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription grant is created.

  • :environment_identifier (required, String) —

    The ID of the environment in which the subscription grant is created.

  • :subscription_target_identifier (String) —

    The ID of the subscription target for which the subscription grant is created.

  • :granted_entity (required, Types::GrantedEntityInput) —

    The entity to which the subscription is to be granted.

  • :asset_target_names (Array<Types::AssetTargetNameMap>) —

    The names of the assets for which the subscription grant is created.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4158
4159
4160
4161
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4158

def create_subscription_grant(params = {}, options = {})
  req = build_request(:create_subscription_grant, params)
  req.send_request(options)
end

#create_subscription_request(params = {}) ⇒ Types::CreateSubscriptionRequestOutput

Creates a subscription request in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.create_subscription_request({
  domain_identifier: "DomainId", # required
  subscribed_principals: [ # required
    {
      project: {
        identifier: "ProjectId",
      },
      user: {
        identifier: "UserProfileId",
      },
      group: {
        identifier: "GroupProfileId",
      },
      iam: {
        identifier: "IamPrincipalArn",
      },
    },
  ],
  subscribed_listings: [ # required
    {
      identifier: "ListingId", # required
    },
  ],
  request_reason: "RequestReason", # required
  client_token: "String",
  metadata_forms: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  asset_permissions: [
    {
      asset_id: "AssetId", # required
      permissions: { # required
        s3: ["READ"], # accepts READ, WRITE
      },
    },
  ],
  asset_scopes: [
    {
      asset_id: "AssetId", # required
      filter_ids: ["FilterId"], # required
    },
  ],
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.request_reason #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.subscribed_principals[0].user.id #=> String
resp.subscribed_principals[0].user.details.iam.arn #=> String
resp.subscribed_principals[0].user.details.iam.principal_id #=> String
resp.subscribed_principals[0].user.details.sso.username #=> String
resp.subscribed_principals[0].user.details.sso.first_name #=> String
resp.subscribed_principals[0].user.details.sso.last_name #=> String
resp.subscribed_principals[0].group.id #=> String
resp.subscribed_principals[0].group.name #=> String
resp.subscribed_principals[0].iam.principal_arn #=> String
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_listings[0].name #=> String
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.subscribed_listings[0].item.asset_listing.forms #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.status #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listings[0].item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listings[0].item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listings[0].item.product_listing.entity_id #=> String
resp.subscribed_listings[0].item.product_listing.entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.product_listing.name #=> String
resp.subscribed_listings[0].item.product_listing.description #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings #=> Array
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.reviewer_id #=> String
resp.decision_comment #=> String
resp.existing_subscription_id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.metadata_forms[0].content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription request is created.

  • :subscribed_principals (required, Array<Types::SubscribedPrincipalInput>) —

    The Amazon DataZone principals for whom the subscription request is created.

  • :subscribed_listings (required, Array<Types::SubscribedListingInput>) —

    The published asset for which the subscription grant is to be created.

  • :request_reason (required, String) —

    The reason for the subscription request.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :metadata_forms (Array<Types::FormInput>) —

    The metadata form included in the subscription request.

  • :asset_permissions (Array<Types::AssetPermission>) —

    The asset permissions of the subscription request.

  • :asset_scopes (Array<Types::AcceptedAssetScope>) —

    The asset scopes of the subscription request.

Returns:

See Also:



4330
4331
4332
4333
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4330

def create_subscription_request(params = {}, options = {})
  req = build_request(:create_subscription_request, params)
  req.send_request(options)
end

#create_subscription_target(params = {}) ⇒ Types::CreateSubscriptionTargetOutput

Creates a subscription target in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.create_subscription_target({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  name: "SubscriptionTargetName", # required
  type: "String", # required
  subscription_target_config: [ # required
    {
      form_name: "FormName", # required
      content: "String", # required
    },
  ],
  authorized_principals: ["AuthorizedPrincipalIdentifier"], # required
  manage_access_role: "IamRoleArn", # required
  applicable_asset_types: ["TypeName"], # required
  provider: "String",
  client_token: "String",
  subscription_grant_creation_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
})

Response structure


resp.id #=> String
resp.authorized_principals #=> Array
resp.authorized_principals[0] #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.name #=> String
resp.type #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.manage_access_role #=> String
resp.applicable_asset_types #=> Array
resp.applicable_asset_types[0] #=> String
resp.subscription_target_config #=> Array
resp.subscription_target_config[0].form_name #=> String
resp.subscription_target_config[0].content #=> String
resp.provider #=> String
resp.subscription_grant_creation_mode #=> String, one of "AUTOMATIC", "MANUAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which subscription target is created.

  • :environment_identifier (required, String) —

    The ID of the environment in which subscription target is created.

  • :name (required, String) —

    The name of the subscription target.

  • :type (required, String) —

    The type of the subscription target.

  • :subscription_target_config (required, Array<Types::SubscriptionTargetForm>) —

    The configuration of the subscription target.

  • :authorized_principals (required, Array<String>) —

    The authorized principals of the subscription target.

  • :manage_access_role (required, String) —

    The manage access role that is used to create the subscription target.

  • :applicable_asset_types (required, Array<String>) —

    The asset types that can be included in the subscription target.

  • :provider (String) —

    The provider of the subscription target.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :subscription_grant_creation_mode (String) —

    Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

Returns:

See Also:



4444
4445
4446
4447
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4444

def create_subscription_target(params = {}, options = {})
  req = build_request(:create_subscription_target, params)
  req.send_request(options)
end

#create_user_profile(params = {}) ⇒ Types::CreateUserProfileOutput

Creates a user profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  user_identifier: "UserIdentifier", # required
  user_type: "IAM_USER", # accepts IAM_USER, IAM_ROLE, SSO_USER
  client_token: "String",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.type #=> String, one of "IAM", "SSO"
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED"
resp.details.iam.arn #=> String
resp.details.iam.principal_id #=> String
resp.details.sso.username #=> String
resp.details.sso.first_name #=> String
resp.details.sso.last_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a user profile is created.

  • :user_identifier (required, String) —

    The identifier of the user for which the user profile is created.

  • :user_type (String) —

    The user type of the user for which the user profile is created.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4501
4502
4503
4504
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4501

def (params = {}, options = {})
  req = build_request(:create_user_profile, params)
  req.send_request(options)
end

#delete_account_pool(params = {}) ⇒ Struct

Deletes an account pool.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  identifier: "AccountPoolId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the account pool is deleted.

  • :identifier (required, String) —

    The ID of the account pool to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4527
4528
4529
4530
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4527

def (params = {}, options = {})
  req = build_request(:delete_account_pool, params)
  req.send_request(options)
end

#delete_asset(params = {}) ⇒ Struct

Deletes an asset in Amazon DataZone.

  • --domain-identifier must refer to a valid and existing domain.

  • --identifier must refer to an existing asset in the specified domain.

  • Asset must not be referenced in any existing asset filters.

  • Asset must not be linked to any draft or published data product.

  • User must have delete permissions for the domain and project.

Examples:

Request syntax with placeholder values


resp = client.delete_asset({
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the asset is deleted.

  • :identifier (required, String) —

    The identifier of the asset that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4564
4565
4566
4567
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4564

def delete_asset(params = {}, options = {})
  req = build_request(:delete_asset, params)
  req.send_request(options)
end

#delete_asset_filter(params = {}) ⇒ Struct

Deletes an asset filter.

Prerequisites:

  • The asset filter must exist.

  • The domain and asset must not have been deleted.

  • Ensure the --identifier refers to a valid filter ID.

Examples:

Request syntax with placeholder values


resp = client.delete_asset_filter({
  domain_identifier: "DomainId", # required
  asset_identifier: "AssetId", # required
  identifier: "FilterId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4602
4603
4604
4605
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4602

def delete_asset_filter(params = {}, options = {})
  req = build_request(:delete_asset_filter, params)
  req.send_request(options)
end

#delete_asset_type(params = {}) ⇒ Struct

Deletes an asset type in Amazon DataZone.

Prerequisites:

  • The asset type must exist in the domain.

  • You must have DeleteAssetType permission.

  • The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail.

  • You should retrieve the asset type using get-asset-type to confirm its presence before deletion.

Examples:

Request syntax with placeholder values


resp = client.delete_asset_type({
  domain_identifier: "DomainId", # required
  identifier: "AssetTypeIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the asset type is deleted.

  • :identifier (required, String) —

    The identifier of the asset type that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4641
4642
4643
4644
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4641

def delete_asset_type(params = {}, options = {})
  req = build_request(:delete_asset_type, params)
  req.send_request(options)
end

#delete_connection(params = {}) ⇒ Types::DeleteConnectionOutput

Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  domain_identifier: "DomainId", # required
  identifier: "ConnectionId", # required
})

Response structure


resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the connection is deleted.

  • :identifier (required, String) —

    The ID of the connection that is deleted.

Returns:

See Also:



4675
4676
4677
4678
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4675

def delete_connection(params = {}, options = {})
  req = build_request(:delete_connection, params)
  req.send_request(options)
end

#delete_data_export_configuration(params = {}) ⇒ Struct

Deletes data export configuration for a domain.

This operation does not delete the S3 table created by the PutDataExportConfiguration operation.

To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the --no-enable-export flag instead. This allows you to re-enable export for the same domain using the --enable-export flag without deleting S3 table.

Examples:

Request syntax with placeholder values


resp = client.delete_data_export_configuration({
  domain_identifier: "DomainId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The domain ID for which you want to delete the data export configuration.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4706
4707
4708
4709
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4706

def delete_data_export_configuration(params = {}, options = {})
  req = build_request(:delete_data_export_configuration, params)
  req.send_request(options)
end

#delete_data_product(params = {}) ⇒ Struct

Deletes a data product in Amazon DataZone.

Prerequisites:

  • The data product must exist and not be deleted or archived.

  • The user must have delete permissions for the data product.

  • Domain and project must be active.

Examples:

Request syntax with placeholder values


resp = client.delete_data_product({
  domain_identifier: "DomainId", # required
  identifier: "DataProductId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the data product is deleted.

  • :identifier (required, String) —

    The identifier of the data product that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4741
4742
4743
4744
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4741

def delete_data_product(params = {}, options = {})
  req = build_request(:delete_data_product, params)
  req.send_request(options)
end

#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceOutput

Deletes a data source in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_data_source({
  domain_identifier: "DomainId", # required
  identifier: "DataSourceId", # required
  client_token: "String",
  retain_permissions_on_revoke_failure: false,
})

Response structure


resp.id #=> String
resp.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.name #=> String
resp.description #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.connection_id #=> String
resp.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.region #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.region #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.redshift_run_configuration.redshift_credential_configuration.secret_manager_arn #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_cluster_source.cluster_name #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_serverless_source.workgroup_name #=> String
resp.configuration.sage_maker_run_configuration. #=> String
resp.configuration.sage_maker_run_configuration.region #=> String
resp.configuration.sage_maker_run_configuration.tracking_assets #=> Hash
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"] #=> Array
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"][0] #=> String
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.publish_on_import #=> Boolean
resp.asset_forms_output #=> Array
resp.asset_forms_output[0].form_name #=> String
resp.asset_forms_output[0].type_name #=> String
resp.asset_forms_output[0].type_revision #=> String
resp.asset_forms_output[0].content #=> String
resp.schedule.timezone #=> String, one of "UTC", "AFRICA_JOHANNESBURG", "AMERICA_MONTREAL", "AMERICA_SAO_PAULO", "ASIA_BAHRAIN", "ASIA_BANGKOK", "ASIA_CALCUTTA", "ASIA_DUBAI", "ASIA_HONG_KONG", "ASIA_JAKARTA", "ASIA_KUALA_LUMPUR", "ASIA_SEOUL", "ASIA_SHANGHAI", "ASIA_SINGAPORE", "ASIA_TAIPEI", "ASIA_TOKYO", "AUSTRALIA_MELBOURNE", "AUSTRALIA_SYDNEY", "CANADA_CENTRAL", "CET", "CST6CDT", "ETC_GMT", "ETC_GMT0", "ETC_GMT_ADD_0", "ETC_GMT_ADD_1", "ETC_GMT_ADD_10", "ETC_GMT_ADD_11", "ETC_GMT_ADD_12", "ETC_GMT_ADD_2", "ETC_GMT_ADD_3", "ETC_GMT_ADD_4", "ETC_GMT_ADD_5", "ETC_GMT_ADD_6", "ETC_GMT_ADD_7", "ETC_GMT_ADD_8", "ETC_GMT_ADD_9", "ETC_GMT_NEG_0", "ETC_GMT_NEG_1", "ETC_GMT_NEG_10", "ETC_GMT_NEG_11", "ETC_GMT_NEG_12", "ETC_GMT_NEG_13", "ETC_GMT_NEG_14", "ETC_GMT_NEG_2", "ETC_GMT_NEG_3", "ETC_GMT_NEG_4", "ETC_GMT_NEG_5", "ETC_GMT_NEG_6", "ETC_GMT_NEG_7", "ETC_GMT_NEG_8", "ETC_GMT_NEG_9", "EUROPE_DUBLIN", "EUROPE_LONDON", "EUROPE_PARIS", "EUROPE_STOCKHOLM", "EUROPE_ZURICH", "ISRAEL", "MEXICO_GENERAL", "MST7MDT", "PACIFIC_AUCKLAND", "US_CENTRAL", "US_EASTERN", "US_MOUNTAIN", "US_PACIFIC"
resp.schedule.schedule #=> String
resp.last_run_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.last_run_at #=> Time
resp.last_run_error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.last_run_error_message.error_detail #=> String
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.error_message.error_detail #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.self_grant_status.glue_self_grant_status.self_grant_status_details #=> Array
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].database_name #=> String
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].schema_name #=> String
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "GRANT_FAILED", "REVOKE_FAILED"
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].failure_cause #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details #=> Array
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].database_name #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].schema_name #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "GRANT_FAILED", "REVOKE_FAILED"
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].failure_cause #=> String
resp.retain_permissions_on_revoke_failure #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the data source is deleted.

  • :identifier (required, String) —

    The identifier of the data source that is deleted.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :retain_permissions_on_revoke_failure (Boolean) —

    Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

Returns:

See Also:



4872
4873
4874
4875
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4872

def delete_data_source(params = {}, options = {})
  req = build_request(:delete_data_source, params)
  req.send_request(options)
end

#delete_domain(params = {}) ⇒ Types::DeleteDomainOutput

Deletes a Amazon DataZone domain.

Examples:

Request syntax with placeholder values


resp = client.delete_domain({
  identifier: "DomainId", # required
  client_token: "String",
  skip_deletion_check: false,
})

Response structure


resp.status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the Amazon Web Services domain that is to be deleted.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :skip_deletion_check (Boolean) —

    Specifies the optional flag to delete all child entities within the domain.

Returns:

See Also:



4914
4915
4916
4917
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4914

def delete_domain(params = {}, options = {})
  req = build_request(:delete_domain, params)
  req.send_request(options)
end

#delete_domain_unit(params = {}) ⇒ Struct

Deletes a domain unit.

Examples:

Request syntax with placeholder values


resp = client.delete_domain_unit({
  domain_identifier: "DomainId", # required
  identifier: "DomainUnitId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to delete a domain unit.

  • :identifier (required, String) —

    The ID of the domain unit that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4940
4941
4942
4943
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4940

def delete_domain_unit(params = {}, options = {})
  req = build_request(:delete_domain_unit, params)
  req.send_request(options)
end

#delete_environment(params = {}) ⇒ Struct

Deletes an environment in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the environment is deleted.

  • :identifier (required, String) —

    The identifier of the environment that is to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4967
4968
4969
4970
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4967

def delete_environment(params = {}, options = {})
  req = build_request(:delete_environment, params)
  req.send_request(options)
end

#delete_environment_action(params = {}) ⇒ Struct

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_action({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which an environment action is deleted.

  • :environment_identifier (required, String) —

    The ID of the environment where an environment action is deleted.

  • :identifier (required, String) —

    The ID of the environment action that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4999
5000
5001
5002
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4999

def delete_environment_action(params = {}, options = {})
  req = build_request(:delete_environment_action, params)
  req.send_request(options)
end

#delete_environment_blueprint(params = {}) ⇒ Struct

Deletes a blueprint in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_blueprint({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentBlueprintId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the blueprint is deleted.

  • :identifier (required, String) —

    The ID of the blueprint that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5026
5027
5028
5029
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5026

def delete_environment_blueprint(params = {}, options = {})
  req = build_request(:delete_environment_blueprint, params)
  req.send_request(options)
end

#delete_environment_blueprint_configuration(params = {}) ⇒ Struct

Deletes the blueprint configuration in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_blueprint_configuration({
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

  • :environment_blueprint_identifier (required, String) —

    The ID of the blueprint the configuration of which is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5053
5054
5055
5056
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5053

def delete_environment_blueprint_configuration(params = {}, options = {})
  req = build_request(:delete_environment_blueprint_configuration, params)
  req.send_request(options)
end

#delete_environment_profile(params = {}) ⇒ Struct

Deletes an environment profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_profile({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentProfileId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the environment profile is deleted.

  • :identifier (required, String) —

    The ID of the environment profile that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5080
5081
5082
5083
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5080

def delete_environment_profile(params = {}, options = {})
  req = build_request(:delete_environment_profile, params)
  req.send_request(options)
end

#delete_form_type(params = {}) ⇒ Struct

Deletes and metadata form type in Amazon DataZone.

Prerequisites:

  • The form type must exist in the domain.

  • The form type must not be in use by any asset types or assets.

  • The domain must be valid and accessible.

  • User must have delete permissions on the form type.

  • Any dependencies (such as linked asset types) must be removed first.

Examples:

Request syntax with placeholder values


resp = client.delete_form_type({
  domain_identifier: "DomainId", # required
  form_type_identifier: "FormTypeIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the metadata form type is deleted.

  • :form_type_identifier (required, String) —

    The ID of the metadata form type that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5119
5120
5121
5122
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5119

def delete_form_type(params = {}, options = {})
  req = build_request(:delete_form_type, params)
  req.send_request(options)
end

#delete_glossary(params = {}) ⇒ Struct

Deletes a business glossary in Amazon DataZone.

Prerequisites:

  • The glossary must be in DISABLED state.

  • The glossary must not have any glossary terms associated with it.

  • The glossary must exist in the specified domain.

  • The caller must have the datazone:DeleteGlossary permission in the domain and glossary.

  • Glossary should not be linked to any active metadata forms.

Examples:

Request syntax with placeholder values


resp = client.delete_glossary({
  domain_identifier: "DomainId", # required
  identifier: "GlossaryId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the business glossary is deleted.

  • :identifier (required, String) —

    The ID of the business glossary that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5159
5160
5161
5162
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5159

def delete_glossary(params = {}, options = {})
  req = build_request(:delete_glossary, params)
  req.send_request(options)
end

#delete_glossary_term(params = {}) ⇒ Struct

Deletes a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist and be active.

  • The term must not be linked to other assets or child terms.

  • Caller must have delete permissions in the domain/glossary.

  • Ensure all associations (such as to assets or parent terms) are removed before deletion.

Examples:

Request syntax with placeholder values


resp = client.delete_glossary_term({
  domain_identifier: "DomainId", # required
  identifier: "GlossaryTermId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the business glossary term is deleted.

  • :identifier (required, String) —

    The ID of the business glossary term that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5197
5198
5199
5200
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5197

def delete_glossary_term(params = {}, options = {})
  req = build_request(:delete_glossary_term, params)
  req.send_request(options)
end

#delete_listing(params = {}) ⇒ Struct

Deletes a listing (a record of an asset at a given time).

Examples:

Request syntax with placeholder values


resp = client.delete_listing({
  domain_identifier: "DomainId", # required
  identifier: "ListingId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain.

  • :identifier (required, String) —

    The ID of the listing to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5223
5224
5225
5226
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5223

def delete_listing(params = {}, options = {})
  req = build_request(:delete_listing, params)
  req.send_request(options)
end

#delete_project(params = {}) ⇒ Struct

Deletes a project in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_project({
  domain_identifier: "DomainId", # required
  identifier: "ProjectId", # required
  skip_deletion_check: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the project is deleted.

  • :identifier (required, String) —

    The identifier of the project that is to be deleted.

  • :skip_deletion_check (Boolean) —

    Specifies the optional flag to delete all child entities within the project.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5254
5255
5256
5257
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5254

def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end

#delete_project_membership(params = {}) ⇒ Struct

Deletes project membership in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_project_membership({
  domain_identifier: "DomainId", # required
  project_identifier: "ProjectId", # required
  member: { # required
    user_identifier: "String",
    group_identifier: "String",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where project membership is deleted.

  • :project_identifier (required, String) —

    The ID of the Amazon DataZone project the membership to which is deleted.

  • :member (required, Types::Member) —

    The project member whose project membership is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5289
5290
5291
5292
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5289

def delete_project_membership(params = {}, options = {})
  req = build_request(:delete_project_membership, params)
  req.send_request(options)
end

#delete_project_profile(params = {}) ⇒ Struct

Deletes a project profile.

Examples:

Request syntax with placeholder values


resp = client.delete_project_profile({
  domain_identifier: "DomainId", # required
  identifier: "ProjectProfileId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where a project profile is deleted.

  • :identifier (required, String) —

    The ID of the project profile that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5315
5316
5317
5318
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5315

def delete_project_profile(params = {}, options = {})
  req = build_request(:delete_project_profile, params)
  req.send_request(options)
end

#delete_rule(params = {}) ⇒ Struct

Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Examples:

Request syntax with placeholder values


resp = client.delete_rule({
  domain_identifier: "DomainId", # required
  identifier: "RuleId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain that where the rule is to be deleted.

  • :identifier (required, String) —

    The ID of the rule that is to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5349
5350
5351
5352
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5349

def delete_rule(params = {}, options = {})
  req = build_request(:delete_rule, params)
  req.send_request(options)
end

#delete_subscription_grant(params = {}) ⇒ Types::DeleteSubscriptionGrantOutput

Deletes and subscription grant in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_subscription_grant({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionGrantId", # required
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.environment_id #=> String
resp.subscription_target_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "REVOKED", "GRANT_FAILED", "REVOKE_FAILED"
resp.assets[0].target_name #=> String
resp.assets[0].failure_cause.message #=> String
resp.assets[0].granted_timestamp #=> Time
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.filter_ids #=> Array
resp.assets[0].asset_scope.filter_ids[0] #=> String
resp.assets[0].asset_scope.status #=> String
resp.assets[0].asset_scope.error_message #=> String
resp.assets[0].permissions.s3 #=> Array
resp.assets[0].permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscription_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where the subscription grant is deleted.

  • :identifier (required, String) —

    The ID of the subscription grant that is deleted.

Returns:

See Also:



5419
5420
5421
5422
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5419

def delete_subscription_grant(params = {}, options = {})
  req = build_request(:delete_subscription_grant, params)
  req.send_request(options)
end

#delete_subscription_request(params = {}) ⇒ Struct

Deletes a subscription request in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_subscription_request({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription request is deleted.

  • :identifier (required, String) —

    The ID of the subscription request that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5446
5447
5448
5449
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5446

def delete_subscription_request(params = {}, options = {})
  req = build_request(:delete_subscription_request, params)
  req.send_request(options)
end

#delete_subscription_target(params = {}) ⇒ Struct

Deletes a subscription target in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.delete_subscription_target({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "SubscriptionTargetId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription target is deleted.

  • :environment_identifier (required, String) —

    The ID of the Amazon DataZone environment in which the subscription target is deleted.

  • :identifier (required, String) —

    The ID of the subscription target that is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5478
5479
5480
5481
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5478

def delete_subscription_target(params = {}, options = {})
  req = build_request(:delete_subscription_target, params)
  req.send_request(options)
end

#delete_time_series_data_points(params = {}) ⇒ Struct

Deletes the specified time series form for the specified asset.

Examples:

Request syntax with placeholder values


resp = client.delete_time_series_data_points({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  form_name: "TimeSeriesFormName", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to delete a time series form.

  • :entity_type (required, String) —

    The type of the asset for which you want to delete a time series form.

  • :form_name (required, String) —

    The name of the time series form that you want to delete.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5521
5522
5523
5524
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5521

def delete_time_series_data_points(params = {}, options = {})
  req = build_request(:delete_time_series_data_points, params)
  req.send_request(options)
end

#disassociate_environment_role(params = {}) ⇒ Struct

Disassociates the environment role in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.disassociate_environment_role({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  environment_role_arn: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which an environment role is disassociated.

  • :environment_identifier (required, String) —

    The ID of the environment.

  • :environment_role_arn (required, String) —

    The ARN of the environment role.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5552
5553
5554
5555
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5552

def disassociate_environment_role(params = {}, options = {})
  req = build_request(:disassociate_environment_role, params)
  req.send_request(options)
end

#disassociate_governed_terms(params = {}) ⇒ Struct

Disassociates restricted terms from an asset.

Examples:

Request syntax with placeholder values


resp = client.disassociate_governed_terms({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET
  governed_glossary_terms: ["GlossaryTermId"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to disassociate restricted terms from an asset.

  • :entity_identifier (required, String) —

    The ID of an asset from which you want to disassociate restricted terms.

  • :entity_type (required, String) —

    The type of the asset from which you want to disassociate restricted terms.

  • :governed_glossary_terms (required, Array<String>) —

    The restricted glossary terms that you want to disassociate from an asset.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5590
5591
5592
5593
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5590

def disassociate_governed_terms(params = {}, options = {})
  req = build_request(:disassociate_governed_terms, params)
  req.send_request(options)
end

#get_account_pool(params = {}) ⇒ Types::GetAccountPoolOutput

Gets the details of the account pool.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  identifier: "AccountPoolId", # required
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.id #=> String
resp.description #=> String
resp.resolution_strategy #=> String, one of "MANUAL"
resp..accounts #=> Array
resp..accounts[0]. #=> String
resp..accounts[0].supported_regions #=> Array
resp..accounts[0].supported_regions[0] #=> String
resp..accounts[0]. #=> String
resp...lambda_function_arn #=> String
resp...lambda_execution_role_arn #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.updated_by #=> String
resp.domain_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which the account pool lives whose details are to be displayed.

  • :identifier (required, String) —

    The ID of the account pool whose details are to be displayed.

Returns:

See Also:



5649
5650
5651
5652
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5649

def (params = {}, options = {})
  req = build_request(:get_account_pool, params)
  req.send_request(options)
end

#get_asset(params = {}) ⇒ Types::GetAssetOutput

Gets an Amazon DataZone asset.

An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, making them discoverable and usable while maintaining proper governance.

Before using the Amazon DataZone GetAsset command, ensure the following prerequisites are met:

  • Domain identifier must exist and be valid

  • Asset identifier must exist

  • User must have the required permissions to perform the action

Examples:

Request syntax with placeholder values


resp = client.get_asset({
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  revision: "Revision",
})

Response structure


resp.id #=> String
resp.name #=> String
resp.type_identifier #=> String
resp.type_revision #=> String
resp.external_identifier #=> String
resp.revision #=> String
resp.description #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.first_revision_created_at #=> Time
resp.first_revision_created_by #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.governed_glossary_terms #=> Array
resp.governed_glossary_terms[0] #=> String
resp.owning_project_id #=> String
resp.domain_id #=> String
resp.listing.listing_id #=> String
resp.listing.listing_status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.read_only_forms_output #=> Array
resp.read_only_forms_output[0].form_name #=> String
resp.read_only_forms_output[0].type_name #=> String
resp.read_only_forms_output[0].type_revision #=> String
resp.read_only_forms_output[0].content #=> String
resp.latest_time_series_data_point_forms_output #=> Array
resp.latest_time_series_data_point_forms_output[0].form_name #=> String
resp.latest_time_series_data_point_forms_output[0].type_identifier #=> String
resp.latest_time_series_data_point_forms_output[0].type_revision #=> String
resp.latest_time_series_data_point_forms_output[0].timestamp #=> Time
resp.latest_time_series_data_point_forms_output[0].content_summary #=> String
resp.latest_time_series_data_point_forms_output[0].id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain to which the asset belongs.

  • :identifier (required, String) —

    The ID of the Amazon DataZone asset.

    This parameter supports either the value of assetId or externalIdentifier as input. If you are passing the value of externalIdentifier, you must prefix this value with externalIdentifer%2F.

  • :revision (String) —

    The revision of the Amazon DataZone asset.

Returns:

See Also:



5761
5762
5763
5764
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5761

def get_asset(params = {}, options = {})
  req = build_request(:get_asset, params)
  req.send_request(options)
end

#get_asset_filter(params = {}) ⇒ Types::GetAssetFilterOutput

Gets an asset filter.

Prerequisites:

  • Domain (--domain-identifier), asset (--asset-identifier), and filter (--identifier) must all exist.

  • The asset filter should not have been deleted.

  • The asset must still exist (since the filter is linked to it).

Examples:

Request syntax with placeholder values


resp = client.get_asset_filter({
  domain_identifier: "DomainId", # required
  asset_identifier: "AssetId", # required
  identifier: "FilterId", # required
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.asset_id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "VALID", "INVALID"
resp.configuration.column_configuration.included_column_names #=> Array
resp.configuration.column_configuration.included_column_names[0] #=> String
resp.configuration.row_configuration.row_filter.expression.equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.not_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than.value #=> String
resp.configuration.row_configuration.row_filter.expression.less_than.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.less_than.value #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than_or_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than_or_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.less_than_or_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.less_than_or_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.is_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.is_not_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.in.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.in.values #=> Array
resp.configuration.row_configuration.row_filter.expression.in.values[0] #=> String
resp.configuration.row_configuration.row_filter.expression.not_in.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_in.values #=> Array
resp.configuration.row_configuration.row_filter.expression.not_in.values[0] #=> String
resp.configuration.row_configuration.row_filter.expression.like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.like.value #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.value #=> String
resp.configuration.row_configuration.row_filter.and #=> Array
resp.configuration.row_configuration.row_filter.and[0] #=> Types::RowFilter
resp.configuration.row_configuration.row_filter.or #=> Array
resp.configuration.row_configuration.row_filter.or[0] #=> Types::RowFilter
resp.configuration.row_configuration.sensitive #=> Boolean
resp.created_at #=> Time
resp.error_message #=> String
resp.effective_column_names #=> Array
resp.effective_column_names[0] #=> String
resp.effective_row_filter #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :identifier (required, String) —

    The ID of the asset filter.

Returns:

See Also:



5857
5858
5859
5860
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5857

def get_asset_filter(params = {}, options = {})
  req = build_request(:get_asset_filter, params)
  req.send_request(options)
end

#get_asset_type(params = {}) ⇒ Types::GetAssetTypeOutput

Gets an Amazon DataZone asset type.

Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources.

Prerequisites:

  • The asset type with identifier must exist in the domain. ResourceNotFoundException.

  • You must have the GetAssetType permission.

  • Ensure the domain-identifier value is correct and accessible.

Examples:

Request syntax with placeholder values


resp = client.get_asset_type({
  domain_identifier: "DomainId", # required
  identifier: "AssetTypeIdentifier", # required
  revision: "Revision",
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.revision #=> String
resp.description #=> String
resp.forms_output #=> Hash
resp.forms_output["FormName"].type_name #=> String
resp.forms_output["FormName"].type_revision #=> String
resp.forms_output["FormName"].required #=> Boolean
resp.owning_project_id #=> String
resp.origin_domain_id #=> String
resp.origin_project_id #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the asset type exists.

  • :identifier (required, String) —

    The ID of the asset type.

  • :revision (String) —

    The revision of the asset type.

Returns:

See Also:



5936
5937
5938
5939
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5936

def get_asset_type(params = {}, options = {})
  req = build_request(:get_asset_type, params)
  req.send_request(options)
end

#get_connection(params = {}) ⇒ Types::GetConnectionOutput

Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Examples:

Request syntax with placeholder values


resp = client.get_connection({
  domain_identifier: "DomainId", # required
  identifier: "ConnectionId", # required
  with_secret: false,
})

Response structure


resp.connection_credentials.access_key_id #=> String
resp.connection_credentials.secret_access_key #=> String
resp.connection_credentials.session_token #=> String
resp.connection_credentials.expiration #=> Time
resp.connection_id #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.environment_id #=> String
resp.environment_user_role #=> String
resp.name #=> String
resp.physical_endpoints #=> Array
resp.physical_endpoints[0].aws_location.access_role #=> String
resp.physical_endpoints[0].aws_location. #=> String
resp.physical_endpoints[0].aws_location.aws_region #=> String
resp.physical_endpoints[0].aws_location.iam_connection_id #=> String
resp.physical_endpoints[0].glue_connection_name #=> String
resp.physical_endpoints[0].glue_connection.name #=> String
resp.physical_endpoints[0].glue_connection.description #=> String
resp.physical_endpoints[0].glue_connection.connection_type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.physical_endpoints[0].glue_connection.match_criteria #=> Array
resp.physical_endpoints[0].glue_connection.match_criteria[0] #=> String
resp.physical_endpoints[0].glue_connection.connection_properties #=> Hash
resp.physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.physical_endpoints[0].glue_connection.spark_properties #=> Hash
resp.physical_endpoints[0].glue_connection.spark_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.athena_properties #=> Hash
resp.physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.python_properties #=> Hash
resp.physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list #=> Array
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list[0] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list #=> Array
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list[0] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> String
resp.physical_endpoints[0].glue_connection.creation_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.physical_endpoints[0].glue_connection.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.physical_endpoints[0].glue_connection.status_reason #=> String
resp.physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
resp.physical_endpoints[0].glue_connection.authentication_configuration.secret_arn #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_grant_type #=> String, one of "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "JWT_BEARER"
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.user_managed_client_application_client_id #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.a_ws_managed_client_application_reference #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map #=> Hash
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map["TokenUrlParametersMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.authorization_code #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.redirect_uri #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.user_managed_client_application_client_secret #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.access_token #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.refresh_token #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.jwt_token #=> String
resp.physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
resp.physical_endpoints[0].glue_connection.compatible_compute_environments #=> Array
resp.physical_endpoints[0].glue_connection.compatible_compute_environments[0] #=> String, one of "SPARK", "ATHENA", "PYTHON"
resp.physical_endpoints[0].enable_trusted_identity_propagation #=> Boolean
resp.physical_endpoints[0].host #=> String
resp.physical_endpoints[0].port #=> Integer
resp.physical_endpoints[0].protocol #=> String, one of "ATHENA", "GLUE_INTERACTIVE_SESSION", "HTTPS", "JDBC", "LIVY", "ODBC", "PRISM"
resp.physical_endpoints[0].stage #=> String
resp.project_id #=> String
resp.props.athena_properties.workgroup_name #=> String
resp.props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.glue_properties.error_message #=> String
resp.props.hyper_pod_properties.cluster_name #=> String
resp.props.hyper_pod_properties.cluster_arn #=> String
resp.props.hyper_pod_properties.orchestrator #=> String, one of "EKS", "SLURM"
resp.props.iam_properties.environment_id #=> String
resp.props.iam_properties.glue_lineage_sync_enabled #=> Boolean
resp.props.redshift_properties.storage.cluster_name #=> String
resp.props.redshift_properties.storage.workgroup_name #=> String
resp.props.redshift_properties.credentials.secret_arn #=> String
resp.props.redshift_properties.credentials.username_password.password #=> String
resp.props.redshift_properties.credentials.username_password.username #=> String
resp.props.redshift_properties.is_provisioned_secret #=> Boolean
resp.props.redshift_properties.jdbc_iam_url #=> String
resp.props.redshift_properties.jdbc_url #=> String
resp.props.redshift_properties.redshift_temp_dir #=> String
resp.props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.props.redshift_properties.lineage_sync.enabled #=> Boolean
resp.props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.redshift_properties.database_name #=> String
resp.props.spark_emr_properties.compute_arn #=> String
resp.props.spark_emr_properties.credentials.password #=> String
resp.props.spark_emr_properties.credentials.username #=> String
resp.props.spark_emr_properties.credentials_expiration #=> Time
resp.props.spark_emr_properties.governance_type #=> String, one of "AWS_MANAGED", "USER_MANAGED"
resp.props.spark_emr_properties.instance_profile_arn #=> String
resp.props.spark_emr_properties.java_virtual_env #=> String
resp.props.spark_emr_properties.livy_endpoint #=> String
resp.props.spark_emr_properties.log_uri #=> String
resp.props.spark_emr_properties.python_virtual_env #=> String
resp.props.spark_emr_properties.runtime_role #=> String
resp.props.spark_emr_properties.trusted_certificates_s3_uri #=> String
resp.props.spark_emr_properties.certificate_data #=> String
resp.props.spark_emr_properties.managed_endpoint_arn #=> String
resp.props.spark_emr_properties.managed_endpoint_credentials.id #=> String
resp.props.spark_emr_properties.managed_endpoint_credentials.token #=> String
resp.props.spark_glue_properties.additional_args.connection #=> String
resp.props.spark_glue_properties.glue_connection_name #=> String
resp.props.spark_glue_properties.glue_version #=> String
resp.props.spark_glue_properties.idle_timeout #=> Integer
resp.props.spark_glue_properties.java_virtual_env #=> String
resp.props.spark_glue_properties.number_of_workers #=> Integer
resp.props.spark_glue_properties.python_virtual_env #=> String
resp.props.spark_glue_properties.worker_type #=> String
resp.props.s3_properties.s3_uri #=> String
resp.props.s3_properties.s3_access_grant_location_id #=> String
resp.props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.s3_properties.error_message #=> String
resp.props.amazon_q_properties.is_enabled #=> Boolean
resp.props.amazon_q_properties.profile_arn #=> String
resp.props.amazon_q_properties.auth_mode #=> String
resp.props.mlflow_properties.tracking_server_arn #=> String
resp.type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.scope #=> String, one of "DOMAIN", "PROJECT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where we get the connection.

  • :identifier (required, String) —

    The connection ID.

  • :with_secret (Boolean) —

    Specifies whether a connection has a secret.

Returns:

See Also:



6106
6107
6108
6109
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6106

def get_connection(params = {}, options = {})
  req = build_request(:get_connection, params)
  req.send_request(options)
end

#get_data_export_configuration(params = {}) ⇒ Types::GetDataExportConfigurationOutput

Gets data export configuration details.

Examples:

Request syntax with placeholder values


resp = client.get_data_export_configuration({
  domain_identifier: "DomainId", # required
})

Response structure


resp.is_export_enabled #=> Boolean
resp.status #=> String, one of "COMPLETED", "FAILED"
resp.encryption_configuration.kms_key_arn #=> String
resp.encryption_configuration.sse_algorithm #=> String
resp.s3_table_bucket_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to get the data export configuration details.

Returns:

See Also:



6146
6147
6148
6149
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6146

def get_data_export_configuration(params = {}, options = {})
  req = build_request(:get_data_export_configuration, params)
  req.send_request(options)
end

#get_data_product(params = {}) ⇒ Types::GetDataProductOutput

Gets the data product.

Prerequisites:

  • The data product ID must exist.

  • The domain must be valid and accessible.

  • User must have read or discovery permissions for the data product.

Examples:

Request syntax with placeholder values


resp = client.get_data_product({
  domain_identifier: "DomainId", # required
  identifier: "DataProductId", # required
  revision: "Revision",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.revision #=> String
resp.owning_project_id #=> String
resp.name #=> String
resp.status #=> String, one of "CREATED", "CREATING", "CREATE_FAILED"
resp.description #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.items #=> Array
resp.items[0].item_type #=> String, one of "ASSET"
resp.items[0].identifier #=> String
resp.items[0].revision #=> String
resp.items[0].glossary_terms #=> Array
resp.items[0].glossary_terms[0] #=> String
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.first_revision_created_at #=> Time
resp.first_revision_created_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the data product lives.

  • :identifier (required, String) —

    The ID of the data product.

  • :revision (String) —

    The revision of the data product.

Returns:

See Also:



6226
6227
6228
6229
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6226

def get_data_product(params = {}, options = {})
  req = build_request(:get_data_product, params)
  req.send_request(options)
end

#get_data_source(params = {}) ⇒ Types::GetDataSourceOutput

Gets an Amazon DataZone data source.

Examples:

Request syntax with placeholder values


resp = client.get_data_source({
  domain_identifier: "DomainId", # required
  identifier: "DataSourceId", # required
})

Response structure


resp.id #=> String
resp.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.name #=> String
resp.description #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.connection_id #=> String
resp.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.region #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.region #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.redshift_run_configuration.redshift_credential_configuration.secret_manager_arn #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_cluster_source.cluster_name #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_serverless_source.workgroup_name #=> String
resp.configuration.sage_maker_run_configuration. #=> String
resp.configuration.sage_maker_run_configuration.region #=> String
resp.configuration.sage_maker_run_configuration.tracking_assets #=> Hash
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"] #=> Array
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"][0] #=> String
resp.recommendation.enable_business_name_generation #=> Boolean
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.publish_on_import #=> Boolean
resp.asset_forms_output #=> Array
resp.asset_forms_output[0].form_name #=> String
resp.asset_forms_output[0].type_name #=> String
resp.asset_forms_output[0].type_revision #=> String
resp.asset_forms_output[0].content #=> String
resp.schedule.timezone #=> String, one of "UTC", "AFRICA_JOHANNESBURG", "AMERICA_MONTREAL", "AMERICA_SAO_PAULO", "ASIA_BAHRAIN", "ASIA_BANGKOK", "ASIA_CALCUTTA", "ASIA_DUBAI", "ASIA_HONG_KONG", "ASIA_JAKARTA", "ASIA_KUALA_LUMPUR", "ASIA_SEOUL", "ASIA_SHANGHAI", "ASIA_SINGAPORE", "ASIA_TAIPEI", "ASIA_TOKYO", "AUSTRALIA_MELBOURNE", "AUSTRALIA_SYDNEY", "CANADA_CENTRAL", "CET", "CST6CDT", "ETC_GMT", "ETC_GMT0", "ETC_GMT_ADD_0", "ETC_GMT_ADD_1", "ETC_GMT_ADD_10", "ETC_GMT_ADD_11", "ETC_GMT_ADD_12", "ETC_GMT_ADD_2", "ETC_GMT_ADD_3", "ETC_GMT_ADD_4", "ETC_GMT_ADD_5", "ETC_GMT_ADD_6", "ETC_GMT_ADD_7", "ETC_GMT_ADD_8", "ETC_GMT_ADD_9", "ETC_GMT_NEG_0", "ETC_GMT_NEG_1", "ETC_GMT_NEG_10", "ETC_GMT_NEG_11", "ETC_GMT_NEG_12", "ETC_GMT_NEG_13", "ETC_GMT_NEG_14", "ETC_GMT_NEG_2", "ETC_GMT_NEG_3", "ETC_GMT_NEG_4", "ETC_GMT_NEG_5", "ETC_GMT_NEG_6", "ETC_GMT_NEG_7", "ETC_GMT_NEG_8", "ETC_GMT_NEG_9", "EUROPE_DUBLIN", "EUROPE_LONDON", "EUROPE_PARIS", "EUROPE_STOCKHOLM", "EUROPE_ZURICH", "ISRAEL", "MEXICO_GENERAL", "MST7MDT", "PACIFIC_AUCKLAND", "US_CENTRAL", "US_EASTERN", "US_MOUNTAIN", "US_PACIFIC"
resp.schedule.schedule #=> String
resp.last_run_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.last_run_at #=> Time
resp.last_run_error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.last_run_error_message.error_detail #=> String
resp.last_run_asset_count #=> Integer
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.error_message.error_detail #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.self_grant_status.glue_self_grant_status.self_grant_status_details #=> Array
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].database_name #=> String
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].schema_name #=> String
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "GRANT_FAILED", "REVOKE_FAILED"
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].failure_cause #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details #=> Array
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].database_name #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].schema_name #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "GRANT_FAILED", "REVOKE_FAILED"
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].failure_cause #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the data source exists.

  • :identifier (required, String) —

    The ID of the Amazon DataZone data source.

Returns:

See Also:



6345
6346
6347
6348
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6345

def get_data_source(params = {}, options = {})
  req = build_request(:get_data_source, params)
  req.send_request(options)
end

#get_data_source_run(params = {}) ⇒ Types::GetDataSourceRunOutput

Gets an Amazon DataZone data source run.

Examples:

Request syntax with placeholder values


resp = client.get_data_source_run({
  domain_identifier: "DomainId", # required
  identifier: "DataSourceRunId", # required
})

Response structure


resp.domain_id #=> String
resp.data_source_id #=> String
resp.id #=> String
resp.project_id #=> String
resp.status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.data_source_configuration_snapshot #=> String
resp.run_statistics_for_assets.added #=> Integer
resp.run_statistics_for_assets.updated #=> Integer
resp.run_statistics_for_assets.unchanged #=> Integer
resp.run_statistics_for_assets.skipped #=> Integer
resp.run_statistics_for_assets.failed #=> Integer
resp.lineage_summary.import_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "PARTIALLY_SUCCEEDED"
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.error_message.error_detail #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.started_at #=> Time
resp.stopped_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which this data source run was performed.

  • :identifier (required, String) —

    The ID of the data source run.

Returns:

See Also:



6408
6409
6410
6411
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6408

def get_data_source_run(params = {}, options = {})
  req = build_request(:get_data_source_run, params)
  req.send_request(options)
end

#get_domain(params = {}) ⇒ Types::GetDomainOutput

Gets an Amazon DataZone domain.

Examples:

Request syntax with placeholder values


resp = client.get_domain({
  identifier: "DomainId", # required
})

Response structure


resp.id #=> String
resp.root_domain_unit_id #=> String
resp.name #=> String
resp.description #=> String
resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED"
resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL"
resp.single_sign_on.idc_instance_arn #=> String
resp.domain_execution_role #=> String
resp.arn #=> String
resp.kms_key_identifier #=> String
resp.status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED"
resp.portal_url #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.domain_version #=> String, one of "V1", "V2"
resp.service_role #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the specified Amazon DataZone domain.

Returns:

See Also:



6467
6468
6469
6470
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6467

def get_domain(params = {}, options = {})
  req = build_request(:get_domain, params)
  req.send_request(options)
end

#get_domain_unit(params = {}) ⇒ Types::GetDomainUnitOutput

Gets the details of the specified domain unit.

Examples:

Request syntax with placeholder values


resp = client.get_domain_unit({
  domain_identifier: "DomainId", # required
  identifier: "DomainUnitId", # required
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.name #=> String
resp.parent_domain_unit_id #=> String
resp.description #=> String
resp.owners #=> Array
resp.owners[0].user.user_id #=> String
resp.owners[0].group.group_id #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.created_by #=> String
resp.last_updated_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to get a domain unit.

  • :identifier (required, String) —

    The identifier of the domain unit that you want to get.

Returns:

See Also:



6519
6520
6521
6522
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6519

def get_domain_unit(params = {}, options = {})
  req = build_request(:get_domain_unit, params)
  req.send_request(options)
end

#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput

Gets an Amazon DataZone environment.

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentId", # required
})

Response structure


resp.project_id #=> String
resp.id #=> String
resp.domain_id #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.name #=> String
resp.description #=> String
resp.environment_profile_id #=> String
resp. #=> String
resp. #=> String
resp.provider #=> String
resp.provisioned_resources #=> Array
resp.provisioned_resources[0].provider #=> String
resp.provisioned_resources[0].name #=> String
resp.provisioned_resources[0].value #=> String
resp.provisioned_resources[0].type #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "VALIDATION_FAILED", "SUSPENDED", "DISABLED", "EXPIRED", "DELETED", "INACCESSIBLE"
resp.environment_actions #=> Array
resp.environment_actions[0].type #=> String
resp.environment_actions[0].auth #=> String, one of "IAM", "HTTPS"
resp.environment_actions[0].parameters #=> Array
resp.environment_actions[0].parameters[0].key #=> String
resp.environment_actions[0].parameters[0].value #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean
resp.last_deployment.deployment_id #=> String
resp.last_deployment.deployment_type #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.last_deployment.deployment_status #=> String, one of "IN_PROGRESS", "SUCCESSFUL", "FAILED", "PENDING_DEPLOYMENT"
resp.last_deployment.failure_reason.code #=> String
resp.last_deployment.failure_reason.message #=> String
resp.last_deployment.messages #=> Array
resp.last_deployment.messages[0] #=> String
resp.last_deployment.is_deployment_complete #=> Boolean
resp.provisioning_properties.cloud_formation.template_url #=> String
resp.deployment_properties.start_timeout_minutes #=> Integer
resp.deployment_properties.end_timeout_minutes #=> Integer
resp.environment_blueprint_id #=> String
resp.environment_configuration_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where the environment exists.

  • :identifier (required, String) —

    The ID of the Amazon DataZone environment.

Returns:

See Also:



6618
6619
6620
6621
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6618

def get_environment(params = {}, options = {})
  req = build_request(:get_environment, params)
  req.send_request(options)
end

#get_environment_action(params = {}) ⇒ Types::GetEnvironmentActionOutput

Gets the specified environment action.

Examples:

Request syntax with placeholder values


resp = client.get_environment_action({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "String", # required
})

Response structure


resp.domain_id #=> String
resp.environment_id #=> String
resp.id #=> String
resp.name #=> String
resp.parameters.aws_console_link.uri #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is invoked.

  • :environment_identifier (required, String) —

    The environment ID of the environment action.

  • :identifier (required, String) —

    The ID of the environment action

Returns:

See Also:



6665
6666
6667
6668
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6665

def get_environment_action(params = {}, options = {})
  req = build_request(:get_environment_action, params)
  req.send_request(options)
end

#get_environment_blueprint(params = {}) ⇒ Types::GetEnvironmentBlueprintOutput

Gets an Amazon DataZone blueprint.

Examples:

Request syntax with placeholder values


resp = client.get_environment_blueprint({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentBlueprintId", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.provider #=> String
resp.provisioning_properties.cloud_formation.template_url #=> String
resp.deployment_properties.start_timeout_minutes #=> Integer
resp.deployment_properties.end_timeout_minutes #=> Integer
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain in which this blueprint exists.

  • :identifier (required, String) —

    The ID of this Amazon DataZone blueprint.

Returns:

See Also:



6724
6725
6726
6727
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6724

def get_environment_blueprint(params = {}, options = {})
  req = build_request(:get_environment_blueprint, params)
  req.send_request(options)
end

#get_environment_blueprint_configuration(params = {}) ⇒ Types::GetEnvironmentBlueprintConfigurationOutput

Gets the blueprint configuration in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_environment_blueprint_configuration({
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
})

Response structure


resp.domain_id #=> String
resp.environment_blueprint_id #=> String
resp.provisioning_role_arn #=> String
resp.environment_role_permission_boundary #=> String
resp.manage_access_role_arn #=> String
resp.enabled_regions #=> Array
resp.enabled_regions[0] #=> String
resp.regional_parameters #=> Hash
resp.regional_parameters["RegionName"] #=> Hash
resp.regional_parameters["RegionName"]["String"] #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.provisioning_configurations #=> Array
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_role #=> String
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_exclude_s3_locations #=> Array
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_exclude_s3_locations[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :environment_blueprint_identifier (required, String) —

    He ID of the blueprint.

Returns:

See Also:



6780
6781
6782
6783
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6780

def get_environment_blueprint_configuration(params = {}, options = {})
  req = build_request(:get_environment_blueprint_configuration, params)
  req.send_request(options)
end

#get_environment_credentials(params = {}) ⇒ Types::GetEnvironmentCredentialsOutput

Gets the credentials of an environment in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_environment_credentials({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
})

Response structure


resp.access_key_id #=> String
resp.secret_access_key #=> String
resp.session_token #=> String
resp.expiration #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this environment and its credentials exist.

  • :environment_identifier (required, String) —

    The ID of the environment whose credentials this operation gets.

Returns:

See Also:



6819
6820
6821
6822
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6819

def get_environment_credentials(params = {}, options = {})
  req = build_request(:get_environment_credentials, params)
  req.send_request(options)
end

#get_environment_profile(params = {}) ⇒ Types::GetEnvironmentProfileOutput

Gets an evinronment profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_environment_profile({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentProfileId", # required
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp. #=> String
resp. #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.name #=> String
resp.description #=> String
resp.environment_blueprint_id #=> String
resp.project_id #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this environment profile exists.

  • :identifier (required, String) —

    The ID of the environment profile.

Returns:

See Also:



6881
6882
6883
6884
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6881

def get_environment_profile(params = {}, options = {})
  req = build_request(:get_environment_profile, params)
  req.send_request(options)
end

#get_form_type(params = {}) ⇒ Types::GetFormTypeOutput

Gets a metadata form type in Amazon DataZone.

Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable.

  • The form type with the specified identifier must exist in the given domain.

  • The domain must be valid and active.

  • User must have permission on the form type.

  • The form type should not be deleted or in an invalid state.

One use case for this API is to determine whether a form field is indexed for search.

A searchable field will be annotated with @amazon.datazone#searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. If a field is indexed technical identifier search, it will be annotated with @amazon.datazone#searchable(modes:["TECHNICAL"]). If a field is indexed for lexical search (supports stemmed and prefix matches but not semantic matches), it will be annotated with @amazon.datazone#searchable(modes:["LEXICAL"]).

A field storing glossary term IDs (which is filterable) will be annotated with @amazon.datazone#glossaryterm("${glossaryId}").

Examples:

Request syntax with placeholder values


resp = client.get_form_type({
  domain_identifier: "DomainId", # required
  form_type_identifier: "FormTypeIdentifier", # required
  revision: "Revision",
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.revision #=> String
resp.model.smithy #=> String
resp.owning_project_id #=> String
resp.origin_domain_id #=> String
resp.origin_project_id #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.imports #=> Array
resp.imports[0].name #=> String
resp.imports[0].revision #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this metadata form type exists.

  • :form_type_identifier (required, String) —

    The ID of the metadata form type.

  • :revision (String) —

    The revision of this metadata form type.

Returns:

See Also:



6975
6976
6977
6978
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6975

def get_form_type(params = {}, options = {})
  req = build_request(:get_form_type, params)
  req.send_request(options)
end

#get_glossary(params = {}) ⇒ Types::GetGlossaryOutput

Gets a business glossary in Amazon DataZone.

Prerequisites:

  • The specified glossary ID must exist and be associated with the given domain.

  • The caller must have the datazone:GetGlossary permission on the domain.

Examples:

Request syntax with placeholder values


resp = client.get_glossary({
  domain_identifier: "DomainId", # required
  identifier: "GlossaryId", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.owning_project_id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "DISABLED", "ENABLED"
resp.created_at #=> Time
resp.created_by #=> String
resp.updated_at #=> Time
resp.updated_by #=> String
resp.usage_restrictions #=> Array
resp.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this business glossary exists.

  • :identifier (required, String) —

    The ID of the business glossary.

Returns:

See Also:



7037
7038
7039
7040
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7037

def get_glossary(params = {}, options = {})
  req = build_request(:get_glossary, params)
  req.send_request(options)
end

#get_glossary_term(params = {}) ⇒ Types::GetGlossaryTermOutput

Gets a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term with identifier must exist in the domain.

  • User must have permission on the glossary term.

  • Domain must be accessible and active.

Examples:

Request syntax with placeholder values


resp = client.get_glossary_term({
  domain_identifier: "DomainId", # required
  identifier: "GlossaryTermId", # required
})

Response structure


resp.domain_id #=> String
resp.glossary_id #=> String
resp.id #=> String
resp.name #=> String
resp.short_description #=> String
resp.long_description #=> String
resp.term_relations.is_a #=> Array
resp.term_relations.is_a[0] #=> String
resp.term_relations.classifies #=> Array
resp.term_relations.classifies[0] #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.created_at #=> Time
resp.created_by #=> String
resp.updated_at #=> Time
resp.updated_by #=> String
resp.usage_restrictions #=> Array
resp.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which this business glossary term exists.

  • :identifier (required, String) —

    The ID of the business glossary term.

Returns:

See Also:



7106
7107
7108
7109
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7106

def get_glossary_term(params = {}, options = {})
  req = build_request(:get_glossary_term, params)
  req.send_request(options)
end

#get_group_profile(params = {}) ⇒ Types::GetGroupProfileOutput

Gets a group profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_group_profile({
  domain_identifier: "DomainId", # required
  group_identifier: "GroupIdentifier", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"
resp.group_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which the group profile exists.

  • :group_identifier (required, String) —

    The identifier of the group profile.

Returns:

See Also:



7145
7146
7147
7148
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7145

def get_group_profile(params = {}, options = {})
  req = build_request(:get_group_profile, params)
  req.send_request(options)
end

#get_iam_portal_login_url(params = {}) ⇒ Types::GetIamPortalLoginUrlOutput

Gets the data portal URL for the specified Amazon DataZone domain.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
})

Response structure


resp.auth_code_url #=> String
resp. #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    the ID of the Amazon DataZone domain the data portal of which you want to get.

Returns:

See Also:



7176
7177
7178
7179
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7176

def (params = {}, options = {})
  req = build_request(:get_iam_portal_login_url, params)
  req.send_request(options)
end

#get_job_run(params = {}) ⇒ Types::GetJobRunOutput

The details of the job run.

Examples:

Request syntax with placeholder values


resp = client.get_job_run({
  domain_identifier: "DomainId", # required
  identifier: "RunIdentifier", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.job_id #=> String
resp.job_type #=> String, one of "LINEAGE"
resp.run_mode #=> String, one of "SCHEDULED", "ON_DEMAND"
resp.details.lineage_run_details.sql_query_run_details.query_start_time #=> Time
resp.details.lineage_run_details.sql_query_run_details.query_end_time #=> Time
resp.details.lineage_run_details.sql_query_run_details.total_queries_processed #=> Integer
resp.details.lineage_run_details.sql_query_run_details.num_queries_failed #=> Integer
resp.details.lineage_run_details.sql_query_run_details.error_messages #=> Array
resp.details.lineage_run_details.sql_query_run_details.error_messages[0] #=> String
resp.status #=> String, one of "SCHEDULED", "IN_PROGRESS", "SUCCESS", "PARTIALLY_SUCCEEDED", "FAILED", "ABORTED", "TIMED_OUT", "CANCELED"
resp.error.message #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.start_time #=> Time
resp.end_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain.

  • :identifier (required, String) —

    The ID of the job run.

Returns:

See Also:



7235
7236
7237
7238
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7235

def get_job_run(params = {}, options = {})
  req = build_request(:get_job_run, params)
  req.send_request(options)
end

#get_lineage_event(params = {}) ⇒ Types::GetLineageEventOutput

Describes the lineage event.

Examples:

Request syntax with placeholder values


resp = client.get_lineage_event({
  domain_identifier: "DomainId", # required
  identifier: "LineageEventIdentifier", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.event #=> String
resp.created_by #=> String
resp.processing_status #=> String, one of "REQUESTED", "PROCESSING", "SUCCESS", "FAILED"
resp.event_time #=> Time
resp.created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain.

  • :identifier (required, String) —

    The ID of the lineage event.

Returns:

See Also:



7279
7280
7281
7282
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7279

def get_lineage_event(params = {}, options = {})
  req = build_request(:get_lineage_event, params)
  req.send_request(options)
end

#get_lineage_node(params = {}) ⇒ Types::GetLineageNodeOutput

Gets the data lineage node.

Examples:

Request syntax with placeholder values


resp = client.get_lineage_node({
  domain_identifier: "DomainId", # required
  identifier: "LineageNodeIdentifier", # required
  event_timestamp: Time.now,
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.description #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.updated_at #=> Time
resp.updated_by #=> String
resp.id #=> String
resp.type_name #=> String
resp.type_revision #=> String
resp.source_identifier #=> String
resp.event_timestamp #=> Time
resp.forms_output #=> Array
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.forms_output[0].content #=> String
resp.upstream_nodes #=> Array
resp.upstream_nodes[0].id #=> String
resp.upstream_nodes[0].event_timestamp #=> Time
resp.downstream_nodes #=> Array
resp.downstream_nodes[0].id #=> String
resp.downstream_nodes[0].event_timestamp #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which you want to get the data lineage node.

  • :identifier (required, String) —

    The ID of the data lineage node that you want to get.

    Both, a lineage node identifier generated by Amazon DataZone and a sourceIdentifier of the lineage node are supported. If sourceIdentifier is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details.

  • :event_timestamp (Time, DateTime, Date, Integer, String) —

    The event time stamp for which you want to get the data lineage node.

Returns:

See Also:



7357
7358
7359
7360
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7357

def get_lineage_node(params = {}, options = {})
  req = build_request(:get_lineage_node, params)
  req.send_request(options)
end

#get_listing(params = {}) ⇒ Types::GetListingOutput

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

Examples:

Request syntax with placeholder values


resp = client.get_listing({
  domain_identifier: "DomainId", # required
  identifier: "ListingId", # required
  listing_revision: "Revision",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.listing_revision #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.created_by #=> String
resp.updated_by #=> String
resp.item.asset_listing.asset_id #=> String
resp.item.asset_listing.asset_revision #=> String
resp.item.asset_listing.asset_type #=> String
resp.item.asset_listing.created_at #=> Time
resp.item.asset_listing.forms #=> String
resp.item.asset_listing.latest_time_series_data_point_forms #=> Array
resp.item.asset_listing.latest_time_series_data_point_forms[0].form_name #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].type_identifier #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].type_revision #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].timestamp #=> Time
resp.item.asset_listing.latest_time_series_data_point_forms[0].content_summary #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].id #=> String
resp.item.asset_listing.glossary_terms #=> Array
resp.item.asset_listing.glossary_terms[0].name #=> String
resp.item.asset_listing.glossary_terms[0].short_description #=> String
resp.item.asset_listing.governed_glossary_terms #=> Array
resp.item.asset_listing.governed_glossary_terms[0].name #=> String
resp.item.asset_listing.governed_glossary_terms[0].short_description #=> String
resp.item.asset_listing.owning_project_id #=> String
resp.item.data_product_listing.data_product_id #=> String
resp.item.data_product_listing.data_product_revision #=> String
resp.item.data_product_listing.created_at #=> Time
resp.item.data_product_listing.forms #=> String
resp.item.data_product_listing.glossary_terms #=> Array
resp.item.data_product_listing.glossary_terms[0].name #=> String
resp.item.data_product_listing.glossary_terms[0].short_description #=> String
resp.item.data_product_listing.owning_project_id #=> String
resp.item.data_product_listing.items #=> Array
resp.item.data_product_listing.items[0].listing_id #=> String
resp.item.data_product_listing.items[0].listing_revision #=> String
resp.item.data_product_listing.items[0].glossary_terms #=> Array
resp.item.data_product_listing.items[0].glossary_terms[0].name #=> String
resp.item.data_product_listing.items[0].glossary_terms[0].short_description #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain.

  • :identifier (required, String) —

    The ID of the listing.

  • :listing_revision (String) —

    The revision of the listing.

Returns:

See Also:



7447
7448
7449
7450
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7447

def get_listing(params = {}, options = {})
  req = build_request(:get_listing, params)
  req.send_request(options)
end

#get_metadata_generation_run(params = {}) ⇒ Types::GetMetadataGenerationRunOutput

Gets a metadata generation run in Amazon DataZone.

Prerequisites:

  • Valid domain and run identifier.

  • The metadata generation run must exist.

  • User must have read access to the metadata run.

Examples:

Request syntax with placeholder values


resp = client.get_metadata_generation_run({
  domain_identifier: "DomainId", # required
  identifier: "MetadataGenerationRunIdentifier", # required
  type: "BUSINESS_DESCRIPTIONS", # accepts BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.target.type #=> String, one of "ASSET"
resp.target.identifier #=> String
resp.target.revision #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED", "PARTIALLY_SUCCEEDED"
resp.type #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.types #=> Array
resp.types[0] #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.created_at #=> Time
resp.created_by #=> String
resp.owning_project_id #=> String
resp.type_stats #=> Array
resp.type_stats[0].type #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.type_stats[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED", "PARTIALLY_SUCCEEDED"
resp.type_stats[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

  • :identifier (required, String) —

    The identifier of the metadata generation run.

  • :type (String) —

    The type of the metadata generation run.

Returns:

See Also:



7516
7517
7518
7519
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7516

def get_metadata_generation_run(params = {}, options = {})
  req = build_request(:get_metadata_generation_run, params)
  req.send_request(options)
end

#get_project(params = {}) ⇒ Types::GetProjectOutput

Gets a project in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_project({
  domain_identifier: "DomainId", # required
  identifier: "ProjectId", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.failure_reasons #=> Array
resp.failure_reasons[0].code #=> String
resp.failure_reasons[0].message #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.resource_tags #=> Array
resp.resource_tags[0].key #=> String
resp.resource_tags[0].value #=> String
resp.resource_tags[0].source #=> String, one of "PROJECT", "PROJECT_PROFILE"
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.domain_unit_id #=> String
resp.project_profile_id #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].environment_id #=> String
resp.user_parameters[0].. #=> String
resp.user_parameters[0]..region_name #=> String
resp.user_parameters[0].. #=> String
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_parameters #=> Array
resp.user_parameters[0].environment_parameters[0].name #=> String
resp.user_parameters[0].environment_parameters[0].value #=> String
resp.environment_deployment_details.overall_deployment_status #=> String, one of "PENDING_DEPLOYMENT", "IN_PROGRESS", "SUCCESSFUL", "FAILED_VALIDATION", "FAILED_DEPLOYMENT"
resp.environment_deployment_details.environment_failure_reasons #=> Hash
resp.environment_deployment_details.environment_failure_reasons["String"] #=> Array
resp.environment_deployment_details.environment_failure_reasons["String"][0].code #=> String
resp.environment_deployment_details.environment_failure_reasons["String"][0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the project exists.

  • :identifier (required, String) —

    The ID of the project.

Returns:

See Also:



7594
7595
7596
7597
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7594

def get_project(params = {}, options = {})
  req = build_request(:get_project, params)
  req.send_request(options)
end

#get_project_profile(params = {}) ⇒ Types::GetProjectProfileOutput

The details of the project profile.

Examples:

Request syntax with placeholder values


resp = client.get_project_profile({
  domain_identifier: "DomainId", # required
  identifier: "ProjectProfileId", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.project_resource_tags #=> Array
resp.project_resource_tags[0].key #=> String
resp.project_resource_tags[0].value #=> String
resp.project_resource_tags[0].is_value_editable #=> Boolean
resp.allow_custom_project_resource_tags #=> Boolean
resp.project_resource_tags_description #=> String
resp.environment_configurations #=> Array
resp.environment_configurations[0].name #=> String
resp.environment_configurations[0].id #=> String
resp.environment_configurations[0].environment_blueprint_id #=> String
resp.environment_configurations[0].description #=> String
resp.environment_configurations[0].deployment_mode #=> String, one of "ON_CREATE", "ON_DEMAND"
resp.environment_configurations[0].configuration_parameters.ssm_path #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides #=> Array
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].name #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].value #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].is_editable #=> Boolean
resp.environment_configurations[0].configuration_parameters.resolved_parameters #=> Array
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].name #=> String
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].value #=> String
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].is_editable #=> Boolean
resp.environment_configurations[0].. #=> String
resp.environment_configurations[0].. #=> String
resp.environment_configurations[0]. #=> Array
resp.environment_configurations[0].[0] #=> String
resp.environment_configurations[0].aws_region.region_name #=> String
resp.environment_configurations[0].aws_region.region_name_path #=> String
resp.environment_configurations[0].deployment_order #=> Integer
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.domain_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain.

  • :identifier (required, String) —

    The ID of the project profile.

Returns:

See Also:



7674
7675
7676
7677
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7674

def get_project_profile(params = {}, options = {})
  req = build_request(:get_project_profile, params)
  req.send_request(options)
end

#get_rule(params = {}) ⇒ Types::GetRuleOutput

Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Examples:

Request syntax with placeholder values


resp = client.get_rule({
  domain_identifier: "DomainId", # required
  identifier: "RuleId", # required
  revision: "Revision",
})

Response structure


resp.identifier #=> String
resp.revision #=> String
resp.name #=> String
resp.rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT", "GLOSSARY_TERM_ENFORCEMENT"
resp.target.domain_unit_target.domain_unit_id #=> String
resp.target.domain_unit_target.include_child_domain_units #=> Boolean
resp.action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.scope.asset_type.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.scope.asset_type.specific_asset_types #=> Array
resp.scope.asset_type.specific_asset_types[0] #=> String
resp.scope.data_product #=> Boolean
resp.scope.project.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.scope.project.specific_projects #=> Array
resp.scope.project.specific_projects[0] #=> String
resp.detail.metadata_form_enforcement_detail.required_metadata_forms #=> Array
resp.detail.metadata_form_enforcement_detail.required_metadata_forms[0].type_identifier #=> String
resp.detail.metadata_form_enforcement_detail.required_metadata_forms[0].type_revision #=> String
resp.detail.glossary_term_enforcement_detail.required_glossary_term_ids #=> Array
resp.detail.glossary_term_enforcement_detail.required_glossary_term_ids[0] #=> String
resp.target_type #=> String, one of "DOMAIN_UNIT"
resp.description #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.created_by #=> String
resp.last_updated_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the GetRule action is to be invoked.

  • :identifier (required, String) —

    The ID of the rule.

  • :revision (String) —

    The revision of the rule.

Returns:

See Also:



7755
7756
7757
7758
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7755

def get_rule(params = {}, options = {})
  req = build_request(:get_rule, params)
  req.send_request(options)
end

#get_subscription(params = {}) ⇒ Types::GetSubscriptionOutput

Gets a subscription in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_subscription({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionId", # required
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.subscribed_principal.project.id #=> String
resp.subscribed_principal.project.name #=> String
resp.subscribed_principal.user.id #=> String
resp.subscribed_principal.user.details.iam.arn #=> String
resp.subscribed_principal.user.details.iam.principal_id #=> String
resp.subscribed_principal.user.details.sso.username #=> String
resp.subscribed_principal.user.details.sso.first_name #=> String
resp.subscribed_principal.user.details.sso.last_name #=> String
resp.subscribed_principal.group.id #=> String
resp.subscribed_principal.group.name #=> String
resp.subscribed_principal.iam.principal_arn #=> String
resp.subscribed_listing.id #=> String
resp.subscribed_listing.revision #=> String
resp.subscribed_listing.name #=> String
resp.subscribed_listing.description #=> String
resp.subscribed_listing.item.asset_listing.entity_id #=> String
resp.subscribed_listing.item.asset_listing.entity_revision #=> String
resp.subscribed_listing.item.asset_listing.entity_type #=> String
resp.subscribed_listing.item.asset_listing.forms #=> String
resp.subscribed_listing.item.asset_listing.glossary_terms #=> Array
resp.subscribed_listing.item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listing.item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listing.item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.status #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listing.item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listing.item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listing.item.product_listing.entity_id #=> String
resp.subscribed_listing.item.product_listing.entity_revision #=> String
resp.subscribed_listing.item.product_listing.glossary_terms #=> Array
resp.subscribed_listing.item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listing.item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listing.item.product_listing.name #=> String
resp.subscribed_listing.item.product_listing.description #=> String
resp.subscribed_listing.item.product_listing.asset_listings #=> Array
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listing.owner_project_id #=> String
resp.subscribed_listing.owner_project_name #=> String
resp.subscription_request_id #=> String
resp.retain_permissions #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription exists.

  • :identifier (required, String) —

    The ID of the subscription.

Returns:

See Also:



7847
7848
7849
7850
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7847

def get_subscription(params = {}, options = {})
  req = build_request(:get_subscription, params)
  req.send_request(options)
end

#get_subscription_grant(params = {}) ⇒ Types::GetSubscriptionGrantOutput

Gets the subscription grant in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_subscription_grant({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionGrantId", # required
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.environment_id #=> String
resp.subscription_target_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "REVOKED", "GRANT_FAILED", "REVOKE_FAILED"
resp.assets[0].target_name #=> String
resp.assets[0].failure_cause.message #=> String
resp.assets[0].granted_timestamp #=> Time
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.filter_ids #=> Array
resp.assets[0].asset_scope.filter_ids[0] #=> String
resp.assets[0].asset_scope.status #=> String
resp.assets[0].asset_scope.error_message #=> String
resp.assets[0].permissions.s3 #=> Array
resp.assets[0].permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscription_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription grant exists.

  • :identifier (required, String) —

    The ID of the subscription grant.

Returns:

See Also:



7917
7918
7919
7920
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7917

def get_subscription_grant(params = {}, options = {})
  req = build_request(:get_subscription_grant, params)
  req.send_request(options)
end

#get_subscription_request_details(params = {}) ⇒ Types::GetSubscriptionRequestDetailsOutput

Gets the details of the specified subscription request.

Examples:

Request syntax with placeholder values


resp = client.get_subscription_request_details({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.request_reason #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.subscribed_principals[0].user.id #=> String
resp.subscribed_principals[0].user.details.iam.arn #=> String
resp.subscribed_principals[0].user.details.iam.principal_id #=> String
resp.subscribed_principals[0].user.details.sso.username #=> String
resp.subscribed_principals[0].user.details.sso.first_name #=> String
resp.subscribed_principals[0].user.details.sso.last_name #=> String
resp.subscribed_principals[0].group.id #=> String
resp.subscribed_principals[0].group.name #=> String
resp.subscribed_principals[0].iam.principal_arn #=> String
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_listings[0].name #=> String
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.subscribed_listings[0].item.asset_listing.forms #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.status #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listings[0].item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listings[0].item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listings[0].item.product_listing.entity_id #=> String
resp.subscribed_listings[0].item.product_listing.entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.product_listing.name #=> String
resp.subscribed_listings[0].item.product_listing.description #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings #=> Array
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.reviewer_id #=> String
resp.decision_comment #=> String
resp.existing_subscription_id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.metadata_forms[0].content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to get the subscription request details.

  • :identifier (required, String) —

    The identifier of the subscription request the details of which to get.

Returns:

See Also:



8023
8024
8025
8026
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8023

def get_subscription_request_details(params = {}, options = {})
  req = build_request(:get_subscription_request_details, params)
  req.send_request(options)
end

#get_subscription_target(params = {}) ⇒ Types::GetSubscriptionTargetOutput

Gets the subscription target in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.get_subscription_target({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "SubscriptionTargetId", # required
})

Response structure


resp.id #=> String
resp.authorized_principals #=> Array
resp.authorized_principals[0] #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.name #=> String
resp.type #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.manage_access_role #=> String
resp.applicable_asset_types #=> Array
resp.applicable_asset_types[0] #=> String
resp.subscription_target_config #=> Array
resp.subscription_target_config[0].form_name #=> String
resp.subscription_target_config[0].content #=> String
resp.provider #=> String
resp.subscription_grant_creation_mode #=> String, one of "AUTOMATIC", "MANUAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription target exists.

  • :environment_identifier (required, String) —

    The ID of the environment associated with the subscription target.

  • :identifier (required, String) —

    The ID of the subscription target.

Returns:

See Also:



8094
8095
8096
8097
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8094

def get_subscription_target(params = {}, options = {})
  req = build_request(:get_subscription_target, params)
  req.send_request(options)
end

#get_time_series_data_point(params = {}) ⇒ Types::GetTimeSeriesDataPointOutput

Gets the existing data point for the asset.

Examples:

Request syntax with placeholder values


resp = client.get_time_series_data_point({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  identifier: "TimeSeriesDataPointIdentifier", # required
  form_name: "TimeSeriesFormName", # required
})

Response structure


resp.domain_id #=> String
resp.entity_id #=> String
resp.entity_type #=> String, one of "ASSET", "LISTING"
resp.form_name #=> String
resp.form.form_name #=> String
resp.form.type_identifier #=> String
resp.form.type_revision #=> String
resp.form.timestamp #=> Time
resp.form.content #=> String
resp.form.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to get the data point.

  • :entity_type (required, String) —

    The type of the asset for which you want to get the data point.

  • :identifier (required, String) —

    The ID of the data point that you want to get.

  • :form_name (required, String) —

    The name of the time series form that houses the data point that you want to get.

Returns:

See Also:



8153
8154
8155
8156
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8153

def get_time_series_data_point(params = {}, options = {})
  req = build_request(:get_time_series_data_point, params)
  req.send_request(options)
end

#get_user_profile(params = {}) ⇒ Types::GetUserProfileOutput

Gets a user profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  user_identifier: "UserIdentifier", # required
  type: "IAM", # accepts IAM, SSO
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.type #=> String, one of "IAM", "SSO"
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED"
resp.details.iam.arn #=> String
resp.details.iam.principal_id #=> String
resp.details.sso.username #=> String
resp.details.sso.first_name #=> String
resp.details.sso.last_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    the ID of the Amazon DataZone domain the data portal of which you want to get.

  • :user_identifier (required, String) —

    The identifier of the user for which you want to get the user profile.

  • :type (String) —

    The type of the user profile.

Returns:

See Also:



8202
8203
8204
8205
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8202

def (params = {}, options = {})
  req = build_request(:get_user_profile, params)
  req.send_request(options)
end

#list_account_pools(params = {}) ⇒ Types::ListAccountPoolsOutput

Lists existing account pools.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  name: "AccountPoolName",
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].resolution_strategy #=> String, one of "MANUAL"
resp.items[0].domain_unit_id #=> String
resp.items[0].created_by #=> String
resp.items[0].updated_by #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where exsting account pools are to be listed.

  • :name (String) —

    The name of the account pool to be listed.

  • :sort_by (String) —

    The sort by mechanism in which the existing account pools are to be listed.

  • :sort_order (String) —

    The sort order in which the existing account pools are to be listed.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



8271
8272
8273
8274
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8271

def (params = {}, options = {})
  req = build_request(:list_account_pools, params)
  req.send_request(options)
end

#list_accounts_in_account_pool(params = {}) ⇒ Types::ListAccountsInAccountPoolOutput

Lists the accounts in the specified account pool.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  identifier: "AccountPoolId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.items[0].supported_regions #=> Array
resp.items[0].supported_regions[0] #=> String
resp.items[0]. #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which the accounts in the specified account pool are to be listed.

  • :identifier (required, String) —

    The ID of the account pool whose accounts are to be listed.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



8329
8330
8331
8332
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8329

def (params = {}, options = {})
  req = build_request(:list_accounts_in_account_pool, params)
  req.send_request(options)
end

#list_asset_filters(params = {}) ⇒ Types::ListAssetFiltersOutput

Lists asset filters.

Prerequisites:

  • A valid domain and asset must exist.

  • The asset must have at least one filter created to return results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_filters({
  domain_identifier: "DomainId", # required
  asset_identifier: "AssetId", # required
  status: "VALID", # accepts VALID, INVALID
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].domain_id #=> String
resp.items[0].asset_id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].status #=> String, one of "VALID", "INVALID"
resp.items[0].effective_column_names #=> Array
resp.items[0].effective_column_names[0] #=> String
resp.items[0].effective_row_filter #=> String
resp.items[0].created_at #=> Time
resp.items[0].error_message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :status (String) —

    The status of the asset filter.

  • :next_token (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.

  • :max_results (Integer) —

    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.

Returns:

See Also:



8403
8404
8405
8406
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8403

def list_asset_filters(params = {}, options = {})
  req = build_request(:list_asset_filters, params)
  req.send_request(options)
end

#list_asset_revisions(params = {}) ⇒ Types::ListAssetRevisionsOutput

Lists the revisions for the asset.

Prerequisites:

  • The asset must exist in the domain.

  • There must be at least one revision of the asset (which happens automatically after creation).

  • The domain must be valid and active.

  • User must have permissions on the asset and domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_revisions({
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].revision #=> String
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain.

  • :identifier (required, String) —

    The identifier of the asset.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



8472
8473
8474
8475
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8472

def list_asset_revisions(params = {}, options = {})
  req = build_request(:list_asset_revisions, params)
  req.send_request(options)
end

#list_connections(params = {}) ⇒ Types::ListConnectionsOutput

Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_connections({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  name: "ConnectionName",
  environment_identifier: "EnvironmentId",
  project_identifier: "ProjectId",
  type: "ATHENA", # accepts ATHENA, BIGQUERY, DATABRICKS, DOCUMENTDB, DYNAMODB, HYPERPOD, IAM, MYSQL, OPENSEARCH, ORACLE, POSTGRESQL, REDSHIFT, S3, SAPHANA, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, VERTICA, WORKFLOWS_MWAA, AMAZON_Q, MLFLOW
  scope: "DOMAIN", # accepts DOMAIN, PROJECT
})

Response structure


resp.items #=> Array
resp.items[0].connection_id #=> String
resp.items[0].domain_id #=> String
resp.items[0].domain_unit_id #=> String
resp.items[0].environment_id #=> String
resp.items[0].name #=> String
resp.items[0].physical_endpoints #=> Array
resp.items[0].physical_endpoints[0].aws_location.access_role #=> String
resp.items[0].physical_endpoints[0].aws_location. #=> String
resp.items[0].physical_endpoints[0].aws_location.aws_region #=> String
resp.items[0].physical_endpoints[0].aws_location.iam_connection_id #=> String
resp.items[0].physical_endpoints[0].glue_connection_name #=> String
resp.items[0].physical_endpoints[0].glue_connection.name #=> String
resp.items[0].physical_endpoints[0].glue_connection.description #=> String
resp.items[0].physical_endpoints[0].glue_connection.connection_type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.items[0].physical_endpoints[0].glue_connection.match_criteria #=> Array
resp.items[0].physical_endpoints[0].glue_connection.match_criteria[0] #=> String
resp.items[0].physical_endpoints[0].glue_connection.connection_properties #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.items[0].physical_endpoints[0].glue_connection.spark_properties #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.spark_properties["PropertyMapKeyString"] #=> String
resp.items[0].physical_endpoints[0].glue_connection.athena_properties #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.items[0].physical_endpoints[0].glue_connection.python_properties #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> String
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id #=> String
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list #=> Array
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list[0] #=> String
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list #=> Array
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list[0] #=> String
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> String
resp.items[0].physical_endpoints[0].glue_connection.creation_time #=> Time
resp.items[0].physical_endpoints[0].glue_connection.last_updated_time #=> Time
resp.items[0].physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.items[0].physical_endpoints[0].glue_connection.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.items[0].physical_endpoints[0].glue_connection.status_reason #=> String
resp.items[0].physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.secret_arn #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_grant_type #=> String, one of "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "JWT_BEARER"
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.user_managed_client_application_client_id #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.a_ws_managed_client_application_reference #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map["TokenUrlParametersMapKeyString"] #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.authorization_code #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.redirect_uri #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.user_managed_client_application_client_secret #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.access_token #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.refresh_token #=> String
resp.items[0].physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.jwt_token #=> String
resp.items[0].physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
resp.items[0].physical_endpoints[0].glue_connection.compatible_compute_environments #=> Array
resp.items[0].physical_endpoints[0].glue_connection.compatible_compute_environments[0] #=> String, one of "SPARK", "ATHENA", "PYTHON"
resp.items[0].physical_endpoints[0].enable_trusted_identity_propagation #=> Boolean
resp.items[0].physical_endpoints[0].host #=> String
resp.items[0].physical_endpoints[0].port #=> Integer
resp.items[0].physical_endpoints[0].protocol #=> String, one of "ATHENA", "GLUE_INTERACTIVE_SESSION", "HTTPS", "JDBC", "LIVY", "ODBC", "PRISM"
resp.items[0].physical_endpoints[0].stage #=> String
resp.items[0].project_id #=> String
resp.items[0].props.athena_properties.workgroup_name #=> String
resp.items[0].props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.items[0].props.glue_properties.error_message #=> String
resp.items[0].props.hyper_pod_properties.cluster_name #=> String
resp.items[0].props.hyper_pod_properties.cluster_arn #=> String
resp.items[0].props.hyper_pod_properties.orchestrator #=> String, one of "EKS", "SLURM"
resp.items[0].props.iam_properties.environment_id #=> String
resp.items[0].props.iam_properties.glue_lineage_sync_enabled #=> Boolean
resp.items[0].props.redshift_properties.storage.cluster_name #=> String
resp.items[0].props.redshift_properties.storage.workgroup_name #=> String
resp.items[0].props.redshift_properties.credentials.secret_arn #=> String
resp.items[0].props.redshift_properties.credentials.username_password.password #=> String
resp.items[0].props.redshift_properties.credentials.username_password.username #=> String
resp.items[0].props.redshift_properties.is_provisioned_secret #=> Boolean
resp.items[0].props.redshift_properties.jdbc_iam_url #=> String
resp.items[0].props.redshift_properties.jdbc_url #=> String
resp.items[0].props.redshift_properties.redshift_temp_dir #=> String
resp.items[0].props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.items[0].props.redshift_properties.lineage_sync.enabled #=> Boolean
resp.items[0].props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.items[0].props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.items[0].props.redshift_properties.database_name #=> String
resp.items[0].props.spark_emr_properties.compute_arn #=> String
resp.items[0].props.spark_emr_properties.credentials.password #=> String
resp.items[0].props.spark_emr_properties.credentials.username #=> String
resp.items[0].props.spark_emr_properties.credentials_expiration #=> Time
resp.items[0].props.spark_emr_properties.governance_type #=> String, one of "AWS_MANAGED", "USER_MANAGED"
resp.items[0].props.spark_emr_properties.instance_profile_arn #=> String
resp.items[0].props.spark_emr_properties.java_virtual_env #=> String
resp.items[0].props.spark_emr_properties.livy_endpoint #=> String
resp.items[0].props.spark_emr_properties.log_uri #=> String
resp.items[0].props.spark_emr_properties.python_virtual_env #=> String
resp.items[0].props.spark_emr_properties.runtime_role #=> String
resp.items[0].props.spark_emr_properties.trusted_certificates_s3_uri #=> String
resp.items[0].props.spark_emr_properties.certificate_data #=> String
resp.items[0].props.spark_emr_properties.managed_endpoint_arn #=> String
resp.items[0].props.spark_emr_properties.managed_endpoint_credentials.id #=> String
resp.items[0].props.spark_emr_properties.managed_endpoint_credentials.token #=> String
resp.items[0].props.spark_glue_properties.additional_args.connection #=> String
resp.items[0].props.spark_glue_properties.glue_connection_name #=> String
resp.items[0].props.spark_glue_properties.glue_version #=> String
resp.items[0].props.spark_glue_properties.idle_timeout #=> Integer
resp.items[0].props.spark_glue_properties.java_virtual_env #=> String
resp.items[0].props.spark_glue_properties.number_of_workers #=> Integer
resp.items[0].props.spark_glue_properties.python_virtual_env #=> String
resp.items[0].props.spark_glue_properties.worker_type #=> String
resp.items[0].props.s3_properties.s3_uri #=> String
resp.items[0].props.s3_properties.s3_access_grant_location_id #=> String
resp.items[0].props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.items[0].props.s3_properties.error_message #=> String
resp.items[0].props.amazon_q_properties.is_enabled #=> Boolean
resp.items[0].props.amazon_q_properties.profile_arn #=> String
resp.items[0].props.amazon_q_properties.auth_mode #=> String
resp.items[0].props.mlflow_properties.tracking_server_arn #=> String
resp.items[0].type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.items[0].scope #=> String, one of "DOMAIN", "PROJECT"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list connections.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :sort_by (String) —

    Specifies how you want to sort the listed connections.

  • :sort_order (String) —

    Specifies the sort order for the listed connections.

  • :name (String) —

    The name of the connection.

  • :environment_identifier (String) —

    The ID of the environment where you want to list connections.

  • :project_identifier (String) —

    The ID of the project where you want to list connections.

  • :type (String) —

    The type of connection.

  • :scope (String) —

    The scope of the connection.

Returns:

See Also:



8666
8667
8668
8669
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8666

def list_connections(params = {}, options = {})
  req = build_request(:list_connections, params)
  req.send_request(options)
end

#list_data_product_revisions(params = {}) ⇒ Types::ListDataProductRevisionsOutput

Lists data product revisions.

Prerequisites:

  • The data product ID must exist within the domain.

  • User must have view permissions on the data product.

  • The domain must be in a valid and accessible state.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_product_revisions({
  domain_identifier: "DomainId", # required
  identifier: "DataProductId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].revision #=> String
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain of the data product revisions that you want to list.

  • :identifier (required, String) —

    The ID of the data product revision.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



8735
8736
8737
8738
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8735

def list_data_product_revisions(params = {}, options = {})
  req = build_request(:list_data_product_revisions, params)
  req.send_request(options)
end

#list_data_source_run_activities(params = {}) ⇒ Types::ListDataSourceRunActivitiesOutput

Lists data source run activities.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_source_run_activities({
  domain_identifier: "DomainId", # required
  identifier: "DataSourceRunId", # required
  status: "FAILED", # accepts FAILED, PUBLISHING_FAILED, SUCCEEDED_CREATED, SUCCEEDED_UPDATED, SKIPPED_ALREADY_IMPORTED, SKIPPED_ARCHIVED, SKIPPED_NO_ACCESS, UNCHANGED
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].database #=> String
resp.items[0].data_source_run_id #=> String
resp.items[0].technical_name #=> String
resp.items[0].data_asset_status #=> String, one of "FAILED", "PUBLISHING_FAILED", "SUCCEEDED_CREATED", "SUCCEEDED_UPDATED", "SKIPPED_ALREADY_IMPORTED", "SKIPPED_ARCHIVED", "SKIPPED_NO_ACCESS", "UNCHANGED"
resp.items[0].project_id #=> String
resp.items[0].data_asset_id #=> String
resp.items[0].technical_description #=> String
resp.items[0].error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.items[0].error_message.error_detail #=> String
resp.items[0].lineage_summary.event_id #=> String
resp.items[0].lineage_summary.event_status #=> String, one of "REQUESTED", "PROCESSING", "SUCCESS", "FAILED"
resp.items[0].lineage_summary.error_message #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to list data source run activities.

  • :identifier (required, String) —

    The identifier of the data source run.

  • :status (String) —

    The status of the data source run.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



8807
8808
8809
8810
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8807

def list_data_source_run_activities(params = {}, options = {})
  req = build_request(:list_data_source_run_activities, params)
  req.send_request(options)
end

#list_data_source_runs(params = {}) ⇒ Types::ListDataSourceRunsOutput

Lists data source runs in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_source_runs({
  domain_identifier: "DomainId", # required
  data_source_identifier: "DataSourceId", # required
  status: "REQUESTED", # accepts REQUESTED, RUNNING, FAILED, PARTIALLY_SUCCEEDED, SUCCESS
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].data_source_id #=> String
resp.items[0].type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.items[0].status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.items[0].project_id #=> String
resp.items[0].run_statistics_for_assets.added #=> Integer
resp.items[0].run_statistics_for_assets.updated #=> Integer
resp.items[0].run_statistics_for_assets.unchanged #=> Integer
resp.items[0].run_statistics_for_assets.skipped #=> Integer
resp.items[0].run_statistics_for_assets.failed #=> Integer
resp.items[0].error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.items[0].error_message.error_detail #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].started_at #=> Time
resp.items[0].stopped_at #=> Time
resp.items[0].lineage_summary.import_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "PARTIALLY_SUCCEEDED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

  • :data_source_identifier (required, String) —

    The identifier of the data source.

  • :status (String) —

    The status of the data source.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



8882
8883
8884
8885
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8882

def list_data_source_runs(params = {}, options = {})
  req = build_request(:list_data_source_runs, params)
  req.send_request(options)
end

#list_data_sources(params = {}) ⇒ Types::ListDataSourcesOutput

Lists data sources in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_sources({
  domain_identifier: "DomainId", # required
  project_identifier: "String", # required
  environment_identifier: "String",
  connection_identifier: "String",
  type: "DataSourceType",
  status: "CREATING", # accepts CREATING, FAILED_CREATION, READY, UPDATING, FAILED_UPDATE, RUNNING, DELETING, FAILED_DELETION
  name: "Name",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].environment_id #=> String
resp.items[0].connection_id #=> String
resp.items[0].data_source_id #=> String
resp.items[0].name #=> String
resp.items[0].type #=> String
resp.items[0].status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.items[0].enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.items[0].schedule.timezone #=> String, one of "UTC", "AFRICA_JOHANNESBURG", "AMERICA_MONTREAL", "AMERICA_SAO_PAULO", "ASIA_BAHRAIN", "ASIA_BANGKOK", "ASIA_CALCUTTA", "ASIA_DUBAI", "ASIA_HONG_KONG", "ASIA_JAKARTA", "ASIA_KUALA_LUMPUR", "ASIA_SEOUL", "ASIA_SHANGHAI", "ASIA_SINGAPORE", "ASIA_TAIPEI", "ASIA_TOKYO", "AUSTRALIA_MELBOURNE", "AUSTRALIA_SYDNEY", "CANADA_CENTRAL", "CET", "CST6CDT", "ETC_GMT", "ETC_GMT0", "ETC_GMT_ADD_0", "ETC_GMT_ADD_1", "ETC_GMT_ADD_10", "ETC_GMT_ADD_11", "ETC_GMT_ADD_12", "ETC_GMT_ADD_2", "ETC_GMT_ADD_3", "ETC_GMT_ADD_4", "ETC_GMT_ADD_5", "ETC_GMT_ADD_6", "ETC_GMT_ADD_7", "ETC_GMT_ADD_8", "ETC_GMT_ADD_9", "ETC_GMT_NEG_0", "ETC_GMT_NEG_1", "ETC_GMT_NEG_10", "ETC_GMT_NEG_11", "ETC_GMT_NEG_12", "ETC_GMT_NEG_13", "ETC_GMT_NEG_14", "ETC_GMT_NEG_2", "ETC_GMT_NEG_3", "ETC_GMT_NEG_4", "ETC_GMT_NEG_5", "ETC_GMT_NEG_6", "ETC_GMT_NEG_7", "ETC_GMT_NEG_8", "ETC_GMT_NEG_9", "EUROPE_DUBLIN", "EUROPE_LONDON", "EUROPE_PARIS", "EUROPE_STOCKHOLM", "EUROPE_ZURICH", "ISRAEL", "MEXICO_GENERAL", "MST7MDT", "PACIFIC_AUCKLAND", "US_CENTRAL", "US_EASTERN", "US_MOUNTAIN", "US_PACIFIC"
resp.items[0].schedule.schedule #=> String
resp.items[0].last_run_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.items[0].last_run_at #=> Time
resp.items[0].last_run_error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.items[0].last_run_error_message.error_detail #=> String
resp.items[0].last_run_asset_count #=> Integer
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to list the data sources.

  • :project_identifier (required, String) —

    The identifier of the project in which to list data sources.

  • :environment_identifier (String) —

    The identifier of the environment in which to list the data sources.

  • :connection_identifier (String) —

    The ID of the connection.

  • :type (String) —

    The type of the data source.

  • :status (String) —

    The status of the data source.

  • :name (String) —

    The name of the data source.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



8974
8975
8976
8977
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8974

def list_data_sources(params = {}, options = {})
  req = build_request(:list_data_sources, params)
  req.send_request(options)
end

#list_domain_units_for_parent(params = {}) ⇒ Types::ListDomainUnitsForParentOutput

Lists child domain units for the specified parent domain unit.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_domain_units_for_parent({
  domain_identifier: "DomainId", # required
  parent_domain_unit_identifier: "DomainUnitId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].name #=> String
resp.items[0].id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which you want to list domain units for a parent domain unit.

  • :parent_domain_unit_identifier (required, String) —

    The ID of the parent domain unit.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



9030
9031
9032
9033
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9030

def list_domain_units_for_parent(params = {}, options = {})
  req = build_request(:list_domain_units_for_parent, params)
  req.send_request(options)
end

#list_domains(params = {}) ⇒ Types::ListDomainsOutput

Lists Amazon DataZone domains.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATION_FAILED, DELETING, DELETED, DELETION_FAILED
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].arn #=> String
resp.items[0]. #=> String
resp.items[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED"
resp.items[0].portal_url #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].domain_version #=> String, one of "V1", "V2"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :status (String) —

    The status of the data source.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



9089
9090
9091
9092
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9089

def list_domains(params = {}, options = {})
  req = build_request(:list_domains, params)
  req.send_request(options)
end

#list_entity_owners(params = {}) ⇒ Types::ListEntityOwnersOutput

Lists the entity (domain units) owners.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_entity_owners({
  domain_identifier: "DomainId", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  entity_identifier: "String", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.owners #=> Array
resp.owners[0].user.user_id #=> String
resp.owners[0].group.group_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list entity owners.

  • :entity_type (required, String) —

    The type of the entity that you want to list.

  • :entity_identifier (required, String) —

    The ID of the entity that you want to list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



9148
9149
9150
9151
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9148

def list_entity_owners(params = {}, options = {})
  req = build_request(:list_entity_owners, params)
  req.send_request(options)
end

#list_environment_actions(params = {}) ⇒ Types::ListEnvironmentActionsOutput

Lists existing environment actions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_actions({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].environment_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].parameters.aws_console_link.uri #=> String
resp.items[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the environment actions are listed.

  • :environment_identifier (required, String) —

    The ID of the envrironment whose environment actions are listed.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



9208
9209
9210
9211
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9208

def list_environment_actions(params = {}, options = {})
  req = build_request(:list_environment_actions, params)
  req.send_request(options)
end

#list_environment_blueprint_configurations(params = {}) ⇒ Types::ListEnvironmentBlueprintConfigurationsOutput

Lists blueprint configurations for a Amazon DataZone environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_blueprint_configurations({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].environment_blueprint_id #=> String
resp.items[0].provisioning_role_arn #=> String
resp.items[0].environment_role_permission_boundary #=> String
resp.items[0].manage_access_role_arn #=> String
resp.items[0].enabled_regions #=> Array
resp.items[0].enabled_regions[0] #=> String
resp.items[0].regional_parameters #=> Hash
resp.items[0].regional_parameters["RegionName"] #=> Hash
resp.items[0].regional_parameters["RegionName"]["String"] #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].provisioning_configurations #=> Array
resp.items[0].provisioning_configurations[0].lake_formation_configuration.location_registration_role #=> String
resp.items[0].provisioning_configurations[0].lake_formation_configuration.location_registration_exclude_s3_locations #=> Array
resp.items[0].provisioning_configurations[0].lake_formation_configuration.location_registration_exclude_s3_locations[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:



9275
9276
9277
9278
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9275

def list_environment_blueprint_configurations(params = {}, options = {})
  req = build_request(:list_environment_blueprint_configurations, params)
  req.send_request(options)
end

#list_environment_blueprints(params = {}) ⇒ Types::ListEnvironmentBlueprintsOutput

Lists blueprints in an Amazon DataZone environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_blueprints({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  name: "EnvironmentBlueprintName",
  managed: false,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].provider #=> String
resp.items[0].provisioning_properties.cloud_formation.template_url #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :name (String) —

    The name of the Amazon DataZone environment.

  • :managed (Boolean) —

    Specifies whether the environment blueprint is managed by Amazon DataZone.

Returns:

See Also:



9341
9342
9343
9344
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9341

def list_environment_blueprints(params = {}, options = {})
  req = build_request(:list_environment_blueprints, params)
  req.send_request(options)
end

#list_environment_profiles(params = {}) ⇒ Types::ListEnvironmentProfilesOutput

Lists Amazon DataZone environment profiles.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_profiles({
  domain_identifier: "DomainId", # required
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  environment_blueprint_identifier: "EnvironmentBlueprintId",
  project_identifier: "ProjectId",
  name: "EnvironmentProfileName",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].domain_id #=> String
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].environment_blueprint_id #=> String
resp.items[0].project_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :aws_account_id (String) —

    The identifier of the Amazon Web Services account where you want to list environment profiles.

  • :aws_account_region (String) —

    The Amazon Web Services region where you want to list environment profiles.

  • :environment_blueprint_identifier (String) —

    The identifier of the blueprint that was used to create the environment profiles that you want to list.

  • :project_identifier (String) —

    The identifier of the Amazon DataZone project.

  • :name (String)
  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



9425
9426
9427
9428
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9425

def list_environment_profiles(params = {}, options = {})
  req = build_request(:list_environment_profiles, params)
  req.send_request(options)
end

#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput

Lists Amazon DataZone environments.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environments({
  domain_identifier: "DomainId", # required
  aws_account_id: "AwsAccountId",
  status: "ACTIVE", # accepts ACTIVE, CREATING, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED, VALIDATION_FAILED, SUSPENDED, DISABLED, EXPIRED, DELETED, INACCESSIBLE
  aws_account_region: "AwsRegion",
  project_identifier: "ProjectId", # required
  environment_profile_identifier: "EnvironmentProfileId",
  environment_blueprint_identifier: "EnvironmentBlueprintId",
  provider: "String",
  name: "String",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].project_id #=> String
resp.items[0].id #=> String
resp.items[0].domain_id #=> String
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].environment_profile_id #=> String
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].provider #=> String
resp.items[0].status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "VALIDATION_FAILED", "SUSPENDED", "DISABLED", "EXPIRED", "DELETED", "INACCESSIBLE"
resp.items[0].environment_configuration_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :aws_account_id (String) —

    The identifier of the Amazon Web Services account where you want to list environments.

  • :status (String) —

    The status of the environments that you want to list.

  • :aws_account_region (String) —

    The Amazon Web Services region where you want to list environments.

  • :project_identifier (required, String) —

    The identifier of the Amazon DataZone project.

  • :environment_profile_identifier (String) —

    The identifier of the environment profile.

  • :environment_blueprint_identifier (String) —

    The identifier of the Amazon DataZone blueprint.

  • :provider (String) —

    The provider of the environment.

  • :name (String) —

    The name of the environment.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



9521
9522
9523
9524
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9521

def list_environments(params = {}, options = {})
  req = build_request(:list_environments, params)
  req.send_request(options)
end

#list_job_runs(params = {}) ⇒ Types::ListJobRunsOutput

Lists job runs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_job_runs({
  domain_identifier: "DomainId", # required
  job_identifier: "ListJobRunsInputJobIdentifierString", # required
  status: "SCHEDULED", # accepts SCHEDULED, IN_PROGRESS, SUCCESS, PARTIALLY_SUCCEEDED, FAILED, ABORTED, TIMED_OUT, CANCELED
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].job_id #=> String
resp.items[0].job_type #=> String, one of "LINEAGE"
resp.items[0].run_id #=> String
resp.items[0].run_mode #=> String, one of "SCHEDULED", "ON_DEMAND"
resp.items[0].status #=> String, one of "SCHEDULED", "IN_PROGRESS", "SUCCESS", "PARTIALLY_SUCCEEDED", "FAILED", "ABORTED", "TIMED_OUT", "CANCELED"
resp.items[0].error.message #=> String
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.items[0].start_time #=> Time
resp.items[0].end_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list job runs.

  • :job_identifier (required, String) —

    The ID of the job run.

  • :status (String) —

    The status of a job run.

  • :sort_order (String) —

    Specifies the order in which job runs are to be sorted.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



9593
9594
9595
9596
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9593

def list_job_runs(params = {}, options = {})
  req = build_request(:list_job_runs, params)
  req.send_request(options)
end

#list_lineage_events(params = {}) ⇒ Types::ListLineageEventsOutput

Lists lineage events.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_lineage_events({
  domain_identifier: "DomainId", # required
  max_results: 1,
  timestamp_after: Time.now,
  timestamp_before: Time.now,
  processing_status: "REQUESTED", # accepts REQUESTED, PROCESSING, SUCCESS, FAILED
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].domain_id #=> String
resp.items[0].processing_status #=> String, one of "REQUESTED", "PROCESSING", "SUCCESS", "FAILED"
resp.items[0].event_time #=> Time
resp.items[0].event_summary.open_lineage_run_event_summary.event_type #=> String, one of "START", "RUNNING", "COMPLETE", "ABORT", "FAIL", "OTHER"
resp.items[0].event_summary.open_lineage_run_event_summary.run_id #=> String
resp.items[0].event_summary.open_lineage_run_event_summary.job.name #=> String
resp.items[0].event_summary.open_lineage_run_event_summary.job.namespace #=> String
resp.items[0].event_summary.open_lineage_run_event_summary.inputs #=> Array
resp.items[0].event_summary.open_lineage_run_event_summary.inputs[0].name #=> String
resp.items[0].event_summary.open_lineage_run_event_summary.inputs[0].namespace #=> String
resp.items[0].event_summary.open_lineage_run_event_summary.outputs #=> Array
resp.items[0].event_summary.open_lineage_run_event_summary.outputs[0].name #=> String
resp.items[0].event_summary.open_lineage_run_event_summary.outputs[0].namespace #=> String
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list lineage events.

  • :max_results (Integer) —

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

  • :timestamp_after (Time, DateTime, Date, Integer, String) —

    The after timestamp of a lineage event.

  • :timestamp_before (Time, DateTime, Date, Integer, String) —

    The before timestamp of a lineage event.

  • :processing_status (String) —

    The processing status of a lineage event.

  • :sort_order (String) —

    The sort order of the lineage events.

  • :next_token (String) —

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

Returns:

See Also:



9674
9675
9676
9677
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9674

def list_lineage_events(params = {}, options = {})
  req = build_request(:list_lineage_events, params)
  req.send_request(options)
end

#list_lineage_node_history(params = {}) ⇒ Types::ListLineageNodeHistoryOutput

Lists the history of the specified data lineage node.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_lineage_node_history({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  identifier: "LineageNodeIdentifier", # required
  direction: "UPSTREAM", # accepts UPSTREAM, DOWNSTREAM
  event_timestamp_gte: Time.now,
  event_timestamp_lte: Time.now,
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.nodes #=> Array
resp.nodes[0].domain_id #=> String
resp.nodes[0].name #=> String
resp.nodes[0].description #=> String
resp.nodes[0].created_at #=> Time
resp.nodes[0].created_by #=> String
resp.nodes[0].updated_at #=> Time
resp.nodes[0].updated_by #=> String
resp.nodes[0].id #=> String
resp.nodes[0].type_name #=> String
resp.nodes[0].type_revision #=> String
resp.nodes[0].source_identifier #=> String
resp.nodes[0].event_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list the history of the specified data lineage node.

  • :max_results (Integer) —

    The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships 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 ListLineageNodeHistory to list the next set of items.

  • :next_token (String) —

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

  • :identifier (required, String) —

    The ID of the data lineage node whose history you want to list.

  • :direction (String) —

    The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

  • :event_timestamp_gte (Time, DateTime, Date, Integer, String) —

    Specifies whether the action is to return data lineage node history from the time after the event timestamp.

  • :event_timestamp_lte (Time, DateTime, Date, Integer, String) —

    Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

  • :sort_order (String) —

    The order by which you want data lineage node history to be sorted.

Returns:

See Also:



9761
9762
9763
9764
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9761

def list_lineage_node_history(params = {}, options = {})
  req = build_request(:list_lineage_node_history, params)
  req.send_request(options)
end

#list_metadata_generation_runs(params = {}) ⇒ Types::ListMetadataGenerationRunsOutput

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:

  • Valid domain identifier.

  • User must have access to metadata generation runs in the domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_metadata_generation_runs({
  domain_identifier: "DomainId", # required
  status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELED, SUCCEEDED, FAILED, PARTIALLY_SUCCEEDED
  type: "BUSINESS_DESCRIPTIONS", # accepts BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS
  next_token: "PaginationToken",
  max_results: 1,
  target_identifier: "EntityId",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].target.type #=> String, one of "ASSET"
resp.items[0].target.identifier #=> String
resp.items[0].target.revision #=> String
resp.items[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED", "PARTIALLY_SUCCEEDED"
resp.items[0].type #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.items[0].types #=> Array
resp.items[0].types[0] #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].owning_project_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where you want to list metadata generation runs.

  • :status (String) —

    The status of the metadata generation runs.

  • :type (String) —

    The type of the metadata generation runs.

  • :next_token (String) —

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

  • :max_results (Integer) —

    The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs 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 ListMetadataGenerationRuns to list the next set of revisions.

  • :target_identifier (String) —

    The target ID for which you want to list metadata generation runs.

Returns:

See Also:



9850
9851
9852
9853
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9850

def list_metadata_generation_runs(params = {}, options = {})
  req = build_request(:list_metadata_generation_runs, params)
  req.send_request(options)
end

#list_notifications(params = {}) ⇒ Types::ListNotificationsOutput

Lists all Amazon DataZone notifications.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_notifications({
  domain_identifier: "DomainId", # required
  type: "TASK", # required, accepts TASK, EVENT
  after_timestamp: Time.now,
  before_timestamp: Time.now,
  subjects: ["String"],
  task_status: "ACTIVE", # accepts ACTIVE, INACTIVE
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.notifications #=> Array
resp.notifications[0].identifier #=> String
resp.notifications[0].domain_identifier #=> String
resp.notifications[0].type #=> String, one of "TASK", "EVENT"
resp.notifications[0].topic.subject #=> String
resp.notifications[0].topic.resource.type #=> String, one of "PROJECT"
resp.notifications[0].topic.resource.id #=> String
resp.notifications[0].topic.resource.name #=> String
resp.notifications[0].topic.role #=> String, one of "PROJECT_OWNER", "PROJECT_CONTRIBUTOR", "PROJECT_VIEWER", "DOMAIN_OWNER", "PROJECT_SUBSCRIBER"
resp.notifications[0].title #=> String
resp.notifications[0].message #=> String
resp.notifications[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.notifications[0].action_link #=> String
resp.notifications[0].creation_timestamp #=> Time
resp.notifications[0].last_updated_timestamp #=> Time
resp.notifications[0].metadata #=> Hash
resp.notifications[0].metadata["String"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :type (required, String) —

    The type of notifications.

  • :after_timestamp (Time, DateTime, Date, Integer, String) —

    The time after which you want to list notifications.

  • :before_timestamp (Time, DateTime, Date, Integer, String) —

    The time before which you want to list notifications.

  • :subjects (Array<String>) —

    The subjects of notifications.

  • :task_status (String) —

    The task status of notifications.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



9935
9936
9937
9938
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9935

def list_notifications(params = {}, options = {})
  req = build_request(:list_notifications, params)
  req.send_request(options)
end

#list_policy_grants(params = {}) ⇒ Types::ListPolicyGrantsOutput

Lists policy grants.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_policy_grants({
  domain_identifier: "DomainId", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE, ASSET_TYPE
  entity_identifier: "String", # required
  policy_type: "CREATE_DOMAIN_UNIT", # required, accepts CREATE_DOMAIN_UNIT, OVERRIDE_DOMAIN_UNIT_OWNERS, ADD_TO_PROJECT_MEMBER_POOL, OVERRIDE_PROJECT_OWNERS, CREATE_GLOSSARY, CREATE_FORM_TYPE, CREATE_ASSET_TYPE, CREATE_PROJECT, CREATE_ENVIRONMENT_PROFILE, DELEGATE_CREATE_ENVIRONMENT_PROFILE, CREATE_ENVIRONMENT, CREATE_ENVIRONMENT_FROM_BLUEPRINT, CREATE_PROJECT_FROM_PROJECT_PROFILE, USE_ASSET_TYPE
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.grant_list #=> Array
resp.grant_list[0].principal.user.user_identifier #=> String
resp.grant_list[0].principal.group.group_identifier #=> String
resp.grant_list[0].principal.project.project_designation #=> String, one of "OWNER", "CONTRIBUTOR", "PROJECT_CATALOG_STEWARD"
resp.grant_list[0].principal.project.project_identifier #=> String
resp.grant_list[0].principal.project.project_grant_filter.domain_unit_filter.domain_unit #=> String
resp.grant_list[0].principal.project.project_grant_filter.domain_unit_filter.include_child_domain_units #=> Boolean
resp.grant_list[0].principal.domain_unit.domain_unit_designation #=> String, one of "OWNER"
resp.grant_list[0].principal.domain_unit.domain_unit_identifier #=> String
resp.grant_list[0].detail.create_domain_unit.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.override_domain_unit_owners.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.add_to_project_member_pool.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.override_project_owners.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_glossary.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_form_type.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_asset_type.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_project.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_environment_profile.domain_unit_id #=> String
resp.grant_list[0].detail.create_project_from_project_profile.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_project_from_project_profile.project_profiles #=> Array
resp.grant_list[0].detail.create_project_from_project_profile.project_profiles[0] #=> String
resp.grant_list[0].detail.use_asset_type.domain_unit_id #=> String
resp.grant_list[0].created_at #=> Time
resp.grant_list[0].created_by #=> String
resp.grant_list[0].grant_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list policy grants.

  • :entity_type (required, String) —

    The type of entity for which you want to list policy grants.

  • :entity_identifier (required, String) —

    The ID of the entity for which you want to list policy grants.

  • :policy_type (required, String) —

    The type of policy that you want to list.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



10020
10021
10022
10023
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10020

def list_policy_grants(params = {}, options = {})
  req = build_request(:list_policy_grants, params)
  req.send_request(options)
end

#list_project_memberships(params = {}) ⇒ Types::ListProjectMembershipsOutput

Lists all members of the specified project.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_project_memberships({
  domain_identifier: "DomainId", # required
  project_identifier: "ProjectId", # required
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.members #=> Array
resp.members[0].member_details.user.user_id #=> String
resp.members[0].member_details.group.group_id #=> String
resp.members[0].designation #=> String, one of "PROJECT_OWNER", "PROJECT_CONTRIBUTOR", "PROJECT_CATALOG_VIEWER", "PROJECT_CATALOG_CONSUMER", "PROJECT_CATALOG_STEWARD"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which you want to list project memberships.

  • :project_identifier (required, String) —

    The identifier of the project whose memberships you want to list.

  • :sort_by (String) —

    The method by which you want to sort the project memberships.

  • :sort_order (String) —

    The sort order of the project memberships.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



10085
10086
10087
10088
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10085

def list_project_memberships(params = {}, options = {})
  req = build_request(:list_project_memberships, params)
  req.send_request(options)
end

#list_project_profiles(params = {}) ⇒ Types::ListProjectProfilesOutput

Lists project profiles.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_project_profiles({
  domain_identifier: "DomainId", # required
  name: "ProjectProfileName",
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].status #=> String, one of "ENABLED", "DISABLED"
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.items[0].last_updated_at #=> Time
resp.items[0].domain_unit_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list project profiles.

  • :name (String) —

    The name of a project profile.

  • :sort_by (String) —

    Specifies by what to sort project profiles.

  • :sort_order (String) —

    Specifies the sort order of the project profiles.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



10155
10156
10157
10158
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10155

def list_project_profiles(params = {}, options = {})
  req = build_request(:list_project_profiles, params)
  req.send_request(options)
end

#list_projects(params = {}) ⇒ Types::ListProjectsOutput

Lists Amazon DataZone projects.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  domain_identifier: "DomainId", # required
  user_identifier: "String",
  group_identifier: "String",
  name: "ProjectName",
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].description #=> String
resp.items[0].project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.items[0].failure_reasons #=> Array
resp.items[0].failure_reasons[0].code #=> String
resp.items[0].failure_reasons[0].message #=> String
resp.items[0].created_by #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].domain_unit_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :user_identifier (String) —

    The identifier of the Amazon DataZone user.

  • :group_identifier (String) —

    The identifier of a group.

  • :name (String) —

    The name of the project.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



10228
10229
10230
10231
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10228

def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end

#list_rules(params = {}) ⇒ Types::ListRulesOutput

Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_rules({
  domain_identifier: "DomainId", # required
  target_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  target_identifier: "String", # required
  rule_type: "METADATA_FORM_ENFORCEMENT", # accepts METADATA_FORM_ENFORCEMENT, GLOSSARY_TERM_ENFORCEMENT
  action: "CREATE_LISTING_CHANGE_SET", # accepts CREATE_LISTING_CHANGE_SET, CREATE_SUBSCRIPTION_REQUEST
  project_ids: ["ProjectId"],
  asset_types: ["AssetTypeIdentifier"],
  data_product: false,
  include_cascaded: false,
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].identifier #=> String
resp.items[0].revision #=> String
resp.items[0].rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT", "GLOSSARY_TERM_ENFORCEMENT"
resp.items[0].name #=> String
resp.items[0].target_type #=> String, one of "DOMAIN_UNIT"
resp.items[0].target.domain_unit_target.domain_unit_id #=> String
resp.items[0].target.domain_unit_target.include_child_domain_units #=> Boolean
resp.items[0].action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.items[0].scope.asset_type.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.items[0].scope.asset_type.specific_asset_types #=> Array
resp.items[0].scope.asset_type.specific_asset_types[0] #=> String
resp.items[0].scope.data_product #=> Boolean
resp.items[0].scope.project.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.items[0].scope.project.specific_projects #=> Array
resp.items[0].scope.project.specific_projects[0] #=> String
resp.items[0].updated_at #=> Time
resp.items[0].last_updated_by #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which the rules are to be listed.

  • :target_type (required, String) —

    The target type of the rule.

  • :target_identifier (required, String) —

    The target ID of the rule.

  • :rule_type (String) —

    The type of the rule.

  • :action (String) —

    The action of the rule.

  • :project_ids (Array<String>) —

    The IDs of projects in which rules are to be listed.

  • :asset_types (Array<String>) —

    The asset types of the rule.

  • :data_product (Boolean) —

    The data product of the rule.

  • :include_cascaded (Boolean) —

    Specifies whether to include cascading rules in the results.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



10333
10334
10335
10336
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10333

def list_rules(params = {}, options = {})
  req = build_request(:list_rules, params)
  req.send_request(options)
end

#list_subscription_grants(params = {}) ⇒ Types::ListSubscriptionGrantsOutput

Lists subscription grants.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_grants({
  domain_identifier: "DomainId", # required
  environment_id: "EnvironmentId",
  subscription_target_id: "SubscriptionTargetId",
  subscribed_listing_id: "ListingId",
  subscription_id: "SubscriptionId",
  owning_project_id: "ProjectId",
  owning_iam_principal_arn: "IamPrincipalArn",
  owning_user_id: "UserProfileId",
  owning_group_id: "GroupProfileId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].created_by #=> String
resp.items[0].updated_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].environment_id #=> String
resp.items[0].subscription_target_id #=> String
resp.items[0].granted_entity.listing.id #=> String
resp.items[0].granted_entity.listing.revision #=> String
resp.items[0].status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.items[0].assets #=> Array
resp.items[0].assets[0].asset_id #=> String
resp.items[0].assets[0].asset_revision #=> String
resp.items[0].assets[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "REVOKED", "GRANT_FAILED", "REVOKE_FAILED"
resp.items[0].assets[0].target_name #=> String
resp.items[0].assets[0].failure_cause.message #=> String
resp.items[0].assets[0].granted_timestamp #=> Time
resp.items[0].assets[0].failure_timestamp #=> Time
resp.items[0].assets[0].asset_scope.asset_id #=> String
resp.items[0].assets[0].asset_scope.filter_ids #=> Array
resp.items[0].assets[0].asset_scope.filter_ids[0] #=> String
resp.items[0].assets[0].asset_scope.status #=> String
resp.items[0].assets[0].asset_scope.error_message #=> String
resp.items[0].assets[0].permissions.s3 #=> Array
resp.items[0].assets[0].permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.items[0].subscription_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_id (String) —

    The identifier of the Amazon DataZone environment.

  • :subscription_target_id (String) —

    The identifier of the subscription target.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing.

  • :subscription_id (String) —

    The identifier of the subscription.

  • :owning_project_id (String) —

    The ID of the owning project of the subscription grants.

  • :owning_iam_principal_arn (String) —

    The ARN of the owning IAM principal.

  • :owning_user_id (String) —

    The ID of the owning user.

  • :owning_group_id (String) —

    The ID of the owning group.

  • :sort_by (String) —

    Specifies the way of sorting the results of this action.

  • :sort_order (String) —

    Specifies the sort order of this action.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



10449
10450
10451
10452
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10449

def list_subscription_grants(params = {}, options = {})
  req = build_request(:list_subscription_grants, params)
  req.send_request(options)
end

#list_subscription_requests(params = {}) ⇒ Types::ListSubscriptionRequestsOutput

Lists Amazon DataZone subscription requests.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_requests({
  domain_identifier: "DomainId", # required
  status: "PENDING", # accepts PENDING, ACCEPTED, REJECTED
  subscribed_listing_id: "ListingId",
  owning_project_id: "ProjectId",
  owning_iam_principal_arn: "IamPrincipalArn",
  approver_project_id: "ProjectId",
  owning_user_id: "UserProfileId",
  owning_group_id: "GroupProfileId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].created_by #=> String
resp.items[0].updated_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].request_reason #=> String
resp.items[0].subscribed_principals #=> Array
resp.items[0].subscribed_principals[0].project.id #=> String
resp.items[0].subscribed_principals[0].project.name #=> String
resp.items[0].subscribed_principals[0].user.id #=> String
resp.items[0].subscribed_principals[0].user.details.iam.arn #=> String
resp.items[0].subscribed_principals[0].user.details.iam.principal_id #=> String
resp.items[0].subscribed_principals[0].user.details.sso.username #=> String
resp.items[0].subscribed_principals[0].user.details.sso.first_name #=> String
resp.items[0].subscribed_principals[0].user.details.sso.last_name #=> String
resp.items[0].subscribed_principals[0].group.id #=> String
resp.items[0].subscribed_principals[0].group.name #=> String
resp.items[0].subscribed_principals[0].iam.principal_arn #=> String
resp.items[0].subscribed_listings #=> Array
resp.items[0].subscribed_listings[0].id #=> String
resp.items[0].subscribed_listings[0].revision #=> String
resp.items[0].subscribed_listings[0].name #=> String
resp.items[0].subscribed_listings[0].description #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.forms #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.items[0].subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.asset_scope.filter_ids #=> Array
resp.items[0].subscribed_listings[0].item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.asset_scope.status #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.permissions.s3 #=> Array
resp.items[0].subscribed_listings[0].item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.items[0].subscribed_listings[0].item.product_listing.entity_id #=> String
resp.items[0].subscribed_listings[0].item.product_listing.entity_revision #=> String
resp.items[0].subscribed_listings[0].item.product_listing.glossary_terms #=> Array
resp.items[0].subscribed_listings[0].item.product_listing.glossary_terms[0].name #=> String
resp.items[0].subscribed_listings[0].item.product_listing.glossary_terms[0].short_description #=> String
resp.items[0].subscribed_listings[0].item.product_listing.name #=> String
resp.items[0].subscribed_listings[0].item.product_listing.description #=> String
resp.items[0].subscribed_listings[0].item.product_listing.asset_listings #=> Array
resp.items[0].subscribed_listings[0].item.product_listing.asset_listings[0].entity_id #=> String
resp.items[0].subscribed_listings[0].item.product_listing.asset_listings[0].entity_revision #=> String
resp.items[0].subscribed_listings[0].item.product_listing.asset_listings[0].entity_type #=> String
resp.items[0].subscribed_listings[0].owner_project_id #=> String
resp.items[0].subscribed_listings[0].owner_project_name #=> String
resp.items[0].reviewer_id #=> String
resp.items[0].decision_comment #=> String
resp.items[0].existing_subscription_id #=> String
resp.items[0].metadata_forms_summary #=> Array
resp.items[0].metadata_forms_summary[0].form_name #=> String
resp.items[0].metadata_forms_summary[0].type_name #=> String
resp.items[0].metadata_forms_summary[0].type_revision #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :status (String) —

    Specifies the status of the subscription requests.

    This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing.

  • :owning_project_id (String) —

    The identifier of the project for the subscription requests.

  • :owning_iam_principal_arn (String) —

    The ARN of the owning IAM principal.

  • :approver_project_id (String) —

    The identifier of the subscription request approver's project.

  • :owning_user_id (String) —

    The ID of the owning user.

  • :owning_group_id (String) —

    The ID of the owning group.

  • :sort_by (String) —

    Specifies the way to sort the results of this action.

  • :sort_order (String) —

    Specifies the sort order for the results of this action.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



10600
10601
10602
10603
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10600

def list_subscription_requests(params = {}, options = {})
  req = build_request(:list_subscription_requests, params)
  req.send_request(options)
end

#list_subscription_targets(params = {}) ⇒ Types::ListSubscriptionTargetsOutput

Lists subscription targets in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_targets({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].authorized_principals #=> Array
resp.items[0].authorized_principals[0] #=> String
resp.items[0].domain_id #=> String
resp.items[0].project_id #=> String
resp.items[0].environment_id #=> String
resp.items[0].name #=> String
resp.items[0].type #=> String
resp.items[0].created_by #=> String
resp.items[0].updated_by #=> String
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].manage_access_role #=> String
resp.items[0].applicable_asset_types #=> Array
resp.items[0].applicable_asset_types[0] #=> String
resp.items[0].subscription_target_config #=> Array
resp.items[0].subscription_target_config[0].form_name #=> String
resp.items[0].subscription_target_config[0].content #=> String
resp.items[0].provider #=> String
resp.items[0].subscription_grant_creation_mode #=> String, one of "AUTOMATIC", "MANUAL"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain where you want to list subscription targets.

  • :environment_identifier (required, String) —

    The identifier of the environment where you want to list subscription targets.

  • :sort_by (String) —

    Specifies the way in which the results of this action are to be sorted.

  • :sort_order (String) —

    Specifies the sort order for the results of this action.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



10686
10687
10688
10689
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10686

def list_subscription_targets(params = {}, options = {})
  req = build_request(:list_subscription_targets, params)
  req.send_request(options)
end

#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsOutput

Lists subscriptions in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscriptions({
  domain_identifier: "DomainId", # required
  subscription_request_identifier: "SubscriptionRequestId",
  status: "APPROVED", # accepts APPROVED, REVOKED, CANCELLED
  subscribed_listing_id: "ListingId",
  owning_project_id: "ProjectId",
  owning_iam_principal_arn: "IamPrincipalArn",
  owning_user_id: "UserProfileId",
  owning_group_id: "GroupProfileId",
  approver_project_id: "ProjectId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].created_by #=> String
resp.items[0].updated_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.items[0].created_at #=> Time
resp.items[0].updated_at #=> Time
resp.items[0].subscribed_principal.project.id #=> String
resp.items[0].subscribed_principal.project.name #=> String
resp.items[0].subscribed_principal.user.id #=> String
resp.items[0].subscribed_principal.user.details.iam.arn #=> String
resp.items[0].subscribed_principal.user.details.iam.principal_id #=> String
resp.items[0].subscribed_principal.user.details.sso.username #=> String
resp.items[0].subscribed_principal.user.details.sso.first_name #=> String
resp.items[0].subscribed_principal.user.details.sso.last_name #=> String
resp.items[0].subscribed_principal.group.id #=> String
resp.items[0].subscribed_principal.group.name #=> String
resp.items[0].subscribed_principal.iam.principal_arn #=> String
resp.items[0].subscribed_listing.id #=> String
resp.items[0].subscribed_listing.revision #=> String
resp.items[0].subscribed_listing.name #=> String
resp.items[0].subscribed_listing.description #=> String
resp.items[0].subscribed_listing.item.asset_listing.entity_id #=> String
resp.items[0].subscribed_listing.item.asset_listing.entity_revision #=> String
resp.items[0].subscribed_listing.item.asset_listing.entity_type #=> String
resp.items[0].subscribed_listing.item.asset_listing.forms #=> String
resp.items[0].subscribed_listing.item.asset_listing.glossary_terms #=> Array
resp.items[0].subscribed_listing.item.asset_listing.glossary_terms[0].name #=> String
resp.items[0].subscribed_listing.item.asset_listing.glossary_terms[0].short_description #=> String
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.filter_ids #=> Array
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.status #=> String
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.error_message #=> String
resp.items[0].subscribed_listing.item.asset_listing.permissions.s3 #=> Array
resp.items[0].subscribed_listing.item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.items[0].subscribed_listing.item.product_listing.entity_id #=> String
resp.items[0].subscribed_listing.item.product_listing.entity_revision #=> String
resp.items[0].subscribed_listing.item.product_listing.glossary_terms #=> Array
resp.items[0].subscribed_listing.item.product_listing.glossary_terms[0].name #=> String
resp.items[0].subscribed_listing.item.product_listing.glossary_terms[0].short_description #=> String
resp.items[0].subscribed_listing.item.product_listing.name #=> String
resp.items[0].subscribed_listing.item.product_listing.description #=> String
resp.items[0].subscribed_listing.item.product_listing.asset_listings #=> Array
resp.items[0].subscribed_listing.item.product_listing.asset_listings[0].entity_id #=> String
resp.items[0].subscribed_listing.item.product_listing.asset_listings[0].entity_revision #=> String
resp.items[0].subscribed_listing.item.product_listing.asset_listings[0].entity_type #=> String
resp.items[0].subscribed_listing.owner_project_id #=> String
resp.items[0].subscribed_listing.owner_project_name #=> String
resp.items[0].subscription_request_id #=> String
resp.items[0].retain_permissions #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :subscription_request_identifier (String) —

    The identifier of the subscription request for the subscriptions that you want to list.

  • :status (String) —

    The status of the subscriptions that you want to list.

    This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing for the subscriptions that you want to list.

  • :owning_project_id (String) —

    The identifier of the owning project.

  • :owning_iam_principal_arn (String) —

    The ARN of the owning IAM principal.

  • :owning_user_id (String) —

    The ID of the owning user.

  • :owning_group_id (String) —

    The ID of the owning group.

  • :approver_project_id (String) —

    The identifier of the project for the subscription's approver.

  • :sort_by (String) —

    Specifies the way in which the results of this action are to be sorted.

  • :sort_order (String) —

    Specifies the sort order for the results of this action.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



10834
10835
10836
10837
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10834

def list_subscriptions(params = {}, options = {})
  req = build_request(:list_subscriptions, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists tags for the specified resource in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource whose tags you want to list.

Returns:

See Also:



10863
10864
10865
10866
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10863

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_time_series_data_points(params = {}) ⇒ Types::ListTimeSeriesDataPointsOutput

Lists time series data points.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_time_series_data_points({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  form_name: "TimeSeriesFormName", # required
  started_at: Time.now,
  ended_at: Time.now,
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].form_name #=> String
resp.items[0].type_identifier #=> String
resp.items[0].type_revision #=> String
resp.items[0].timestamp #=> Time
resp.items[0].content_summary #=> String
resp.items[0].id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to list data points.

  • :entity_type (required, String) —

    The type of the asset for which you want to list data points.

  • :form_name (required, String) —

    The name of the time series data points form.

  • :started_at (Time, DateTime, Date, Integer, String) —

    The timestamp at which the data points that you want to list started.

  • :ended_at (Time, DateTime, Date, Integer, String) —

    The timestamp at which the data points that you wanted to list ended.

  • :next_token (String) —

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

  • :max_results (Integer) —

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

Returns:

See Also:



10939
10940
10941
10942
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10939

def list_time_series_data_points(params = {}, options = {})
  req = build_request(:list_time_series_data_points, params)
  req.send_request(options)
end

#post_lineage_event(params = {}) ⇒ Types::PostLineageEventOutput

Posts a data lineage event.

Examples:

Request syntax with placeholder values


resp = client.post_lineage_event({
  domain_identifier: "DomainId", # required
  event: "data", # required
  client_token: "ClientToken",
})

Response structure


resp.id #=> String
resp.domain_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to post a data lineage event.

  • :event (required, String, StringIO, File) —

    The data lineage event that you want to post. Only open-lineage run event are supported as events.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



10982
10983
10984
10985
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10982

def post_lineage_event(params = {}, options = {})
  req = build_request(:post_lineage_event, params)
  req.send_request(options)
end

#post_time_series_data_points(params = {}) ⇒ Types::PostTimeSeriesDataPointsOutput

Posts time series data points to Amazon DataZone for the specified asset.

Examples:

Request syntax with placeholder values


resp = client.post_time_series_data_points({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  forms: [ # required
    {
      form_name: "TimeSeriesFormName", # required
      type_identifier: "FormTypeIdentifier", # required
      type_revision: "Revision",
      timestamp: Time.now, # required
      content: "TimeSeriesDataPointFormInputContentString",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.entity_id #=> String
resp.entity_type #=> String, one of "ASSET", "LISTING"
resp.forms #=> Array
resp.forms[0].form_name #=> String
resp.forms[0].type_identifier #=> String
resp.forms[0].type_revision #=> String
resp.forms[0].timestamp #=> Time
resp.forms[0].content #=> String
resp.forms[0].id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which you want to post time series data points.

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to post time series data points.

  • :entity_type (required, String) —

    The type of the asset for which you want to post data points.

  • :forms (required, Array<Types::TimeSeriesDataPointFormInput>) —

    The forms that contain the data points that you want to post.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



11053
11054
11055
11056
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11053

def post_time_series_data_points(params = {}, options = {})
  req = build_request(:post_time_series_data_points, params)
  req.send_request(options)
end

#put_data_export_configuration(params = {}) ⇒ Struct

Creates data export configuration details.

If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table.

You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps:

  1. Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation.

  2. Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion.

  3. Call the PutDataExportConfiguration API to enable export for the new domain.

Examples:

Request syntax with placeholder values


resp = client.put_data_export_configuration({
  domain_identifier: "DomainId", # required
  enable_export: false, # required
  encryption_configuration: {
    kms_key_arn: "String",
    sse_algorithm: "String",
  },
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The domain ID for which you want to create data export configuration details.

  • :enable_export (required, Boolean) —

    Specifies that the export is to be enabled as part of creating data export configuration details.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    The encryption configuration as part of creating data export configuration details.

    The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11125
11126
11127
11128
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11125

def put_data_export_configuration(params = {}, options = {})
  req = build_request(:put_data_export_configuration, params)
  req.send_request(options)
end

#put_environment_blueprint_configuration(params = {}) ⇒ Types::PutEnvironmentBlueprintConfigurationOutput

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

Examples:

Request syntax with placeholder values


resp = client.put_environment_blueprint_configuration({
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
  provisioning_role_arn: "RoleArn",
  manage_access_role_arn: "RoleArn",
  environment_role_permission_boundary: "PolicyArn",
  enabled_regions: ["RegionName"], # required
  regional_parameters: {
    "RegionName" => {
      "String" => "String",
    },
  },
  global_parameters: {
    "String" => "String",
  },
  provisioning_configurations: [
    {
      lake_formation_configuration: {
        location_registration_role: "RoleArn",
        location_registration_exclude_s3_locations: ["S3Location"],
      },
    },
  ],
})

Response structure


resp.domain_id #=> String
resp.environment_blueprint_id #=> String
resp.provisioning_role_arn #=> String
resp.environment_role_permission_boundary #=> String
resp.manage_access_role_arn #=> String
resp.enabled_regions #=> Array
resp.enabled_regions[0] #=> String
resp.regional_parameters #=> Hash
resp.regional_parameters["RegionName"] #=> Hash
resp.regional_parameters["RegionName"]["String"] #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.provisioning_configurations #=> Array
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_role #=> String
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_exclude_s3_locations #=> Array
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_exclude_s3_locations[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_blueprint_identifier (required, String) —

    The identifier of the environment blueprint.

  • :provisioning_role_arn (String) —

    The ARN of the provisioning role.

  • :manage_access_role_arn (String) —

    The ARN of the manage access role.

  • :environment_role_permission_boundary (String) —

    The environment role permissions boundary.

  • :enabled_regions (required, Array<String>) —

    Specifies the enabled Amazon Web Services Regions.

  • :regional_parameters (Hash<String,Hash>) —

    The regional parameters in the environment blueprint.

  • :global_parameters (Hash<String,String>) —

    Region-agnostic environment blueprint parameters.

  • :provisioning_configurations (Array<Types::ProvisioningConfiguration>) —

    The provisioning configuration of a blueprint.

Returns:

See Also:



11223
11224
11225
11226
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11223

def put_environment_blueprint_configuration(params = {}, options = {})
  req = build_request(:put_environment_blueprint_configuration, params)
  req.send_request(options)
end

#reject_predictions(params = {}) ⇒ Types::RejectPredictionsOutput

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

Examples:

Request syntax with placeholder values


resp = client.reject_predictions({
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  revision: "Revision",
  reject_rule: {
    rule: "ALL", # accepts ALL, NONE
    threshold: 1.0,
  },
  reject_choices: [
    {
      prediction_target: "String", # required
      prediction_choices: [1],
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.asset_id #=> String
resp.asset_revision #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :identifier (required, String) —

    The identifier of the prediction.

  • :revision (String) —

    The revision that is to be made to the asset.

  • :reject_rule (Types::RejectRule) —

    Specifies the rule (or the conditions) under which a prediction can be rejected.

  • :reject_choices (Array<Types::RejectChoice>) —

    Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



11291
11292
11293
11294
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11291

def reject_predictions(params = {}, options = {})
  req = build_request(:reject_predictions, params)
  req.send_request(options)
end

#reject_subscription_request(params = {}) ⇒ Types::RejectSubscriptionRequestOutput

Rejects the specified subscription request.

Examples:

Request syntax with placeholder values


resp = client.reject_subscription_request({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
  decision_comment: "DecisionComment",
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.request_reason #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.subscribed_principals[0].user.id #=> String
resp.subscribed_principals[0].user.details.iam.arn #=> String
resp.subscribed_principals[0].user.details.iam.principal_id #=> String
resp.subscribed_principals[0].user.details.sso.username #=> String
resp.subscribed_principals[0].user.details.sso.first_name #=> String
resp.subscribed_principals[0].user.details.sso.last_name #=> String
resp.subscribed_principals[0].group.id #=> String
resp.subscribed_principals[0].group.name #=> String
resp.subscribed_principals[0].iam.principal_arn #=> String
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_listings[0].name #=> String
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.subscribed_listings[0].item.asset_listing.forms #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.status #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listings[0].item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listings[0].item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listings[0].item.product_listing.entity_id #=> String
resp.subscribed_listings[0].item.product_listing.entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.product_listing.name #=> String
resp.subscribed_listings[0].item.product_listing.description #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings #=> Array
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.reviewer_id #=> String
resp.decision_comment #=> String
resp.existing_subscription_id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.metadata_forms[0].content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which the subscription request was rejected.

  • :identifier (required, String) —

    The identifier of the subscription request that was rejected.

  • :decision_comment (String) —

    The decision comment of the rejected subscription request.

Returns:

See Also:



11400
11401
11402
11403
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11400

def reject_subscription_request(params = {}, options = {})
  req = build_request(:reject_subscription_request, params)
  req.send_request(options)
end

#remove_entity_owner(params = {}) ⇒ Struct

Removes an owner from an entity.

Examples:

Request syntax with placeholder values


resp = client.remove_entity_owner({
  domain_identifier: "DomainId", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  entity_identifier: "String", # required
  owner: { # required
    user: {
      user_identifier: "UserIdentifier", # required
    },
    group: {
      group_identifier: "GroupIdentifier", # required
    },
  },
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to remove an owner from an entity.

  • :entity_type (required, String) —

    The type of the entity from which you want to remove an owner.

  • :entity_identifier (required, String) —

    The ID of the entity from which you want to remove an owner.

  • :owner (required, Types::OwnerProperties) —

    The owner that you want to remove from an entity.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11449
11450
11451
11452
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11449

def remove_entity_owner(params = {}, options = {})
  req = build_request(:remove_entity_owner, params)
  req.send_request(options)
end

#remove_policy_grant(params = {}) ⇒ Struct

Removes a policy grant.

Examples:

Request syntax with placeholder values


resp = client.remove_policy_grant({
  domain_identifier: "DomainId", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE, ASSET_TYPE
  entity_identifier: "String", # required
  policy_type: "CREATE_DOMAIN_UNIT", # required, accepts CREATE_DOMAIN_UNIT, OVERRIDE_DOMAIN_UNIT_OWNERS, ADD_TO_PROJECT_MEMBER_POOL, OVERRIDE_PROJECT_OWNERS, CREATE_GLOSSARY, CREATE_FORM_TYPE, CREATE_ASSET_TYPE, CREATE_PROJECT, CREATE_ENVIRONMENT_PROFILE, DELEGATE_CREATE_ENVIRONMENT_PROFILE, CREATE_ENVIRONMENT, CREATE_ENVIRONMENT_FROM_BLUEPRINT, CREATE_PROJECT_FROM_PROJECT_PROFILE, USE_ASSET_TYPE
  principal: { # required
    user: {
      user_identifier: "UserIdentifier",
      all_users_grant_filter: {
      },
    },
    group: {
      group_identifier: "GroupIdentifier",
    },
    project: {
      project_designation: "OWNER", # required, accepts OWNER, CONTRIBUTOR, PROJECT_CATALOG_STEWARD
      project_identifier: "ProjectId",
      project_grant_filter: {
        domain_unit_filter: {
          domain_unit: "DomainUnitId", # required
          include_child_domain_units: false,
        },
      },
    },
    domain_unit: {
      domain_unit_designation: "OWNER", # required, accepts OWNER
      domain_unit_identifier: "DomainUnitId",
      domain_unit_grant_filter: {
        all_domain_units_grant_filter: {
        },
      },
    },
  },
  grant_identifier: "GrantIdentifier",
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to remove a policy grant.

  • :entity_type (required, String) —

    The type of the entity from which you want to remove a policy grant.

  • :entity_identifier (required, String) —

    The ID of the entity from which you want to remove a policy grant.

  • :policy_type (required, String) —

    The type of the policy that you want to remove.

  • :principal (required, Types::PolicyGrantPrincipal) —

    The principal from which you want to remove a policy grant.

  • :grant_identifier (String) —

    The ID of the policy grant that is to be removed from a specified entity.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



11527
11528
11529
11530
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11527

def remove_policy_grant(params = {}, options = {})
  req = build_request(:remove_policy_grant, params)
  req.send_request(options)
end

#revoke_subscription(params = {}) ⇒ Types::RevokeSubscriptionOutput

Revokes a specified subscription in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.revoke_subscription({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionId", # required
  retain_permissions: false,
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.subscribed_principal.project.id #=> String
resp.subscribed_principal.project.name #=> String
resp.subscribed_principal.user.id #=> String
resp.subscribed_principal.user.details.iam.arn #=> String
resp.subscribed_principal.user.details.iam.principal_id #=> String
resp.subscribed_principal.user.details.sso.username #=> String
resp.subscribed_principal.user.details.sso.first_name #=> String
resp.subscribed_principal.user.details.sso.last_name #=> String
resp.subscribed_principal.group.id #=> String
resp.subscribed_principal.group.name #=> String
resp.subscribed_principal.iam.principal_arn #=> String
resp.subscribed_listing.id #=> String
resp.subscribed_listing.revision #=> String
resp.subscribed_listing.name #=> String
resp.subscribed_listing.description #=> String
resp.subscribed_listing.item.asset_listing.entity_id #=> String
resp.subscribed_listing.item.asset_listing.entity_revision #=> String
resp.subscribed_listing.item.asset_listing.entity_type #=> String
resp.subscribed_listing.item.asset_listing.forms #=> String
resp.subscribed_listing.item.asset_listing.glossary_terms #=> Array
resp.subscribed_listing.item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listing.item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listing.item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.status #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listing.item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listing.item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listing.item.product_listing.entity_id #=> String
resp.subscribed_listing.item.product_listing.entity_revision #=> String
resp.subscribed_listing.item.product_listing.glossary_terms #=> Array
resp.subscribed_listing.item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listing.item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listing.item.product_listing.name #=> String
resp.subscribed_listing.item.product_listing.description #=> String
resp.subscribed_listing.item.product_listing.asset_listings #=> Array
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listing.item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listing.owner_project_id #=> String
resp.subscribed_listing.owner_project_name #=> String
resp.subscription_request_id #=> String
resp.retain_permissions #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain where you want to revoke a subscription.

  • :identifier (required, String) —

    The identifier of the revoked subscription.

  • :retain_permissions (Boolean) —

    Specifies whether permissions are retained when the subscription is revoked.

Returns:

See Also:



11625
11626
11627
11628
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11625

def revoke_subscription(params = {}, options = {})
  req = build_request(:revoke_subscription, params)
  req.send_request(options)
end

#search(params = {}) ⇒ Types::SearchOutput

Searches for assets in Amazon DataZone.

Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.

Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results.

Prerequisites:

  • The --domain-identifier must refer to an existing Amazon DataZone domain.

  • --search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.

  • The user must have search permissions in the specified domain.

  • If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys.

  • For paginated results, be prepared to use --next-token to fetch additional pages.

To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.

To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries.

To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search({
  domain_identifier: "DomainId", # required
  owning_project_identifier: "ProjectId",
  max_results: 1,
  next_token: "PaginationToken",
  search_scope: "ASSET", # required, accepts ASSET, GLOSSARY, GLOSSARY_TERM, DATA_PRODUCT
  search_text: "SearchText",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  filters: {
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString",
      int_value: 1,
      operator: "EQ", # accepts EQ, LE, LT, GE, GT, TEXT_SEARCH
    },
    and: [
      {
        # recursive FilterClause
      },
    ],
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS, TEXT_MATCH_RATIONALE
})

Response structure


resp.items #=> Array
resp.items[0].glossary_item.domain_id #=> String
resp.items[0].glossary_item.id #=> String
resp.items[0].glossary_item.name #=> String
resp.items[0].glossary_item.owning_project_id #=> String
resp.items[0].glossary_item.description #=> String
resp.items[0].glossary_item.status #=> String, one of "DISABLED", "ENABLED"
resp.items[0].glossary_item.usage_restrictions #=> Array
resp.items[0].glossary_item.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"
resp.items[0].glossary_item.created_at #=> Time
resp.items[0].glossary_item.created_by #=> String
resp.items[0].glossary_item.updated_at #=> Time
resp.items[0].glossary_item.updated_by #=> String
resp.items[0].glossary_item.additional_attributes.match_rationale #=> Array
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches #=> Array
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches[0].attribute #=> String
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches[0].text #=> String
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets #=> Array
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].start_offset #=> Integer
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
resp.items[0].glossary_term_item.domain_id #=> String
resp.items[0].glossary_term_item.glossary_id #=> String
resp.items[0].glossary_term_item.id #=> String
resp.items[0].glossary_term_item.name #=> String
resp.items[0].glossary_term_item.short_description #=> String
resp.items[0].glossary_term_item.usage_restrictions #=> Array
resp.items[0].glossary_term_item.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"
resp.items[0].glossary_term_item.long_description #=> String
resp.items[0].glossary_term_item.term_relations.is_a #=> Array
resp.items[0].glossary_term_item.term_relations.is_a[0] #=> String
resp.items[0].glossary_term_item.term_relations.classifies #=> Array
resp.items[0].glossary_term_item.term_relations.classifies[0] #=> String
resp.items[0].glossary_term_item.status #=> String, one of "ENABLED", "DISABLED"
resp.items[0].glossary_term_item.created_at #=> Time
resp.items[0].glossary_term_item.created_by #=> String
resp.items[0].glossary_term_item.updated_at #=> Time
resp.items[0].glossary_term_item.updated_by #=> String
resp.items[0].glossary_term_item.additional_attributes.match_rationale #=> Array
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches #=> Array
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches[0].attribute #=> String
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches[0].text #=> String
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets #=> Array
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].start_offset #=> Integer
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
resp.items[0].asset_item.domain_id #=> String
resp.items[0].asset_item.identifier #=> String
resp.items[0].asset_item.name #=> String
resp.items[0].asset_item.type_identifier #=> String
resp.items[0].asset_item.type_revision #=> String
resp.items[0].asset_item.external_identifier #=> String
resp.items[0].asset_item.description #=> String
resp.items[0].asset_item.created_at #=> Time
resp.items[0].asset_item.created_by #=> String
resp.items[0].asset_item.first_revision_created_at #=> Time
resp.items[0].asset_item.first_revision_created_by #=> String
resp.items[0].asset_item.glossary_terms #=> Array
resp.items[0].asset_item.glossary_terms[0] #=> String
resp.items[0].asset_item.owning_project_id #=> String
resp.items[0].asset_item.additional_attributes.forms_output #=> Array
resp.items[0].asset_item.additional_attributes.forms_output[0].form_name #=> String
resp.items[0].asset_item.additional_attributes.forms_output[0].type_name #=> String
resp.items[0].asset_item.additional_attributes.forms_output[0].type_revision #=> String
resp.items[0].asset_item.additional_attributes.forms_output[0].content #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output #=> Array
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].form_name #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].type_name #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].type_revision #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].content #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output #=> Array
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].form_name #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].type_identifier #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].type_revision #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].timestamp #=> Time
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].content_summary #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].id #=> String
resp.items[0].asset_item.additional_attributes.match_rationale #=> Array
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches #=> Array
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches[0].attribute #=> String
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches[0].text #=> String
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets #=> Array
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].start_offset #=> Integer
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
resp.items[0].asset_item.governed_glossary_terms #=> Array
resp.items[0].asset_item.governed_glossary_terms[0] #=> String
resp.items[0].data_product_item.domain_id #=> String
resp.items[0].data_product_item.id #=> String
resp.items[0].data_product_item.name #=> String
resp.items[0].data_product_item.owning_project_id #=> String
resp.items[0].data_product_item.description #=> String
resp.items[0].data_product_item.glossary_terms #=> Array
resp.items[0].data_product_item.glossary_terms[0] #=> String
resp.items[0].data_product_item.created_at #=> Time
resp.items[0].data_product_item.created_by #=> String
resp.items[0].data_product_item.first_revision_created_at #=> Time
resp.items[0].data_product_item.first_revision_created_by #=> String
resp.items[0].data_product_item.additional_attributes.match_rationale #=> Array
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches #=> Array
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches[0].attribute #=> String
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches[0].text #=> String
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets #=> Array
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].start_offset #=> Integer
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :owning_project_identifier (String) —

    The identifier of the owning project specified for the search.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :search_scope (required, String) —

    The scope of the search.

  • :search_text (String) —

    Specifies the text for which to search.

  • :search_in (Array<Types::SearchInItem>) —

    The details of the search.

  • :filters (Types::FilterClause) —

    Specifies the search filters.

  • :sort (Types::SearchSort) —

    Specifies the way in which the search results are to be sorted.

  • :additional_attributes (Array<String>) —

    Specifies additional attributes for the Search action.

Returns:

See Also:



11893
11894
11895
11896
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11893

def search(params = {}, options = {})
  req = build_request(:search, params)
  req.send_request(options)
end

#search_group_profiles(params = {}) ⇒ Types::SearchGroupProfilesOutput

Searches group profiles in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_group_profiles({
  domain_identifier: "DomainId", # required
  group_type: "SSO_GROUP", # required, accepts SSO_GROUP, DATAZONE_SSO_GROUP
  search_text: "GroupSearchText",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"
resp.items[0].group_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which you want to search group profiles.

  • :group_type (required, String) —

    The group type for which to search.

  • :search_text (String) —

    Specifies the text for which to search.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



11955
11956
11957
11958
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11955

def search_group_profiles(params = {}, options = {})
  req = build_request(:search_group_profiles, params)
  req.send_request(options)
end

#search_listings(params = {}) ⇒ Types::SearchListingsOutput

Searches listings in Amazon DataZone.

SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.

SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.

The SearchListings API gives users flexibility in specifying what kind of search is run.

To run a standard free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.

To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with @amazon.datazone#sortable), provide a filter using the intValue parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with @amazon.datazone#searchable for free-text search). Create/update timestamp filtering is supported using the special creationTime/lastUpdatedTime attributes. Filter types can be mixed and matched to power complex queries.

To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_listings({
  domain_identifier: "DomainId", # required
  search_text: "SearchListingsInputSearchTextString",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  max_results: 1,
  next_token: "PaginationToken",
  filters: {
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString",
      int_value: 1,
      operator: "EQ", # accepts EQ, LE, LT, GE, GT, TEXT_SEARCH
    },
    and: [
      {
        # recursive FilterClause
      },
    ],
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  aggregations: [
    {
      attribute: "Attribute", # required
      display_value: "AggregationDisplayValue",
    },
  ],
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS, TEXT_MATCH_RATIONALE
})

Response structure


resp.items #=> Array
resp.items[0].asset_listing.listing_id #=> String
resp.items[0].asset_listing.listing_revision #=> String
resp.items[0].asset_listing.name #=> String
resp.items[0].asset_listing.entity_id #=> String
resp.items[0].asset_listing.entity_revision #=> String
resp.items[0].asset_listing.entity_type #=> String
resp.items[0].asset_listing.description #=> String
resp.items[0].asset_listing.created_at #=> Time
resp.items[0].asset_listing.listing_created_by #=> String
resp.items[0].asset_listing.listing_updated_by #=> String
resp.items[0].asset_listing.glossary_terms #=> Array
resp.items[0].asset_listing.glossary_terms[0].name #=> String
resp.items[0].asset_listing.glossary_terms[0].short_description #=> String
resp.items[0].asset_listing.governed_glossary_terms #=> Array
resp.items[0].asset_listing.governed_glossary_terms[0].name #=> String
resp.items[0].asset_listing.governed_glossary_terms[0].short_description #=> String
resp.items[0].asset_listing.owning_project_id #=> String
resp.items[0].asset_listing.additional_attributes.forms #=> String
resp.items[0].asset_listing.additional_attributes.match_rationale #=> Array
resp.items[0].asset_listing.additional_attributes.match_rationale[0].text_matches #=> Array
resp.items[0].asset_listing.additional_attributes.match_rationale[0].text_matches[0].attribute #=> String
resp.items[0].asset_listing.additional_attributes.match_rationale[0].text_matches[0].text #=> String
resp.items[0].asset_listing.additional_attributes.match_rationale[0].text_matches[0].match_offsets #=> Array
resp.items[0].asset_listing.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].start_offset #=> Integer
resp.items[0].asset_listing.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms #=> Array
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].form_name #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].type_identifier #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].type_revision #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].timestamp #=> Time
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].content_summary #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].id #=> String
resp.items[0].data_product_listing.listing_id #=> String
resp.items[0].data_product_listing.listing_revision #=> String
resp.items[0].data_product_listing.name #=> String
resp.items[0].data_product_listing.entity_id #=> String
resp.items[0].data_product_listing.entity_revision #=> String
resp.items[0].data_product_listing.description #=> String
resp.items[0].data_product_listing.created_at #=> Time
resp.items[0].data_product_listing.listing_created_by #=> String
resp.items[0].data_product_listing.listing_updated_by #=> String
resp.items[0].data_product_listing.glossary_terms #=> Array
resp.items[0].data_product_listing.glossary_terms[0].name #=> String
resp.items[0].data_product_listing.glossary_terms[0].short_description #=> String
resp.items[0].data_product_listing.owning_project_id #=> String
resp.items[0].data_product_listing.additional_attributes.forms #=> String
resp.items[0].data_product_listing.additional_attributes.match_rationale #=> Array
resp.items[0].data_product_listing.additional_attributes.match_rationale[0].text_matches #=> Array
resp.items[0].data_product_listing.additional_attributes.match_rationale[0].text_matches[0].attribute #=> String
resp.items[0].data_product_listing.additional_attributes.match_rationale[0].text_matches[0].text #=> String
resp.items[0].data_product_listing.additional_attributes.match_rationale[0].text_matches[0].match_offsets #=> Array
resp.items[0].data_product_listing.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].start_offset #=> Integer
resp.items[0].data_product_listing.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
resp.items[0].data_product_listing.items #=> Array
resp.items[0].data_product_listing.items[0].listing_id #=> String
resp.items[0].data_product_listing.items[0].listing_revision #=> String
resp.items[0].data_product_listing.items[0].glossary_terms #=> Array
resp.items[0].data_product_listing.items[0].glossary_terms[0].name #=> String
resp.items[0].data_product_listing.items[0].glossary_terms[0].short_description #=> String
resp.next_token #=> String
resp.total_match_count #=> Integer
resp.aggregates #=> Array
resp.aggregates[0].attribute #=> String
resp.aggregates[0].display_value #=> String
resp.aggregates[0].items #=> Array
resp.aggregates[0].items[0].value #=> String
resp.aggregates[0].items[0].count #=> Integer
resp.aggregates[0].items[0].display_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain in which to search listings.

  • :search_text (String) —

    Specifies the text for which to search.

  • :search_in (Array<Types::SearchInItem>) —

    The details of the search.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :filters (Types::FilterClause) —

    Specifies the filters for the search of listings.

  • :aggregations (Array<Types::AggregationListItem>) —

    Enables you to specify one or more attributes to compute and return counts grouped by field values.

  • :sort (Types::SearchSort) —

    Specifies the way for sorting the search results.

  • :additional_attributes (Array<String>) —

    Specifies additional attributes for the search.

Returns:

See Also:



12176
12177
12178
12179
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12176

def search_listings(params = {}, options = {})
  req = build_request(:search_listings, params)
  req.send_request(options)
end

#search_types(params = {}) ⇒ Types::SearchTypesOutput

Searches for types in Amazon DataZone.

Prerequisites:

  • The --domain-identifier must refer to an existing Amazon DataZone domain.

  • --search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.

  • The --managed flag must be present without a value.

  • The user must have permissions for form or asset types in the domain.

  • If using --filters, ensure that the JSON is valid.

  • Filters contain correct structure (attribute, value, operator).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_types({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  search_scope: "ASSET_TYPE", # required, accepts ASSET_TYPE, FORM_TYPE, LINEAGE_NODE_TYPE
  search_text: "SearchText",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  filters: {
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString",
      int_value: 1,
      operator: "EQ", # accepts EQ, LE, LT, GE, GT, TEXT_SEARCH
    },
    and: [
      {
        # recursive FilterClause
      },
    ],
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  managed: false, # required
})

Response structure


resp.items #=> Array
resp.items[0].asset_type_item.domain_id #=> String
resp.items[0].asset_type_item.name #=> String
resp.items[0].asset_type_item.revision #=> String
resp.items[0].asset_type_item.description #=> String
resp.items[0].asset_type_item.forms_output #=> Hash
resp.items[0].asset_type_item.forms_output["FormName"].type_name #=> String
resp.items[0].asset_type_item.forms_output["FormName"].type_revision #=> String
resp.items[0].asset_type_item.forms_output["FormName"].required #=> Boolean
resp.items[0].asset_type_item.owning_project_id #=> String
resp.items[0].asset_type_item.origin_domain_id #=> String
resp.items[0].asset_type_item.origin_project_id #=> String
resp.items[0].asset_type_item.created_at #=> Time
resp.items[0].asset_type_item.created_by #=> String
resp.items[0].asset_type_item.updated_at #=> Time
resp.items[0].asset_type_item.updated_by #=> String
resp.items[0].form_type_item.domain_id #=> String
resp.items[0].form_type_item.name #=> String
resp.items[0].form_type_item.revision #=> String
resp.items[0].form_type_item.model.smithy #=> String
resp.items[0].form_type_item.status #=> String, one of "ENABLED", "DISABLED"
resp.items[0].form_type_item.owning_project_id #=> String
resp.items[0].form_type_item.origin_domain_id #=> String
resp.items[0].form_type_item.origin_project_id #=> String
resp.items[0].form_type_item.created_at #=> Time
resp.items[0].form_type_item.created_by #=> String
resp.items[0].form_type_item.description #=> String
resp.items[0].form_type_item.imports #=> Array
resp.items[0].form_type_item.imports[0].name #=> String
resp.items[0].form_type_item.imports[0].revision #=> String
resp.items[0].lineage_node_type_item.domain_id #=> String
resp.items[0].lineage_node_type_item.name #=> String
resp.items[0].lineage_node_type_item.description #=> String
resp.items[0].lineage_node_type_item.created_at #=> Time
resp.items[0].lineage_node_type_item.created_by #=> String
resp.items[0].lineage_node_type_item.updated_at #=> Time
resp.items[0].lineage_node_type_item.updated_by #=> String
resp.items[0].lineage_node_type_item.revision #=> String
resp.items[0].lineage_node_type_item.forms_output #=> Hash
resp.items[0].lineage_node_type_item.forms_output["FormName"].type_name #=> String
resp.items[0].lineage_node_type_item.forms_output["FormName"].type_revision #=> String
resp.items[0].lineage_node_type_item.forms_output["FormName"].required #=> Boolean
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

  • :search_scope (required, String) —

    Specifies the scope of the search for types.

  • :search_text (String) —

    Specifies the text for which to search.

  • :search_in (Array<Types::SearchInItem>) —

    The details of the search.

  • :filters (Types::FilterClause) —

    The filters for the SearchTypes action.

  • :sort (Types::SearchSort) —

    The specifies the way to sort the SearchTypes results.

  • :managed (required, Boolean) —

    Specifies whether the search is managed.

Returns:

See Also:



12334
12335
12336
12337
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12334

def search_types(params = {}, options = {})
  req = build_request(:search_types, params)
  req.send_request(options)
end

#search_user_profiles(params = {}) ⇒ Types::SearchUserProfilesOutput

Searches user profiles in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_user_profiles({
  domain_identifier: "DomainId", # required
  user_type: "SSO_USER", # required, accepts SSO_USER, DATAZONE_USER, DATAZONE_SSO_USER, DATAZONE_IAM_USER
  search_text: "UserSearchText",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].type #=> String, one of "IAM", "SSO"
resp.items[0].status #=> String, one of "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED"
resp.items[0].details.iam.arn #=> String
resp.items[0].details.iam.principal_id #=> String
resp.items[0].details.sso.username #=> String
resp.items[0].details.sso.first_name #=> String
resp.items[0].details.sso.last_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which you want to search user profiles.

  • :user_type (required, String) —

    Specifies the user type for the SearchUserProfiles action.

  • :search_text (String) —

    Specifies the text for which to search.

  • :max_results (Integer) —

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

  • :next_token (String) —

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

Returns:

See Also:



12401
12402
12403
12404
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12401

def search_user_profiles(params = {}, options = {})
  req = build_request(:search_user_profiles, params)
  req.send_request(options)
end

#start_data_source_run(params = {}) ⇒ Types::StartDataSourceRunOutput

Start the run of the specified data source in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.start_data_source_run({
  domain_identifier: "DomainId", # required
  data_source_identifier: "DataSourceId", # required
  client_token: "String",
})

Response structure


resp.domain_id #=> String
resp.data_source_id #=> String
resp.id #=> String
resp.project_id #=> String
resp.status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.data_source_configuration_snapshot #=> String
resp.run_statistics_for_assets.added #=> Integer
resp.run_statistics_for_assets.updated #=> Integer
resp.run_statistics_for_assets.unchanged #=> Integer
resp.run_statistics_for_assets.skipped #=> Integer
resp.run_statistics_for_assets.failed #=> Integer
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.error_message.error_detail #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.started_at #=> Time
resp.stopped_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to start a data source run.

  • :data_source_identifier (required, String) —

    The identifier of the data source.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



12471
12472
12473
12474
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12471

def start_data_source_run(params = {}, options = {})
  req = build_request(:start_data_source_run, params)
  req.send_request(options)
end

#start_metadata_generation_run(params = {}) ⇒ Types::StartMetadataGenerationRunOutput

Starts the metadata generation run.

Prerequisites:

  • Asset must be created and belong to the specified domain and project.

  • Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).

  • Asset must have a structured schema with valid rows and columns.

  • Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.

  • The user must have permission to run metadata generation in the domain/project.

Examples:

Request syntax with placeholder values


resp = client.start_metadata_generation_run({
  domain_identifier: "DomainId", # required
  type: "BUSINESS_DESCRIPTIONS", # accepts BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS
  types: ["BUSINESS_DESCRIPTIONS"], # accepts BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS
  target: { # required
    type: "ASSET", # required, accepts ASSET
    identifier: "String", # required
    revision: "Revision",
  },
  client_token: "ClientToken",
  owning_project_identifier: "ProjectId", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED", "PARTIALLY_SUCCEEDED"
resp.type #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.types #=> Array
resp.types[0] #=> String, one of "BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"
resp.created_at #=> Time
resp.created_by #=> String
resp.owning_project_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where you want to start a metadata generation run.

  • :type (String) —

    The type of the metadata generation run.

  • :types (Array<String>) —

    The types of the metadata generation run.

  • :target (required, Types::MetadataGenerationRunTarget) —

    The asset for which you want to start a metadata generation run.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :owning_project_identifier (required, String) —

    The ID of the project that owns the asset for which you want to start a metadata generation run.

Returns:

See Also:



12560
12561
12562
12563
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12560

def start_metadata_generation_run(params = {}, options = {})
  req = build_request(:start_metadata_generation_run, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags a resource in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be tagged in Amazon DataZone.

  • :tags (required, Hash<String,String>) —

    Specifies the tags for the TagResource action.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12588
12589
12590
12591
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12588

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Untags a resource in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be untagged in Amazon DataZone.

  • :tag_keys (required, Array<String>) —

    Specifies the tag keys for the UntagResource action.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



12614
12615
12616
12617
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12614

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_account_pool(params = {}) ⇒ Types::UpdateAccountPoolOutput

Updates the account pool.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  identifier: "AccountPoolId", # required
  name: "AccountPoolName",
  description: "Description",
  resolution_strategy: "MANUAL", # accepts MANUAL
  account_source: {
    accounts: [
      {
        aws_account_id: "AwsAccountId", # required
        supported_regions: ["AwsRegion"], # required
        aws_account_name: "AwsAccountName",
      },
    ],
    custom_account_pool_handler: {
      lambda_function_arn: "LambdaFunctionArn", # required
      lambda_execution_role_arn: "LambdaExecutionRoleArn",
    },
  },
})

Response structure


resp.domain_id #=> String
resp.name #=> String
resp.id #=> String
resp.description #=> String
resp.resolution_strategy #=> String, one of "MANUAL"
resp..accounts #=> Array
resp..accounts[0]. #=> String
resp..accounts[0].supported_regions #=> Array
resp..accounts[0].supported_regions[0] #=> String
resp..accounts[0]. #=> String
resp...lambda_function_arn #=> String
resp...lambda_execution_role_arn #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.updated_by #=> String
resp.domain_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The domain ID where the account pool that is to be updated lives.

  • :identifier (required, String) —

    The ID of the account pool that is to be updated.

  • :name (String) —

    The name of the account pool that is to be updated.

  • :description (String) —

    The description of the account pool that is to be udpated.

  • :resolution_strategy (String) —

    The mechanism used to resolve the account selection from the account pool.

  • :account_source (Types::AccountSource) —

    The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.

Returns:

See Also:



12703
12704
12705
12706
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12703

def (params = {}, options = {})
  req = build_request(:update_account_pool, params)
  req.send_request(options)
end

#update_asset_filter(params = {}) ⇒ Types::UpdateAssetFilterOutput

Updates an asset filter.

Prerequisites:

  • The domain, asset, and asset filter identifier must all exist.

  • The asset must contain the columns being referenced in the update.

  • If applying a row filter, ensure the column referenced in the expression exists in the asset schema.

Examples:

Request syntax with placeholder values


resp = client.update_asset_filter({
  domain_identifier: "DomainId", # required
  asset_identifier: "AssetId", # required
  identifier: "FilterId", # required
  name: "String",
  description: "Description",
  configuration: {
    column_configuration: {
      included_column_names: ["String"],
    },
    row_configuration: {
      row_filter: { # required
        expression: {
          equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          not_equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          greater_than: {
            column_name: "String", # required
            value: "String", # required
          },
          less_than: {
            column_name: "String", # required
            value: "String", # required
          },
          greater_than_or_equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          less_than_or_equal_to: {
            column_name: "String", # required
            value: "String", # required
          },
          is_null: {
            column_name: "String", # required
          },
          is_not_null: {
            column_name: "String", # required
          },
          in: {
            column_name: "String", # required
            values: ["String"], # required
          },
          not_in: {
            column_name: "String", # required
            values: ["String"], # required
          },
          like: {
            column_name: "String", # required
            value: "String", # required
          },
          not_like: {
            column_name: "String", # required
            value: "String", # required
          },
        },
        and: [
          {
            # recursive RowFilter
          },
        ],
        or: [
          {
            # recursive RowFilter
          },
        ],
      },
      sensitive: false,
    },
  },
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.asset_id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "VALID", "INVALID"
resp.configuration.column_configuration.included_column_names #=> Array
resp.configuration.column_configuration.included_column_names[0] #=> String
resp.configuration.row_configuration.row_filter.expression.equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.not_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than.value #=> String
resp.configuration.row_configuration.row_filter.expression.less_than.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.less_than.value #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than_or_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.greater_than_or_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.less_than_or_equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.less_than_or_equal_to.value #=> String
resp.configuration.row_configuration.row_filter.expression.is_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.is_not_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.in.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.in.values #=> Array
resp.configuration.row_configuration.row_filter.expression.in.values[0] #=> String
resp.configuration.row_configuration.row_filter.expression.not_in.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_in.values #=> Array
resp.configuration.row_configuration.row_filter.expression.not_in.values[0] #=> String
resp.configuration.row_configuration.row_filter.expression.like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.like.value #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.value #=> String
resp.configuration.row_configuration.row_filter.and #=> Array
resp.configuration.row_configuration.row_filter.and[0] #=> Types::RowFilter
resp.configuration.row_configuration.row_filter.or #=> Array
resp.configuration.row_configuration.row_filter.or[0] #=> Types::RowFilter
resp.configuration.row_configuration.sensitive #=> Boolean
resp.created_at #=> Time
resp.error_message #=> String
resp.effective_column_names #=> Array
resp.effective_column_names[0] #=> String
resp.effective_row_filter #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :identifier (required, String) —

    The ID of the asset filter.

  • :name (String) —

    The name of the asset filter.

  • :description (String) —

    The description of the asset filter.

  • :configuration (Types::AssetFilterConfiguration) —

    The configuration of the asset filter.

Returns:

See Also:



12878
12879
12880
12881
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12878

def update_asset_filter(params = {}, options = {})
  req = build_request(:update_asset_filter, params)
  req.send_request(options)
end

#update_connection(params = {}) ⇒ Types::UpdateConnectionOutput

Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Examples:

Request syntax with placeholder values


resp = client.update_connection({
  domain_identifier: "DomainId", # required
  identifier: "ConnectionId", # required
  description: "UpdateConnectionInputDescriptionString",
  aws_location: {
    access_role: "AwsLocationAccessRoleString",
    aws_account_id: "AwsAccountId",
    aws_region: "AwsRegion",
    iam_connection_id: "ConnectionId",
  },
  props: {
    athena_properties: {
      workgroup_name: "AthenaPropertiesPatchWorkgroupNameString",
    },
    glue_properties: {
      glue_connection_input: {
        description: "String",
        connection_properties: {
          "String" => "ConnectionPropertiesValueString",
        },
        authentication_configuration: {
          secret_arn: "AuthenticationConfigurationPatchSecretArnString",
          basic_authentication_credentials: {
            user_name: "BasicAuthenticationCredentialsUserNameString",
            password: "BasicAuthenticationCredentialsPasswordString",
          },
        },
      },
    },
    iam_properties: {
      glue_lineage_sync_enabled: false,
    },
    redshift_properties: {
      storage: {
        cluster_name: "RedshiftStoragePropertiesClusterNameString",
        workgroup_name: "RedshiftStoragePropertiesWorkgroupNameString",
      },
      database_name: "RedshiftPropertiesPatchDatabaseNameString",
      host: "RedshiftPropertiesPatchHostString",
      port: 1,
      credentials: {
        secret_arn: "RedshiftCredentialsSecretArnString",
        username_password: {
          password: "Password", # required
          username: "Username", # required
        },
      },
      lineage_sync: {
        enabled: false,
        schedule: {
          schedule: "LineageSyncScheduleScheduleString",
        },
      },
    },
    spark_emr_properties: {
      compute_arn: "SparkEmrPropertiesPatchComputeArnString",
      instance_profile_arn: "SparkEmrPropertiesPatchInstanceProfileArnString",
      java_virtual_env: "SparkEmrPropertiesPatchJavaVirtualEnvString",
      log_uri: "SparkEmrPropertiesPatchLogUriString",
      python_virtual_env: "SparkEmrPropertiesPatchPythonVirtualEnvString",
      runtime_role: "SparkEmrPropertiesPatchRuntimeRoleString",
      trusted_certificates_s3_uri: "SparkEmrPropertiesPatchTrustedCertificatesS3UriString",
      managed_endpoint_arn: "SparkEmrPropertiesPatchManagedEndpointArnString",
    },
    s3_properties: {
      s3_uri: "S3Uri", # required
      s3_access_grant_location_id: "S3AccessGrantLocationId",
    },
    amazon_q_properties: {
      is_enabled: false, # required
      profile_arn: "AmazonQPropertiesPatchProfileArnString",
      auth_mode: "AmazonQPropertiesPatchAuthModeString",
    },
    mlflow_properties: {
      tracking_server_arn: "String",
    },
  },
})

Response structure


resp.connection_id #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.environment_id #=> String
resp.name #=> String
resp.physical_endpoints #=> Array
resp.physical_endpoints[0].aws_location.access_role #=> String
resp.physical_endpoints[0].aws_location. #=> String
resp.physical_endpoints[0].aws_location.aws_region #=> String
resp.physical_endpoints[0].aws_location.iam_connection_id #=> String
resp.physical_endpoints[0].glue_connection_name #=> String
resp.physical_endpoints[0].glue_connection.name #=> String
resp.physical_endpoints[0].glue_connection.description #=> String
resp.physical_endpoints[0].glue_connection.connection_type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.physical_endpoints[0].glue_connection.match_criteria #=> Array
resp.physical_endpoints[0].glue_connection.match_criteria[0] #=> String
resp.physical_endpoints[0].glue_connection.connection_properties #=> Hash
resp.physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.physical_endpoints[0].glue_connection.spark_properties #=> Hash
resp.physical_endpoints[0].glue_connection.spark_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.athena_properties #=> Hash
resp.physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.python_properties #=> Hash
resp.physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list #=> Array
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.subnet_id_list[0] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list #=> Array
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.security_group_id_list[0] #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> String
resp.physical_endpoints[0].glue_connection.creation_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.physical_endpoints[0].glue_connection.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.physical_endpoints[0].glue_connection.status_reason #=> String
resp.physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
resp.physical_endpoints[0].glue_connection.authentication_configuration.secret_arn #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_grant_type #=> String, one of "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "JWT_BEARER"
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.user_managed_client_application_client_id #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_client_application.a_ws_managed_client_application_reference #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map #=> Hash
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.token_url_parameters_map["TokenUrlParametersMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.authorization_code #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.authorization_code_properties.redirect_uri #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.user_managed_client_application_client_secret #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.access_token #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.refresh_token #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.o_auth_2_properties.o_auth_2_credentials.jwt_token #=> String
resp.physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
resp.physical_endpoints[0].glue_connection.compatible_compute_environments #=> Array
resp.physical_endpoints[0].glue_connection.compatible_compute_environments[0] #=> String, one of "SPARK", "ATHENA", "PYTHON"
resp.physical_endpoints[0].enable_trusted_identity_propagation #=> Boolean
resp.physical_endpoints[0].host #=> String
resp.physical_endpoints[0].port #=> Integer
resp.physical_endpoints[0].protocol #=> String, one of "ATHENA", "GLUE_INTERACTIVE_SESSION", "HTTPS", "JDBC", "LIVY", "ODBC", "PRISM"
resp.physical_endpoints[0].stage #=> String
resp.project_id #=> String
resp.props.athena_properties.workgroup_name #=> String
resp.props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.glue_properties.error_message #=> String
resp.props.hyper_pod_properties.cluster_name #=> String
resp.props.hyper_pod_properties.cluster_arn #=> String
resp.props.hyper_pod_properties.orchestrator #=> String, one of "EKS", "SLURM"
resp.props.iam_properties.environment_id #=> String
resp.props.iam_properties.glue_lineage_sync_enabled #=> Boolean
resp.props.redshift_properties.storage.cluster_name #=> String
resp.props.redshift_properties.storage.workgroup_name #=> String
resp.props.redshift_properties.credentials.secret_arn #=> String
resp.props.redshift_properties.credentials.username_password.password #=> String
resp.props.redshift_properties.credentials.username_password.username #=> String
resp.props.redshift_properties.is_provisioned_secret #=> Boolean
resp.props.redshift_properties.jdbc_iam_url #=> String
resp.props.redshift_properties.jdbc_url #=> String
resp.props.redshift_properties.redshift_temp_dir #=> String
resp.props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.props.redshift_properties.lineage_sync.enabled #=> Boolean
resp.props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.redshift_properties.database_name #=> String
resp.props.spark_emr_properties.compute_arn #=> String
resp.props.spark_emr_properties.credentials.password #=> String
resp.props.spark_emr_properties.credentials.username #=> String
resp.props.spark_emr_properties.credentials_expiration #=> Time
resp.props.spark_emr_properties.governance_type #=> String, one of "AWS_MANAGED", "USER_MANAGED"
resp.props.spark_emr_properties.instance_profile_arn #=> String
resp.props.spark_emr_properties.java_virtual_env #=> String
resp.props.spark_emr_properties.livy_endpoint #=> String
resp.props.spark_emr_properties.log_uri #=> String
resp.props.spark_emr_properties.python_virtual_env #=> String
resp.props.spark_emr_properties.runtime_role #=> String
resp.props.spark_emr_properties.trusted_certificates_s3_uri #=> String
resp.props.spark_emr_properties.certificate_data #=> String
resp.props.spark_emr_properties.managed_endpoint_arn #=> String
resp.props.spark_emr_properties.managed_endpoint_credentials.id #=> String
resp.props.spark_emr_properties.managed_endpoint_credentials.token #=> String
resp.props.spark_glue_properties.additional_args.connection #=> String
resp.props.spark_glue_properties.glue_connection_name #=> String
resp.props.spark_glue_properties.glue_version #=> String
resp.props.spark_glue_properties.idle_timeout #=> Integer
resp.props.spark_glue_properties.java_virtual_env #=> String
resp.props.spark_glue_properties.number_of_workers #=> Integer
resp.props.spark_glue_properties.python_virtual_env #=> String
resp.props.spark_glue_properties.worker_type #=> String
resp.props.s3_properties.s3_uri #=> String
resp.props.s3_properties.s3_access_grant_location_id #=> String
resp.props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.s3_properties.error_message #=> String
resp.props.amazon_q_properties.is_enabled #=> Boolean
resp.props.amazon_q_properties.profile_arn #=> String
resp.props.amazon_q_properties.auth_mode #=> String
resp.props.mlflow_properties.tracking_server_arn #=> String
resp.type #=> String, one of "ATHENA", "BIGQUERY", "DATABRICKS", "DOCUMENTDB", "DYNAMODB", "HYPERPOD", "IAM", "MYSQL", "OPENSEARCH", "ORACLE", "POSTGRESQL", "REDSHIFT", "S3", "SAPHANA", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "VERTICA", "WORKFLOWS_MWAA", "AMAZON_Q", "MLFLOW"
resp.scope #=> String, one of "DOMAIN", "PROJECT"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where a connection is to be updated.

  • :identifier (required, String) —

    The ID of the connection to be updated.

  • :description (String) —

    The description of a connection.

  • :aws_location (Types::AwsLocation) —

    The location where a connection is to be updated.

  • :props (Types::ConnectionPropertiesPatch) —

    The connection props.

Returns:

See Also:



13120
13121
13122
13123
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13120

def update_connection(params = {}, options = {})
  req = build_request(:update_connection, params)
  req.send_request(options)
end

#update_data_source(params = {}) ⇒ Types::UpdateDataSourceOutput

Updates the specified data source in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_data_source({
  domain_identifier: "DomainId", # required
  identifier: "DataSourceId", # required
  name: "Name",
  description: "Description",
  enable_setting: "ENABLED", # accepts ENABLED, DISABLED
  publish_on_import: false,
  asset_forms_input: [
    {
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
      content: "FormInputContentString",
    },
  ],
  schedule: {
    timezone: "UTC", # accepts UTC, AFRICA_JOHANNESBURG, AMERICA_MONTREAL, AMERICA_SAO_PAULO, ASIA_BAHRAIN, ASIA_BANGKOK, ASIA_CALCUTTA, ASIA_DUBAI, ASIA_HONG_KONG, ASIA_JAKARTA, ASIA_KUALA_LUMPUR, ASIA_SEOUL, ASIA_SHANGHAI, ASIA_SINGAPORE, ASIA_TAIPEI, ASIA_TOKYO, AUSTRALIA_MELBOURNE, AUSTRALIA_SYDNEY, CANADA_CENTRAL, CET, CST6CDT, ETC_GMT, ETC_GMT0, ETC_GMT_ADD_0, ETC_GMT_ADD_1, ETC_GMT_ADD_10, ETC_GMT_ADD_11, ETC_GMT_ADD_12, ETC_GMT_ADD_2, ETC_GMT_ADD_3, ETC_GMT_ADD_4, ETC_GMT_ADD_5, ETC_GMT_ADD_6, ETC_GMT_ADD_7, ETC_GMT_ADD_8, ETC_GMT_ADD_9, ETC_GMT_NEG_0, ETC_GMT_NEG_1, ETC_GMT_NEG_10, ETC_GMT_NEG_11, ETC_GMT_NEG_12, ETC_GMT_NEG_13, ETC_GMT_NEG_14, ETC_GMT_NEG_2, ETC_GMT_NEG_3, ETC_GMT_NEG_4, ETC_GMT_NEG_5, ETC_GMT_NEG_6, ETC_GMT_NEG_7, ETC_GMT_NEG_8, ETC_GMT_NEG_9, EUROPE_DUBLIN, EUROPE_LONDON, EUROPE_PARIS, EUROPE_STOCKHOLM, EUROPE_ZURICH, ISRAEL, MEXICO_GENERAL, MST7MDT, PACIFIC_AUCKLAND, US_CENTRAL, US_EASTERN, US_MOUNTAIN, US_PACIFIC
    schedule: "CronString",
  },
  configuration: {
    glue_run_configuration: {
      data_access_role: "GlueRunConfigurationInputDataAccessRoleString",
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          schema_name: "RelationalFilterConfigurationSchemaNameString",
          filter_expressions: [
            {
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
              expression: "FilterExpressionExpressionString", # required
            },
          ],
        },
      ],
      auto_import_data_quality_result: false,
      catalog_name: "GlueRunConfigurationInputCatalogNameString",
    },
    redshift_run_configuration: {
      data_access_role: "RedshiftRunConfigurationInputDataAccessRoleString",
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          schema_name: "RelationalFilterConfigurationSchemaNameString",
          filter_expressions: [
            {
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
              expression: "FilterExpressionExpressionString", # required
            },
          ],
        },
      ],
      redshift_credential_configuration: {
        secret_manager_arn: "RedshiftCredentialConfigurationSecretManagerArnString", # required
      },
      redshift_storage: {
        redshift_cluster_source: {
          cluster_name: "RedshiftClusterStorageClusterNameString", # required
        },
        redshift_serverless_source: {
          workgroup_name: "RedshiftServerlessStorageWorkgroupNameString", # required
        },
      },
    },
    sage_maker_run_configuration: {
      tracking_assets: { # required
        "SageMakerAssetType" => ["SageMakerResourceArn"],
      },
    },
  },
  recommendation: {
    enable_business_name_generation: false,
  },
  retain_permissions_on_revoke_failure: false,
})

Response structure


resp.id #=> String
resp.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.name #=> String
resp.description #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.connection_id #=> String
resp.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.region #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.region #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].database_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].schema_name #=> String
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].type #=> String, one of "INCLUDE", "EXCLUDE"
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
resp.configuration.redshift_run_configuration.redshift_credential_configuration.secret_manager_arn #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_cluster_source.cluster_name #=> String
resp.configuration.redshift_run_configuration.redshift_storage.redshift_serverless_source.workgroup_name #=> String
resp.configuration.sage_maker_run_configuration. #=> String
resp.configuration.sage_maker_run_configuration.region #=> String
resp.configuration.sage_maker_run_configuration.tracking_assets #=> Hash
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"] #=> Array
resp.configuration.sage_maker_run_configuration.tracking_assets["SageMakerAssetType"][0] #=> String
resp.recommendation.enable_business_name_generation #=> Boolean
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.publish_on_import #=> Boolean
resp.asset_forms_output #=> Array
resp.asset_forms_output[0].form_name #=> String
resp.asset_forms_output[0].type_name #=> String
resp.asset_forms_output[0].type_revision #=> String
resp.asset_forms_output[0].content #=> String
resp.schedule.timezone #=> String, one of "UTC", "AFRICA_JOHANNESBURG", "AMERICA_MONTREAL", "AMERICA_SAO_PAULO", "ASIA_BAHRAIN", "ASIA_BANGKOK", "ASIA_CALCUTTA", "ASIA_DUBAI", "ASIA_HONG_KONG", "ASIA_JAKARTA", "ASIA_KUALA_LUMPUR", "ASIA_SEOUL", "ASIA_SHANGHAI", "ASIA_SINGAPORE", "ASIA_TAIPEI", "ASIA_TOKYO", "AUSTRALIA_MELBOURNE", "AUSTRALIA_SYDNEY", "CANADA_CENTRAL", "CET", "CST6CDT", "ETC_GMT", "ETC_GMT0", "ETC_GMT_ADD_0", "ETC_GMT_ADD_1", "ETC_GMT_ADD_10", "ETC_GMT_ADD_11", "ETC_GMT_ADD_12", "ETC_GMT_ADD_2", "ETC_GMT_ADD_3", "ETC_GMT_ADD_4", "ETC_GMT_ADD_5", "ETC_GMT_ADD_6", "ETC_GMT_ADD_7", "ETC_GMT_ADD_8", "ETC_GMT_ADD_9", "ETC_GMT_NEG_0", "ETC_GMT_NEG_1", "ETC_GMT_NEG_10", "ETC_GMT_NEG_11", "ETC_GMT_NEG_12", "ETC_GMT_NEG_13", "ETC_GMT_NEG_14", "ETC_GMT_NEG_2", "ETC_GMT_NEG_3", "ETC_GMT_NEG_4", "ETC_GMT_NEG_5", "ETC_GMT_NEG_6", "ETC_GMT_NEG_7", "ETC_GMT_NEG_8", "ETC_GMT_NEG_9", "EUROPE_DUBLIN", "EUROPE_LONDON", "EUROPE_PARIS", "EUROPE_STOCKHOLM", "EUROPE_ZURICH", "ISRAEL", "MEXICO_GENERAL", "MST7MDT", "PACIFIC_AUCKLAND", "US_CENTRAL", "US_EASTERN", "US_MOUNTAIN", "US_PACIFIC"
resp.schedule.schedule #=> String
resp.last_run_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.last_run_at #=> Time
resp.last_run_error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.last_run_error_message.error_detail #=> String
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.error_message.error_detail #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.self_grant_status.glue_self_grant_status.self_grant_status_details #=> Array
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].database_name #=> String
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].schema_name #=> String
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "GRANT_FAILED", "REVOKE_FAILED"
resp.self_grant_status.glue_self_grant_status.self_grant_status_details[0].failure_cause #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details #=> Array
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].database_name #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].schema_name #=> String
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "GRANT_FAILED", "REVOKE_FAILED"
resp.self_grant_status.redshift_self_grant_status.self_grant_status_details[0].failure_cause #=> String
resp.retain_permissions_on_revoke_failure #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain in which to update a data source.

  • :identifier (required, String) —

    The identifier of the data source to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateDataSource action.

  • :description (String) —

    The description to be updated as part of the UpdateDataSource action.

  • :enable_setting (String) —

    The enable setting to be updated as part of the UpdateDataSource action.

  • :publish_on_import (Boolean) —

    The publish on import setting to be updated as part of the UpdateDataSource action.

  • :asset_forms_input (Array<Types::FormInput>) —

    The asset forms to be updated as part of the UpdateDataSource action.

  • :schedule (Types::ScheduleConfiguration) —

    The schedule to be updated as part of the UpdateDataSource action.

  • :configuration (Types::DataSourceConfigurationInput) —

    The configuration to be updated as part of the UpdateDataSource action.

  • :recommendation (Types::RecommendationConfiguration) —

    The recommendation to be updated as part of the UpdateDataSource action.

  • :retain_permissions_on_revoke_failure (Boolean) —

    Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

Returns:

See Also:



13343
13344
13345
13346
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13343

def update_data_source(params = {}, options = {})
  req = build_request(:update_data_source, params)
  req.send_request(options)
end

#update_domain(params = {}) ⇒ Types::UpdateDomainOutput

Updates a Amazon DataZone domain.

Examples:

Request syntax with placeholder values


resp = client.update_domain({
  identifier: "DomainId", # required
  description: "String",
  single_sign_on: {
    type: "IAM_IDC", # accepts IAM_IDC, DISABLED
    user_assignment: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
    idc_instance_arn: "SingleSignOnIdcInstanceArnString",
  },
  domain_execution_role: "RoleArn",
  service_role: "RoleArn",
  name: "String",
  client_token: "String",
})

Response structure


resp.id #=> String
resp.root_domain_unit_id #=> String
resp.description #=> String
resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED"
resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL"
resp.single_sign_on.idc_instance_arn #=> String
resp.domain_execution_role #=> String
resp.service_role #=> String
resp.name #=> String
resp.last_updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the Amazon Web Services domain that is to be updated.

  • :description (String) —

    The description to be updated as part of the UpdateDomain action.

  • :single_sign_on (Types::SingleSignOn) —

    The single sign-on option to be updated as part of the UpdateDomain action.

  • :domain_execution_role (String) —

    The domain execution role to be updated as part of the UpdateDomain action.

  • :service_role (String) —

    The service role of the domain.

  • :name (String) —

    The name to be updated as part of the UpdateDomain action.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



13421
13422
13423
13424
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13421

def update_domain(params = {}, options = {})
  req = build_request(:update_domain, params)
  req.send_request(options)
end

#update_domain_unit(params = {}) ⇒ Types::UpdateDomainUnitOutput

Updates the domain unit.

Examples:

Request syntax with placeholder values


resp = client.update_domain_unit({
  domain_identifier: "DomainId", # required
  identifier: "DomainUnitId", # required
  description: "DomainUnitDescription",
  name: "DomainUnitName",
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.name #=> String
resp.owners #=> Array
resp.owners[0].user.user_id #=> String
resp.owners[0].group.group_id #=> String
resp.description #=> String
resp.parent_domain_unit_id #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.created_by #=> String
resp.last_updated_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where you want to update a domain unit.

  • :identifier (required, String) —

    The ID of the domain unit that you want to update.

  • :description (String) —

    The description of the domain unit that you want to update.

  • :name (String) —

    The name of the domain unit that you want to update.

Returns:

See Also:



13481
13482
13483
13484
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13481

def update_domain_unit(params = {}, options = {})
  req = build_request(:update_domain_unit, params)
  req.send_request(options)
end

#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput

Updates the specified environment in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_environment({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentId", # required
  name: "String",
  description: "String",
  glossary_terms: ["GlossaryTermId"],
  blueprint_version: "String",
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
})

Response structure


resp.project_id #=> String
resp.id #=> String
resp.domain_id #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.name #=> String
resp.description #=> String
resp.environment_profile_id #=> String
resp. #=> String
resp. #=> String
resp.provider #=> String
resp.provisioned_resources #=> Array
resp.provisioned_resources[0].provider #=> String
resp.provisioned_resources[0].name #=> String
resp.provisioned_resources[0].value #=> String
resp.provisioned_resources[0].type #=> String
resp.status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "VALIDATION_FAILED", "SUSPENDED", "DISABLED", "EXPIRED", "DELETED", "INACCESSIBLE"
resp.environment_actions #=> Array
resp.environment_actions[0].type #=> String
resp.environment_actions[0].auth #=> String, one of "IAM", "HTTPS"
resp.environment_actions[0].parameters #=> Array
resp.environment_actions[0].parameters[0].key #=> String
resp.environment_actions[0].parameters[0].value #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean
resp.last_deployment.deployment_id #=> String
resp.last_deployment.deployment_type #=> String, one of "CREATE", "UPDATE", "DELETE"
resp.last_deployment.deployment_status #=> String, one of "IN_PROGRESS", "SUCCESSFUL", "FAILED", "PENDING_DEPLOYMENT"
resp.last_deployment.failure_reason.code #=> String
resp.last_deployment.failure_reason.message #=> String
resp.last_deployment.messages #=> Array
resp.last_deployment.messages[0] #=> String
resp.last_deployment.is_deployment_complete #=> Boolean
resp.provisioning_properties.cloud_formation.template_url #=> String
resp.deployment_properties.start_timeout_minutes #=> Integer
resp.deployment_properties.end_timeout_minutes #=> Integer
resp.environment_blueprint_id #=> String
resp.environment_configuration_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain in which the environment is to be updated.

  • :identifier (required, String) —

    The identifier of the environment that is to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateEnvironment action.

  • :description (String) —

    The description to be updated as part of the UpdateEnvironment action.

  • :glossary_terms (Array<String>) —

    The glossary terms to be updated as part of the UpdateEnvironment action.

  • :blueprint_version (String) —

    The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.

  • :user_parameters (Array<Types::EnvironmentParameter>) —

    The user parameters of the environment.

Returns:

See Also:



13609
13610
13611
13612
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13609

def update_environment(params = {}, options = {})
  req = build_request(:update_environment, params)
  req.send_request(options)
end

#update_environment_action(params = {}) ⇒ Types::UpdateEnvironmentActionOutput

Updates an environment action.

Examples:

Request syntax with placeholder values


resp = client.update_environment_action({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "String", # required
  parameters: {
    aws_console_link: {
      uri: "String",
    },
  },
  name: "String",
  description: "String",
})

Response structure


resp.domain_id #=> String
resp.environment_id #=> String
resp.id #=> String
resp.name #=> String
resp.parameters.aws_console_link.uri #=> String
resp.description #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The domain ID of the environment action.

  • :environment_identifier (required, String) —

    The environment ID of the environment action.

  • :identifier (required, String) —

    The ID of the environment action.

  • :parameters (Types::ActionParameters) —

    The parameters of the environment action.

  • :name (String) —

    The name of the environment action.

  • :description (String) —

    The description of the environment action.

Returns:

See Also:



13671
13672
13673
13674
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13671

def update_environment_action(params = {}, options = {})
  req = build_request(:update_environment_action, params)
  req.send_request(options)
end

#update_environment_blueprint(params = {}) ⇒ Types::UpdateEnvironmentBlueprintOutput

Updates an environment blueprint in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_environment_blueprint({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentBlueprintId", # required
  description: "String",
  provisioning_properties: {
    cloud_formation: {
      template_url: "String", # required
    },
  },
  user_parameters: [
    {
      key_name: "CustomParameterKeyNameString", # required
      description: "Description",
      field_type: "String", # required
      default_value: "String",
      is_editable: false,
      is_optional: false,
      is_update_supported: false,
    },
  ],
})

Response structure


resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.provider #=> String
resp.provisioning_properties.cloud_formation.template_url #=> String
resp.deployment_properties.start_timeout_minutes #=> Integer
resp.deployment_properties.end_timeout_minutes #=> Integer
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.

  • :identifier (required, String) —

    The identifier of the environment blueprint to be updated.

  • :description (String) —

    The description to be updated as part of the UpdateEnvironmentBlueprint action.

  • :provisioning_properties (Types::ProvisioningProperties) —

    The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.

  • :user_parameters (Array<Types::CustomParameter>) —

    The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.

Returns:

See Also:



13760
13761
13762
13763
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13760

def update_environment_blueprint(params = {}, options = {})
  req = build_request(:update_environment_blueprint, params)
  req.send_request(options)
end

#update_environment_profile(params = {}) ⇒ Types::UpdateEnvironmentProfileOutput

Updates the specified environment profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_environment_profile({
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentProfileId", # required
  name: "EnvironmentProfileName",
  description: "String",
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp. #=> String
resp. #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.name #=> String
resp.description #=> String
resp.environment_blueprint_id #=> String
resp.project_id #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].key_name #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].is_update_supported #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

  • :identifier (required, String) —

    The identifier of the environment profile that is to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateEnvironmentProfile action.

  • :description (String) —

    The description to be updated as part of the UpdateEnvironmentProfile action.

  • :user_parameters (Array<Types::EnvironmentParameter>) —

    The user parameters to be updated as part of the UpdateEnvironmentProfile action.

  • :aws_account_id (String) —

    The Amazon Web Services account in which a specified environment profile is to be udpated.

  • :aws_account_region (String) —

    The Amazon Web Services Region in which a specified environment profile is to be updated.

Returns:

See Also:



13852
13853
13854
13855
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13852

def update_environment_profile(params = {}, options = {})
  req = build_request(:update_environment_profile, params)
  req.send_request(options)
end

#update_glossary(params = {}) ⇒ Types::UpdateGlossaryOutput

Updates the business glossary in Amazon DataZone.

Prerequisites:

  • The glossary must exist in the given domain.

  • The caller must have the datazone:UpdateGlossary permission to update it.

  • When updating the name, the new name must be unique within the domain.

  • The glossary must not be deleted or in a terminal state.

Examples:

Request syntax with placeholder values


resp = client.update_glossary({
  domain_identifier: "DomainId", # required
  identifier: "GlossaryId", # required
  name: "GlossaryName",
  description: "GlossaryDescription",
  status: "DISABLED", # accepts DISABLED, ENABLED
  client_token: "ClientToken",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> String
resp.description #=> String
resp.status #=> String, one of "DISABLED", "ENABLED"
resp.usage_restrictions #=> Array
resp.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

  • :identifier (required, String) —

    The identifier of the business glossary to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateGlossary action.

  • :description (String) —

    The description to be updated as part of the UpdateGlossary action.

  • :status (String) —

    The status to be updated as part of the UpdateGlossary action.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



13930
13931
13932
13933
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13930

def update_glossary(params = {}, options = {})
  req = build_request(:update_glossary, params)
  req.send_request(options)
end

#update_glossary_term(params = {}) ⇒ Types::UpdateGlossaryTermOutput

Updates a business glossary term in Amazon DataZone.

Prerequisites:

  • Glossary term must exist in the specified domain.

  • New name must not conflict with existing terms in the same glossary.

  • User must have permissions on the term.

  • The term must not be in DELETED status.

Examples:

Request syntax with placeholder values


resp = client.update_glossary_term({
  domain_identifier: "DomainId", # required
  glossary_identifier: "GlossaryTermId",
  identifier: "GlossaryTermId", # required
  name: "GlossaryTermName",
  short_description: "ShortDescription",
  long_description: "LongDescription",
  term_relations: {
    is_a: ["GlossaryTermId"],
    classifies: ["GlossaryTermId"],
  },
  status: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.id #=> String
resp.domain_id #=> String
resp.glossary_id #=> String
resp.name #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.short_description #=> String
resp.long_description #=> String
resp.term_relations.is_a #=> Array
resp.term_relations.is_a[0] #=> String
resp.term_relations.classifies #=> Array
resp.term_relations.classifies[0] #=> String
resp.usage_restrictions #=> Array
resp.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

  • :glossary_identifier (String) —

    The identifier of the business glossary in which a term is to be updated.

  • :identifier (required, String) —

    The identifier of the business glossary term that is to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateGlossaryTerm action.

  • :short_description (String) —

    The short description to be updated as part of the UpdateGlossaryTerm action.

  • :long_description (String) —

    The long description to be updated as part of the UpdateGlossaryTerm action.

  • :term_relations (Types::TermRelations) —

    The term relations to be updated as part of the UpdateGlossaryTerm action.

  • :status (String) —

    The status to be updated as part of the UpdateGlossaryTerm action.

Returns:

See Also:



14024
14025
14026
14027
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14024

def update_glossary_term(params = {}, options = {})
  req = build_request(:update_glossary_term, params)
  req.send_request(options)
end

#update_group_profile(params = {}) ⇒ Types::UpdateGroupProfileOutput

Updates the specified group profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_group_profile({
  domain_identifier: "DomainId", # required
  group_identifier: "GroupIdentifier", # required
  status: "ASSIGNED", # required, accepts ASSIGNED, NOT_ASSIGNED
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"
resp.group_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a group profile is updated.

  • :group_identifier (required, String) —

    The identifier of the group profile that is updated.

  • :status (required, String) —

    The status of the group profile that is updated.

Returns:

See Also:



14067
14068
14069
14070
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14067

def update_group_profile(params = {}, options = {})
  req = build_request(:update_group_profile, params)
  req.send_request(options)
end

#update_project(params = {}) ⇒ Types::UpdateProjectOutput

Updates the specified project in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_project({
  domain_identifier: "DomainId", # required
  identifier: "ProjectId", # required
  name: "ProjectName",
  description: "Description",
  resource_tags: {
    "TagKey" => "TagValue",
  },
  glossary_terms: ["GlossaryTermId"],
  domain_unit_id: "DomainUnitId",
  environment_deployment_details: {
    overall_deployment_status: "PENDING_DEPLOYMENT", # accepts PENDING_DEPLOYMENT, IN_PROGRESS, SUCCESSFUL, FAILED_VALIDATION, FAILED_DEPLOYMENT
    environment_failure_reasons: {
      "String" => [
        {
          code: "String",
          message: "String", # required
        },
      ],
    },
  },
  user_parameters: [
    {
      environment_id: "EnvironmentId",
      environment_resolved_account: {
        aws_account_id: "AwsAccountId", # required
        region_name: "AwsRegion", # required
        source_account_pool_id: "AccountPoolId",
      },
      environment_configuration_name: "EnvironmentConfigurationName",
      environment_parameters: [
        {
          name: "String",
          value: "String",
        },
      ],
    },
  ],
  project_profile_version: "String",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.failure_reasons #=> Array
resp.failure_reasons[0].code #=> String
resp.failure_reasons[0].message #=> String
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.resource_tags #=> Array
resp.resource_tags[0].key #=> String
resp.resource_tags[0].value #=> String
resp.resource_tags[0].source #=> String, one of "PROJECT", "PROJECT_PROFILE"
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.domain_unit_id #=> String
resp.project_profile_id #=> String
resp.user_parameters #=> Array
resp.user_parameters[0].environment_id #=> String
resp.user_parameters[0].. #=> String
resp.user_parameters[0]..region_name #=> String
resp.user_parameters[0].. #=> String
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_parameters #=> Array
resp.user_parameters[0].environment_parameters[0].name #=> String
resp.user_parameters[0].environment_parameters[0].value #=> String
resp.environment_deployment_details.overall_deployment_status #=> String, one of "PENDING_DEPLOYMENT", "IN_PROGRESS", "SUCCESSFUL", "FAILED_VALIDATION", "FAILED_DEPLOYMENT"
resp.environment_deployment_details.environment_failure_reasons #=> Hash
resp.environment_deployment_details.environment_failure_reasons["String"] #=> Array
resp.environment_deployment_details.environment_failure_reasons["String"][0].code #=> String
resp.environment_deployment_details.environment_failure_reasons["String"][0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where a project is being updated.

  • :identifier (required, String) —

    The identifier of the project that is to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateProject action.

  • :description (String) —

    The description to be updated as part of the UpdateProject action.

  • :resource_tags (Hash<String,String>) —

    The resource tags of the project.

  • :glossary_terms (Array<String>) —

    The glossary terms to be updated as part of the UpdateProject action.

  • :domain_unit_id (String) —

    The ID of the domain unit.

  • :environment_deployment_details (Types::EnvironmentDeploymentDetails) —

    The environment deployment details of the project.

  • :user_parameters (Array<Types::EnvironmentConfigurationUserParameter>) —

    The user parameters of the project.

  • :project_profile_version (String) —

    The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.

Returns:

See Also:



14208
14209
14210
14211
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14208

def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end

#update_project_profile(params = {}) ⇒ Types::UpdateProjectProfileOutput

Updates a project profile.

Examples:

Request syntax with placeholder values


resp = client.update_project_profile({
  domain_identifier: "DomainId", # required
  identifier: "ProjectProfileId", # required
  name: "ProjectProfileName",
  description: "Description",
  status: "ENABLED", # accepts ENABLED, DISABLED
  project_resource_tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
      is_value_editable: false, # required
    },
  ],
  allow_custom_project_resource_tags: false,
  project_resource_tags_description: "Description",
  environment_configurations: [
    {
      name: "EnvironmentConfigurationName", # required
      id: "EnvironmentConfigurationId",
      environment_blueprint_id: "EnvironmentBlueprintId", # required
      description: "Description",
      deployment_mode: "ON_CREATE", # accepts ON_CREATE, ON_DEMAND
      configuration_parameters: {
        ssm_path: "ParameterStorePath",
        parameter_overrides: [
          {
            name: "EnvironmentConfigurationParameterName",
            value: "String",
            is_editable: false,
          },
        ],
        resolved_parameters: [
          {
            name: "EnvironmentConfigurationParameterName",
            value: "String",
            is_editable: false,
          },
        ],
      },
      aws_account: {
        aws_account_id: "AwsAccountId",
        aws_account_id_path: "ParameterStorePath",
      },
      account_pools: ["AccountPoolId"],
      aws_region: {
        region_name: "RegionName",
        region_name_path: "ParameterStorePath",
      },
      deployment_order: 1,
    },
  ],
  domain_unit_identifier: "DomainUnitId",
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.description #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.project_resource_tags #=> Array
resp.project_resource_tags[0].key #=> String
resp.project_resource_tags[0].value #=> String
resp.project_resource_tags[0].is_value_editable #=> Boolean
resp.allow_custom_project_resource_tags #=> Boolean
resp.project_resource_tags_description #=> String
resp.environment_configurations #=> Array
resp.environment_configurations[0].name #=> String
resp.environment_configurations[0].id #=> String
resp.environment_configurations[0].environment_blueprint_id #=> String
resp.environment_configurations[0].description #=> String
resp.environment_configurations[0].deployment_mode #=> String, one of "ON_CREATE", "ON_DEMAND"
resp.environment_configurations[0].configuration_parameters.ssm_path #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides #=> Array
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].name #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].value #=> String
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].is_editable #=> Boolean
resp.environment_configurations[0].configuration_parameters.resolved_parameters #=> Array
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].name #=> String
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].value #=> String
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].is_editable #=> Boolean
resp.environment_configurations[0].. #=> String
resp.environment_configurations[0].. #=> String
resp.environment_configurations[0]. #=> Array
resp.environment_configurations[0].[0] #=> String
resp.environment_configurations[0].aws_region.region_name #=> String
resp.environment_configurations[0].aws_region.region_name_path #=> String
resp.environment_configurations[0].deployment_order #=> Integer
resp.created_by #=> String
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.domain_unit_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where a project profile is to be updated.

  • :identifier (required, String) —

    The ID of a project profile that is to be updated.

  • :name (String) —

    The name of a project profile.

  • :description (String) —

    The description of a project profile.

  • :status (String) —

    The status of a project profile.

  • :project_resource_tags (Array<Types::ResourceTagParameter>) —

    The resource tags of the project profile.

  • :allow_custom_project_resource_tags (Boolean) —

    Specifies whether custom project resource tags are supported.

  • :project_resource_tags_description (String) —

    Field viewable through the UI that provides a project user with the allowed resource tag specifications.

  • :environment_configurations (Array<Types::EnvironmentConfiguration>) —

    The environment configurations of a project profile.

  • :domain_unit_identifier (String) —

    The ID of the domain unit where a project profile is to be updated.

Returns:

See Also:



14362
14363
14364
14365
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14362

def update_project_profile(params = {}, options = {})
  req = build_request(:update_project_profile, params)
  req.send_request(options)
end

#update_root_domain_unit_owner(params = {}) ⇒ Struct

Updates the owner of the root domain unit.

Examples:

Request syntax with placeholder values


resp = client.update_root_domain_unit_owner({
  domain_identifier: "DomainId", # required
  current_owner: "UserIdentifier", # required
  new_owner: "String", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain where the root domain unit owner is to be updated.

  • :current_owner (required, String) —

    The current owner of the root domain unit.

  • :new_owner (required, String) —

    The new owner of the root domain unit.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



14401
14402
14403
14404
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14401

def update_root_domain_unit_owner(params = {}, options = {})
  req = build_request(:update_root_domain_unit_owner, params)
  req.send_request(options)
end

#update_rule(params = {}) ⇒ Types::UpdateRuleOutput

Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

Examples:

Request syntax with placeholder values


resp = client.update_rule({
  domain_identifier: "DomainId", # required
  identifier: "RuleId", # required
  name: "RuleName",
  description: "Description",
  scope: {
    asset_type: {
      selection_mode: "ALL", # required, accepts ALL, SPECIFIC
      specific_asset_types: ["AssetTypeIdentifier"],
    },
    data_product: false,
    project: {
      selection_mode: "ALL", # required, accepts ALL, SPECIFIC
      specific_projects: ["ProjectId"],
    },
  },
  detail: {
    metadata_form_enforcement_detail: {
      required_metadata_forms: [
        {
          type_identifier: "FormTypeIdentifier", # required
          type_revision: "Revision", # required
        },
      ],
    },
    glossary_term_enforcement_detail: {
      required_glossary_term_ids: ["GlossaryTermId"],
    },
  },
  include_child_domain_units: false,
})

Response structure


resp.identifier #=> String
resp.revision #=> String
resp.name #=> String
resp.rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT", "GLOSSARY_TERM_ENFORCEMENT"
resp.target.domain_unit_target.domain_unit_id #=> String
resp.target.domain_unit_target.include_child_domain_units #=> Boolean
resp.action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.scope.asset_type.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.scope.asset_type.specific_asset_types #=> Array
resp.scope.asset_type.specific_asset_types[0] #=> String
resp.scope.data_product #=> Boolean
resp.scope.project.selection_mode #=> String, one of "ALL", "SPECIFIC"
resp.scope.project.specific_projects #=> Array
resp.scope.project.specific_projects[0] #=> String
resp.detail.metadata_form_enforcement_detail.required_metadata_forms #=> Array
resp.detail.metadata_form_enforcement_detail.required_metadata_forms[0].type_identifier #=> String
resp.detail.metadata_form_enforcement_detail.required_metadata_forms[0].type_revision #=> String
resp.detail.glossary_term_enforcement_detail.required_glossary_term_ids #=> Array
resp.detail.glossary_term_enforcement_detail.required_glossary_term_ids[0] #=> String
resp.description #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.created_by #=> String
resp.last_updated_by #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which a rule is to be updated.

  • :identifier (required, String) —

    The ID of the rule that is to be updated

  • :name (String) —

    The name of the rule.

  • :description (String) —

    The description of the rule.

  • :scope (Types::RuleScope) —

    The scrope of the rule.

  • :detail (Types::RuleDetail) —

    The detail of the rule.

  • :include_child_domain_units (Boolean) —

    Specifies whether to update this rule in the child domain units.

Returns:

See Also:



14518
14519
14520
14521
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14518

def update_rule(params = {}, options = {})
  req = build_request(:update_rule, params)
  req.send_request(options)
end

#update_subscription_grant_status(params = {}) ⇒ Types::UpdateSubscriptionGrantStatusOutput

Updates the status of the specified subscription grant status in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_subscription_grant_status({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionGrantId", # required
  asset_identifier: "AssetId", # required
  status: "GRANT_PENDING", # required, accepts GRANT_PENDING, REVOKE_PENDING, GRANT_IN_PROGRESS, REVOKE_IN_PROGRESS, GRANTED, REVOKED, GRANT_FAILED, REVOKE_FAILED
  failure_cause: {
    message: "String",
  },
  target_name: "String",
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.environment_id #=> String
resp.subscription_target_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].status #=> String, one of "GRANT_PENDING", "REVOKE_PENDING", "GRANT_IN_PROGRESS", "REVOKE_IN_PROGRESS", "GRANTED", "REVOKED", "GRANT_FAILED", "REVOKE_FAILED"
resp.assets[0].target_name #=> String
resp.assets[0].failure_cause.message #=> String
resp.assets[0].granted_timestamp #=> Time
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.filter_ids #=> Array
resp.assets[0].asset_scope.filter_ids[0] #=> String
resp.assets[0].asset_scope.status #=> String
resp.assets[0].asset_scope.error_message #=> String
resp.assets[0].permissions.s3 #=> Array
resp.assets[0].permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscription_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

  • :identifier (required, String) —

    The identifier of the subscription grant the status of which is to be updated.

  • :asset_identifier (required, String) —

    The identifier of the asset the subscription grant status of which is to be updated.

  • :status (required, String) —

    The status to be updated as part of the UpdateSubscriptionGrantStatus action.

  • :failure_cause (Types::FailureCause) —

    Specifies the error message that is returned if the operation cannot be successfully completed.

  • :target_name (String) —

    The target name to be updated as part of the UpdateSubscriptionGrantStatus action.

Returns:

See Also:



14612
14613
14614
14615
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14612

def update_subscription_grant_status(params = {}, options = {})
  req = build_request(:update_subscription_grant_status, params)
  req.send_request(options)
end

#update_subscription_request(params = {}) ⇒ Types::UpdateSubscriptionRequestOutput

Updates a specified subscription request in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_subscription_request({
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
  request_reason: "RequestReason", # required
})

Response structure


resp.id #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.domain_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.created_at #=> Time
resp.updated_at #=> Time
resp.request_reason #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.subscribed_principals[0].user.id #=> String
resp.subscribed_principals[0].user.details.iam.arn #=> String
resp.subscribed_principals[0].user.details.iam.principal_id #=> String
resp.subscribed_principals[0].user.details.sso.username #=> String
resp.subscribed_principals[0].user.details.sso.first_name #=> String
resp.subscribed_principals[0].user.details.sso.last_name #=> String
resp.subscribed_principals[0].group.id #=> String
resp.subscribed_principals[0].group.name #=> String
resp.subscribed_principals[0].iam.principal_arn #=> String
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_listings[0].name #=> String
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.subscribed_listings[0].item.asset_listing.forms #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids #=> Array
resp.subscribed_listings[0].item.asset_listing.asset_scope.filter_ids[0] #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.status #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> String
resp.subscribed_listings[0].item.asset_listing.permissions.s3 #=> Array
resp.subscribed_listings[0].item.asset_listing.permissions.s3[0] #=> String, one of "READ", "WRITE"
resp.subscribed_listings[0].item.product_listing.entity_id #=> String
resp.subscribed_listings[0].item.product_listing.entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms #=> Array
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].name #=> String
resp.subscribed_listings[0].item.product_listing.glossary_terms[0].short_description #=> String
resp.subscribed_listings[0].item.product_listing.name #=> String
resp.subscribed_listings[0].item.product_listing.description #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings #=> Array
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_id #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_revision #=> String
resp.subscribed_listings[0].item.product_listing.asset_listings[0].entity_type #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.reviewer_id #=> String
resp.decision_comment #=> String
resp.existing_subscription_id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.metadata_forms[0].content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

  • :identifier (required, String) —

    The identifier of the subscription request that is to be updated.

  • :request_reason (required, String) —

    The reason for the UpdateSubscriptionRequest action.

Returns:

See Also:



14721
14722
14723
14724
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14721

def update_subscription_request(params = {}, options = {})
  req = build_request(:update_subscription_request, params)
  req.send_request(options)
end

#update_subscription_target(params = {}) ⇒ Types::UpdateSubscriptionTargetOutput

Updates the specified subscription target in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_subscription_target({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "SubscriptionTargetId", # required
  name: "SubscriptionTargetName",
  authorized_principals: ["AuthorizedPrincipalIdentifier"],
  applicable_asset_types: ["TypeName"],
  subscription_target_config: [
    {
      form_name: "FormName", # required
      content: "String", # required
    },
  ],
  manage_access_role: "IamRoleArn",
  provider: "String",
  subscription_grant_creation_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
})

Response structure


resp.id #=> String
resp.authorized_principals #=> Array
resp.authorized_principals[0] #=> String
resp.domain_id #=> String
resp.project_id #=> String
resp.environment_id #=> String
resp.name #=> String
resp.type #=> String
resp.created_by #=> String
resp.updated_by #=> String
resp.created_at #=> Time
resp.updated_at #=> Time
resp.manage_access_role #=> String
resp.applicable_asset_types #=> Array
resp.applicable_asset_types[0] #=> String
resp.subscription_target_config #=> Array
resp.subscription_target_config[0].form_name #=> String
resp.subscription_target_config[0].content #=> String
resp.provider #=> String
resp.subscription_grant_creation_mode #=> String, one of "AUTOMATIC", "MANUAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

  • :environment_identifier (required, String) —

    The identifier of the environment in which a subscription target is to be updated.

  • :identifier (required, String) —

    Identifier of the subscription target that is to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateSubscriptionTarget action.

  • :authorized_principals (Array<String>) —

    The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

  • :applicable_asset_types (Array<String>) —

    The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

  • :subscription_target_config (Array<Types::SubscriptionTargetForm>) —

    The configuration to be updated as part of the UpdateSubscriptionTarget action.

  • :manage_access_role (String) —

    The manage access role to be updated as part of the UpdateSubscriptionTarget action.

  • :provider (String) —

    The provider to be updated as part of the UpdateSubscriptionTarget action.

  • :subscription_grant_creation_mode (String) —

    Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

Returns:

See Also:



14834
14835
14836
14837
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14834

def update_subscription_target(params = {}, options = {})
  req = build_request(:update_subscription_target, params)
  req.send_request(options)
end

#update_user_profile(params = {}) ⇒ Types::UpdateUserProfileOutput

Updates the specified user profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  user_identifier: "UserIdentifier", # required
  type: "IAM", # accepts IAM, SSO
  status: "ASSIGNED", # required, accepts ASSIGNED, NOT_ASSIGNED, ACTIVATED, DEACTIVATED
})

Response structure


resp.domain_id #=> String
resp.id #=> String
resp.type #=> String, one of "IAM", "SSO"
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED"
resp.details.iam.arn #=> String
resp.details.iam.principal_id #=> String
resp.details.sso.username #=> String
resp.details.sso.first_name #=> String
resp.details.sso.last_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a user profile is updated.

  • :user_identifier (required, String) —

    The identifier of the user whose user profile is to be updated.

  • :type (String) —

    The type of the user profile that are to be updated.

  • :status (required, String) —

    The status of the user profile that are to be updated.

Returns:

See Also:



14887
14888
14889
14890
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 14887

def (params = {}, options = {})
  req = build_request(:update_user_profile, params)
  req.send_request(options)
end