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({
  accept_choices: [
    {
      edited_value: "EditedValue",
      prediction_choice: 1,
      prediction_target: "String", # required
    },
  ],
  accept_rule: {
    rule: "ALL", # accepts ALL, NONE
    threshold: 1.0,
  },
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  revision: "Revision",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :accept_rule (Types::AcceptRule) —

    Specifies the rule (or the conditions) under which a prediction 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.**

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

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({
  asset_scopes: [
    {
      asset_id: "AssetId", # required
      filter_ids: ["FilterId"], # required
    },
  ],
  decision_comment: "DecisionComment",
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.existing_subscription_id #=> String
resp.id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].content #=> String
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.request_reason #=> String
resp.reviewer_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> 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.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.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].item.product_listing.description #=> String
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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The asset scopes of the accept subscription request.

  • :decision_comment (String) —

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

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

Returns:

See Also:



652
653
654
655
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 652

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  owner: { # required
    group: {
      group_identifier: "GroupIdentifier", # required
    },
    user: {
      user_identifier: "UserIdentifier", # required
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

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

  • :entity_identifier (required, String) —

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

  • :entity_type (required, String) —

    The type of an entity.

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

    The owner that you want to add to the entity.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



701
702
703
704
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 701

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({
  client_token: "ClientToken",
  detail: { # required
    add_to_project_member_pool: {
      include_child_domain_units: false,
    },
    create_asset_type: {
      include_child_domain_units: false,
    },
    create_domain_unit: {
      include_child_domain_units: false,
    },
    create_environment: {
    },
    create_environment_from_blueprint: {
    },
    create_environment_profile: {
      domain_unit_id: "DomainUnitId",
    },
    create_form_type: {
      include_child_domain_units: false,
    },
    create_glossary: {
      include_child_domain_units: false,
    },
    create_project: {
      include_child_domain_units: false,
    },
    create_project_from_project_profile: {
      include_child_domain_units: false,
      project_profiles: ["String"],
    },
    delegate_create_environment_profile: {
    },
    override_domain_unit_owners: {
      include_child_domain_units: false,
    },
    override_project_owners: {
      include_child_domain_units: false,
    },
    use_asset_type: {
      domain_unit_id: "DomainUnitId",
    },
  },
  domain_identifier: "DomainId", # required
  entity_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE, ASSET_TYPE
  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
    domain_unit: {
      domain_unit_designation: "OWNER", # required, accepts OWNER
      domain_unit_grant_filter: {
        all_domain_units_grant_filter: {
        },
      },
      domain_unit_identifier: "DomainUnitId",
    },
    group: {
      group_identifier: "GroupIdentifier",
    },
    project: {
      project_designation: "OWNER", # required, accepts OWNER, CONTRIBUTOR, PROJECT_CATALOG_STEWARD
      project_grant_filter: {
        domain_unit_filter: {
          domain_unit: "DomainUnitId", # required
          include_child_domain_units: false,
        },
      },
      project_identifier: "ProjectId",
    },
    user: {
      all_users_grant_filter: {
      },
      user_identifier: "UserIdentifier",
    },
  },
})

Response structure


resp.grant_id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

    The details of the policy grant.

  • :domain_identifier (required, String) —

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

  • :entity_identifier (required, String) —

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

  • :entity_type (required, String) —

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

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

Returns:

See Also:



828
829
830
831
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 828

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:



859
860
861
862
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 859

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:



895
896
897
898
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 895

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

#cancel_metadata_generation_run(params = {}) ⇒ Struct

Cancels the metadata generation run.

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:



922
923
924
925
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 922

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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.id #=> String
resp.retain_permissions #=> Boolean
resp.status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.subscribed_listing.description #=> String
resp.subscribed_listing.id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.error_message #=> 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.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.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.item.product_listing.description #=> String
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.name #=> String
resp.subscribed_listing.owner_project_id #=> String
resp.subscribed_listing.owner_project_name #=> String
resp.subscribed_listing.revision #=> String
resp.subscribed_principal.project.id #=> String
resp.subscribed_principal.project.name #=> String
resp.subscription_request_id #=> 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 subscription request is being cancelled.

  • :identifier (required, String) —

    The unique identifier of the subscription that is being cancelled.

Returns:

See Also:



1004
1005
1006
1007
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1004

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.({
  account_source: { # required
    accounts: [
      {
        aws_account_id: "AwsAccountId", # required
        aws_account_name: "AwsAccountName",
        supported_regions: ["AwsRegion"], # required
      },
    ],
    custom_account_pool_handler: {
      lambda_execution_role_arn: "LambdaExecutionRoleArn",
      lambda_function_arn: "LambdaFunctionArn", # required
    },
  },
  description: "Description",
  domain_identifier: "DomainId", # required
  name: "AccountPoolName", # required
  resolution_strategy: "MANUAL", # required, accepts MANUAL
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :description (String) —

    The description of the account pool.

  • :domain_identifier (required, String) —

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

  • :name (required, String) —

    The name of the account pool.

  • :resolution_strategy (required, String) —

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

Returns:

See Also:



1089
1090
1091
1092
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1089

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    Asset description.

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

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

    Metadata forms attached to the asset.

  • :glossary_terms (Array<String>) —

    Glossary terms attached to the asset.

  • :name (required, String) —

    Asset name.

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

  • :type_identifier (required, String) —

    The unique identifier of this asset's type.

  • :type_revision (String) —

    The revision of this asset's type.

Returns:

See Also:



1231
1232
1233
1234
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1231

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.asset_id #=> String
resp.configuration.column_configuration.included_column_names #=> Array
resp.configuration.column_configuration.included_column_names[0] #=> 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.expression.equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.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.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.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.is_not_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.is_null.column_name #=> 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.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.like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.like.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.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.not_like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.value #=> String
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.description #=> String
resp.domain_id #=> String
resp.effective_column_names #=> Array
resp.effective_column_names[0] #=> String
resp.effective_row_filter #=> String
resp.error_message #=> String
resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "VALID", "INVALID"

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

    The ID of the data 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.**

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

    The configuration of the asset filter.

  • :description (String) —

    The description of the asset filter.

  • :domain_identifier (required, String) —

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

  • :name (required, String) —

    The name of the asset filter.

Returns:

See Also:



1401
1402
1403
1404
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1401

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    The revised description of the asset.

  • :domain_identifier (required, String) —

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

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

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

  • :glossary_terms (Array<String>) —

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

  • :identifier (required, String) —

    The identifier of the asset.

  • :name (required, String) —

    Te revised name of the asset.

  • :prediction_configuration (Types::PredictionConfiguration) —

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

  • :type_revision (String) —

    The revision type of the asset.

Returns:

See Also:



1534
1535
1536
1537
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1534

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The descripton of the custom asset type.

  • :domain_identifier (required, String) —

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

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

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

  • :name (required, String) —

    The name of 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:



1611
1612
1613
1614
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1611

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", # required
  name: "ConnectionName", # required
  props: {
    athena_properties: {
      workgroup_name: "AthenaPropertiesInputWorkgroupNameString",
    },
    glue_properties: {
      glue_connection_input: {
        athena_properties: {
          "PropertyMapKeyString" => "PropertyMapValueString",
        },
        authentication_configuration: {
          authentication_type: "BASIC", # accepts BASIC, OAUTH2, CUSTOM
          basic_authentication_credentials: {
            password: "BasicAuthenticationCredentialsPasswordString",
            user_name: "BasicAuthenticationCredentialsUserNameString",
          },
          custom_authentication_credentials: {
            "CredentialMapKeyString" => "CredentialMapValueString",
          },
          kms_key_arn: "AuthenticationConfigurationInputKmsKeyArnString",
          o_auth_2_properties: {
            authorization_code_properties: {
              authorization_code: "AuthorizationCodePropertiesAuthorizationCodeString",
              redirect_uri: "AuthorizationCodePropertiesRedirectUriString",
            },
            o_auth_2_client_application: {
              a_ws_managed_client_application_reference: "OAuth2ClientApplicationAWSManagedClientApplicationReferenceString",
              user_managed_client_application_client_id: "OAuth2ClientApplicationUserManagedClientApplicationClientIdString",
            },
            o_auth_2_credentials: {
              access_token: "GlueOAuth2CredentialsAccessTokenString",
              jwt_token: "GlueOAuth2CredentialsJwtTokenString",
              refresh_token: "GlueOAuth2CredentialsRefreshTokenString",
              user_managed_client_application_client_secret: "GlueOAuth2CredentialsUserManagedClientApplicationClientSecretString",
            },
            o_auth_2_grant_type: "AUTHORIZATION_CODE", # accepts AUTHORIZATION_CODE, CLIENT_CREDENTIALS, JWT_BEARER
            token_url: "OAuth2PropertiesTokenUrlString",
            token_url_parameters_map: {
              "TokenUrlParametersMapKeyString" => "TokenUrlParametersMapValueString",
            },
          },
          secret_arn: "AuthenticationConfigurationInputSecretArnString",
        },
        connection_properties: {
          "String" => "ConnectionPropertiesValueString",
        },
        connection_type: "SNOWFLAKE", # accepts SNOWFLAKE, BIGQUERY, DOCUMENTDB, DYNAMODB, MYSQL, OPENSEARCH, ORACLE, POSTGRESQL, REDSHIFT, SAPHANA, SQLSERVER, TERADATA, VERTICA
        description: "String",
        match_criteria: "GlueConnectionInputMatchCriteriaString",
        name: "GlueConnectionInputNameString",
        physical_connection_requirements: {
          availability_zone: "PhysicalConnectionRequirementsAvailabilityZoneString",
          security_group_id_list: ["SecurityGroupIdListMemberString"],
          subnet_id: "SubnetId",
          subnet_id_list: ["SubnetId"],
        },
        python_properties: {
          "PropertyMapKeyString" => "PropertyMapValueString",
        },
        spark_properties: {
          "PropertyMapKeyString" => "PropertyMapValueString",
        },
        validate_credentials: false,
        validate_for_compute_environments: ["SPARK"], # accepts SPARK, ATHENA, PYTHON
      },
    },
    hyper_pod_properties: {
      cluster_name: "HyperPodPropertiesInputClusterNameString", # required
    },
    iam_properties: {
      glue_lineage_sync_enabled: false,
    },
    redshift_properties: {
      credentials: {
        secret_arn: "RedshiftCredentialsSecretArnString",
        username_password: {
          password: "Password", # required
          username: "Username", # required
        },
      },
      database_name: "RedshiftPropertiesInputDatabaseNameString",
      host: "RedshiftPropertiesInputHostString",
      lineage_sync: {
        enabled: false,
        schedule: {
          schedule: "LineageSyncScheduleScheduleString",
        },
      },
      port: 1,
      storage: {
        cluster_name: "RedshiftStoragePropertiesClusterNameString",
        workgroup_name: "RedshiftStoragePropertiesWorkgroupNameString",
      },
    },
    s3_properties: {
      s3_access_grant_location_id: "S3AccessGrantLocationId",
      s3_uri: "S3Uri", # required
    },
    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",
    },
    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",
    },
  },
})

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.athena_properties #=> Hash
resp.physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
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_client_application.a_ws_managed_client_application_reference #=> String
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_credentials.access_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.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.user_managed_client_application_client_secret #=> 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.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.secret_arn #=> String
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].glue_connection.connection_properties #=> Hash
resp.physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
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"
resp.physical_endpoints[0].glue_connection.creation_time #=> Time
resp.physical_endpoints[0].glue_connection.description #=> String
resp.physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.physical_endpoints[0].glue_connection.last_updated_time #=> Time
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.name #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> 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.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.python_properties #=> Hash
resp.physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> 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.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_name #=> String
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.error_message #=> String
resp.props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.hyper_pod_properties.cluster_arn #=> String
resp.props.hyper_pod_properties.cluster_name #=> 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.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.database_name #=> 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.lineage_sync.enabled #=> Boolean
resp.props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.props.redshift_properties.redshift_temp_dir #=> String
resp.props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.redshift_properties.storage.cluster_name #=> String
resp.props.redshift_properties.storage.workgroup_name #=> String
resp.props.s3_properties.error_message #=> String
resp.props.s3_properties.s3_access_grant_location_id #=> String
resp.props.s3_properties.s3_uri #=> String
resp.props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
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_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.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"

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 (required, String) —

    The ID of the environment where the connection is created.

  • :name (required, String) —

    The connection name.

  • :props (Types::ConnectionPropertiesInput) —

    The connection props.

Returns:

See Also:



1906
1907
1908
1909
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1906

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    The description of the data product.

  • :domain_identifier (required, String) —

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

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

    The metadata forms of the data product.

  • :glossary_terms (Array<String>) —

    The glossary terms of the data product.

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

    The data assets of the data product.

  • :name (required, String) —

    The name of the data product.

  • :owning_project_identifier (required, String) —

    The ID of the owning project of the data product.

Returns:

See Also:



2016
2017
2018
2019
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2016

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    The description of the data product revision.

  • :domain_identifier (required, String) —

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

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

    The metadata forms of the data product revision.

  • :glossary_terms (Array<String>) —

    The glossary terms of the data product revision.

  • :identifier (required, String) —

    The ID of the data product revision.

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

    The data assets of the data product revision.

  • :name (required, String) —

    The name of the data product revision.

Returns:

See Also:



2126
2127
2128
2129
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2126

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({
  asset_forms_input: [
    {
      content: "FormInputContentString",
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
    },
  ],
  client_token: "String",
  configuration: {
    glue_run_configuration: {
      auto_import_data_quality_result: false,
      catalog_name: "GlueRunConfigurationInputCatalogNameString",
      data_access_role: "GlueRunConfigurationInputDataAccessRoleString",
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          filter_expressions: [
            {
              expression: "FilterExpressionExpressionString", # required
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
            },
          ],
          schema_name: "RelationalFilterConfigurationSchemaNameString",
        },
      ],
    },
    redshift_run_configuration: {
      data_access_role: "RedshiftRunConfigurationInputDataAccessRoleString",
      redshift_credential_configuration: {
        secret_manager_arn: "RedshiftCredentialConfigurationSecretManagerArnString", # required
      },
      redshift_storage: {
        redshift_cluster_source: {
          cluster_name: "RedshiftClusterStorageClusterNameString", # required
        },
        redshift_serverless_source: {
          workgroup_name: "RedshiftServerlessStorageWorkgroupNameString", # required
        },
      },
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          filter_expressions: [
            {
              expression: "FilterExpressionExpressionString", # required
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
            },
          ],
          schema_name: "RelationalFilterConfigurationSchemaNameString",
        },
      ],
    },
    sage_maker_run_configuration: {
      tracking_assets: { # required
        "SageMakerAssetType" => ["SageMakerResourceArn"],
      },
    },
  },
  connection_identifier: "CreateDataSourceInputConnectionIdentifierString",
  description: "Description",
  domain_identifier: "DomainId", # required
  enable_setting: "ENABLED", # accepts ENABLED, DISABLED
  environment_identifier: "CreateDataSourceInputEnvironmentIdentifierString",
  name: "Name", # required
  project_identifier: "CreateDataSourceInputProjectIdentifierString", # required
  publish_on_import: false,
  recommendation: {
    enable_business_name_generation: false,
  },
  schedule: {
    schedule: "CronString",
    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
  },
  type: "DataSourceType", # required
})

Response structure


resp.asset_forms_output #=> Array
resp.asset_forms_output[0].content #=> String
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.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> 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.redshift_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_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.connection_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.domain_id #=> String
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.environment_id #=> String
resp.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.id #=> String
resp.last_run_at #=> Time
resp.last_run_error_message.error_detail #=> String
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_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.name #=> String
resp.project_id #=> String
resp.publish_on_import #=> Boolean
resp.recommendation.enable_business_name_generation #=> Boolean
resp.schedule.schedule #=> 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.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

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

  • :configuration (Types::DataSourceConfigurationInput) —

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

  • :connection_identifier (String) —

    The ID of the connection.

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

  • :enable_setting (String) —

    Specifies whether the data source is enabled.

  • :environment_identifier (String) —

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

  • :name (required, String) —

    The name of the data source.

  • :project_identifier (required, String) —

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

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

  • :recommendation (Types::RecommendationConfiguration) —

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

  • :schedule (Types::ScheduleConfiguration) —

    The schedule of the data source runs.

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

Returns:

See Also:



2355
2356
2357
2358
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2355

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({
  client_token: "String",
  description: "String",
  domain_execution_role: "RoleArn", # required
  domain_version: "V1", # accepts V1, V2
  kms_key_identifier: "KmsKeyArn",
  name: "String", # required
  service_role: "RoleArn",
  single_sign_on: {
    idc_instance_arn: "SingleSignOnIdcInstanceArnString",
    type: "IAM_IDC", # accepts IAM_IDC, DISABLED
    user_assignment: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    The description 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.

  • :domain_version (String) —

    The version of the domain that is created.

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

  • :name (required, String) —

    The name of the Amazon DataZone domain.

  • :service_role (String) —

    The service role of the domain that is created.

  • :single_sign_on (Types::SingleSignOn) —

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

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

    The tags specified for the Amazon DataZone domain.

Returns:

See Also:



2456
2457
2458
2459
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2456

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({
  client_token: "ClientToken",
  description: "DomainUnitDescription",
  domain_identifier: "DomainId", # required
  name: "DomainUnitName", # required
  parent_domain_unit_identifier: "DomainUnitId", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    The description of the domain unit.

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

Returns:

See Also:



2523
2524
2525
2526
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2523

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({
  deployment_order: 1,
  description: "String",
  domain_identifier: "DomainId", # required
  environment_account_identifier: "String",
  environment_account_region: "String",
  environment_blueprint_identifier: "String",
  environment_configuration_id: "String",
  environment_profile_identifier: "EnvironmentProfileId",
  glossary_terms: ["GlossaryTermId"],
  name: "String", # required
  project_identifier: "ProjectId", # required
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :deployment_order (Integer) —

    The deployment order of the environment.

  • :description (String) —

    The description of the Amazon DataZone environment.

  • :domain_identifier (required, String) —

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

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

  • :environment_configuration_id (String) —

    The configuration ID of the environment.

  • :environment_profile_identifier (String) —

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

  • :glossary_terms (Array<String>) —

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

  • :name (required, String) —

    The name of the Amazon DataZone environment.

  • :project_identifier (required, String) —

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

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

    The user parameters of this Amazon DataZone environment.

Returns:

See Also:



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

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({
  description: "String",
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  name: "String", # required
  parameters: { # required
    aws_console_link: {
      uri: "String",
    },
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

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

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

Returns:

See Also:



2731
2732
2733
2734
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2731

def create_environment_action(params = {}, options = {})
  req = build_request(:create_environment_action, 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({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  description: "Description",
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
  name: "EnvironmentProfileName", # required
  project_identifier: "ProjectId", # required
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :description (String) —

    The description of this Amazon DataZone environment profile.

  • :domain_identifier (required, String) —

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

  • :environment_blueprint_identifier (required, String) —

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

  • :name (required, String) —

    The name of this Amazon DataZone environment profile.

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

Returns:

See Also:



2825
2826
2827
2828
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2825

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of this Amazon DataZone metadata form type.

  • :domain_identifier (required, String) —

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

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

    The model of this Amazon DataZone metadata form type.

  • :name (required, String) —

    The name 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.

Returns:

See Also:



2889
2890
2891
2892
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2889

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> 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):

  • :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) —

    The description of this business glossary.

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

  • :status (String) —

    The status of this business glossary.

  • :usage_restrictions (Array<String>) —

    The usage restriction of the restricted glossary.

Returns:

See Also:



2959
2960
2961
2962
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2959

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.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :long_description (String) —

    The long description of this business glossary term.

  • :name (required, String) —

    The name of this business glossary term.

  • :short_description (String) —

    The short description of this business glossary term.

  • :status (String) —

    The status of this business glossary term.

  • :term_relations (Types::TermRelations) —

    The term relations of this business glossary term.

Returns:

See Also:



3043
3044
3045
3046
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3043

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({
  client_token: "String",
  domain_identifier: "DomainId", # required
  group_identifier: "GroupIdentifier", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



3090
3091
3092
3093
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3090

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({
  action: "PUBLISH", # required, accepts PUBLISH, UNPUBLISH
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_revision: "Revision",
  entity_type: "ASSET", # required, accepts ASSET, DATA_PRODUCT
})

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):

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

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain.

  • :entity_identifier (required, String) —

    The ID of the asset.

  • :entity_revision (String) —

    The revision of an asset.

  • :entity_type (required, String) —

    The type of an entity.

Returns:

See Also:



3147
3148
3149
3150
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3147

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({
  description: "Description",
  domain_identifier: "DomainId", # required
  domain_unit_id: "DomainUnitId",
  glossary_terms: ["GlossaryTermId"],
  name: "ProjectName", # required
  project_profile_id: "ProjectProfileId",
  user_parameters: [
    {
      environment_configuration_name: "EnvironmentConfigurationName",
      environment_id: "EnvironmentId",
      environment_parameters: [
        {
          name: "String",
          value: "String",
        },
      ],
      environment_resolved_account: {
        aws_account_id: "AwsAccountId", # required
        region_name: "AwsRegion", # required
        source_account_pool_id: "AccountPoolId",
      },
    },
  ],
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
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
resp.environment_deployment_details.overall_deployment_status #=> String, one of "PENDING_DEPLOYMENT", "IN_PROGRESS", "SUCCESSFUL", "FAILED_VALIDATION", "FAILED_DEPLOYMENT"
resp.failure_reasons #=> Array
resp.failure_reasons[0].code #=> String
resp.failure_reasons[0].message #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.project_profile_id #=> String
resp.project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.user_parameters #=> Array
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_id #=> 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.user_parameters[0].. #=> String
resp.user_parameters[0]..region_name #=> String
resp.user_parameters[0].. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the Amazon DataZone project.

  • :domain_identifier (required, String) —

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

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

  • :glossary_terms (Array<String>) —

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

  • :name (required, String) —

    The name of the Amazon DataZone project.

  • :project_profile_id (String) —

    The ID of the project profile.

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

    The user parameters of the project.

Returns:

See Also:



3258
3259
3260
3261
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3258

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({
  designation: "PROJECT_OWNER", # required, accepts PROJECT_OWNER, PROJECT_CONTRIBUTOR, PROJECT_CATALOG_VIEWER, PROJECT_CATALOG_CONSUMER, PROJECT_CATALOG_STEWARD
  domain_identifier: "DomainId", # required
  member: { # required
    group_identifier: "String",
    user_identifier: "String",
  },
  project_identifier: "ProjectId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :designation (required, String) —

    The designation of the project membership.

  • :domain_identifier (required, String) —

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

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

    The project member whose project membership was created.

  • :project_identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3296
3297
3298
3299
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3296

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({
  description: "Description",
  domain_identifier: "DomainId", # required
  domain_unit_identifier: "DomainUnitId",
  environment_configurations: [
    {
      account_pools: ["AccountPoolId"],
      aws_account: {
        aws_account_id: "AwsAccountId",
        aws_account_id_path: "ParameterStorePath",
      },
      aws_region: {
        region_name: "RegionName",
        region_name_path: "ParameterStorePath",
      },
      configuration_parameters: {
        parameter_overrides: [
          {
            is_editable: false,
            name: "EnvironmentConfigurationParameterName",
            value: "String",
          },
        ],
        resolved_parameters: [
          {
            is_editable: false,
            name: "EnvironmentConfigurationParameterName",
            value: "String",
          },
        ],
        ssm_path: "ParameterStorePath",
      },
      deployment_mode: "ON_CREATE", # accepts ON_CREATE, ON_DEMAND
      deployment_order: 1,
      description: "Description",
      environment_blueprint_id: "EnvironmentBlueprintId", # required
      id: "EnvironmentConfigurationId",
      name: "EnvironmentConfigurationName", # required
    },
  ],
  name: "ProjectProfileName", # required
  status: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.environment_configurations #=> Array
resp.environment_configurations[0]. #=> Array
resp.environment_configurations[0].[0] #=> String
resp.environment_configurations[0].. #=> String
resp.environment_configurations[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].configuration_parameters.parameter_overrides #=> Array
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].is_editable #=> Boolean
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.resolved_parameters #=> Array
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].is_editable #=> Boolean
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.ssm_path #=> String
resp.environment_configurations[0].deployment_mode #=> String, one of "ON_CREATE", "ON_DEMAND"
resp.environment_configurations[0].deployment_order #=> Integer
resp.environment_configurations[0].description #=> String
resp.environment_configurations[0].environment_blueprint_id #=> String
resp.environment_configurations[0].id #=> String
resp.environment_configurations[0].name #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    A description of a project profile.

  • :domain_identifier (required, String) —

    A domain ID of the project profile.

  • :domain_unit_identifier (String) —

    A domain unit ID of the project profile.

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

    Environment configurations of the project profile.

  • :name (required, String) —

    Project profile name.

  • :status (String) —

    Project profile status.

Returns:

See Also:



3418
3419
3420
3421
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3418

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({
  action: "CREATE_LISTING_CHANGE_SET", # required, accepts CREATE_LISTING_CHANGE_SET, CREATE_SUBSCRIPTION_REQUEST
  client_token: "ClientToken",
  description: "Description",
  detail: { # required
    metadata_form_enforcement_detail: {
      required_metadata_forms: [
        {
          type_identifier: "FormTypeIdentifier", # required
          type_revision: "Revision", # required
        },
      ],
    },
  },
  domain_identifier: "DomainId", # required
  name: "RuleName", # required
  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"],
    },
  },
  target: { # required
    domain_unit_target: {
      domain_unit_id: "DomainUnitId", # required
      include_child_domain_units: false,
    },
  },
})

Response structure


resp.action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> 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.identifier #=> String
resp.name #=> String
resp.rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT"
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.target.domain_unit_target.domain_unit_id #=> String
resp.target.domain_unit_target.include_child_domain_units #=> Boolean
resp.target_type #=> String, one of "DOMAIN_UNIT"

Parameters:

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

    ({})

Options Hash (params):

  • :action (required, String) —

    The action 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.**

  • :description (String) —

    The description of the rule.

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

    The detail of the rule.

  • :domain_identifier (required, String) —

    The ID of the domain where the rule is created.

  • :name (required, String) —

    The name of the rule.

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

    The scope of the rule.

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

    The target of the rule.

Returns:

See Also:



3539
3540
3541
3542
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3539

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({
  asset_target_names: [
    {
      asset_id: "AssetId", # required
      target_name: "String", # required
    },
  ],
  client_token: "String",
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  granted_entity: { # required
    listing: {
      identifier: "ListingId", # required
      revision: "Revision", # required
    },
  },
  subscription_target_identifier: "SubscriptionTargetId",
})

Response structure


resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.error_message #=> 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].failure_cause.message #=> String
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].granted_timestamp #=> Time
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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.id #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.subscription_id #=> String
resp.subscription_target_id #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

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

    The entity to which the subscription is to be granted.

  • :subscription_target_identifier (String) —

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

Returns:

See Also:



3636
3637
3638
3639
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3636

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({
  client_token: "String",
  domain_identifier: "DomainId", # required
  metadata_forms: [
    {
      content: "FormInputContentString",
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
    },
  ],
  request_reason: "RequestReason", # required
  subscribed_listings: [ # required
    {
      identifier: "ListingId", # required
    },
  ],
  subscribed_principals: [ # required
    {
      project: {
        identifier: "ProjectId",
      },
    },
  ],
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.existing_subscription_id #=> String
resp.id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].content #=> String
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.request_reason #=> String
resp.reviewer_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> 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.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.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].item.product_listing.description #=> String
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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

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

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

    The metadata form included in the subscription request.

  • :request_reason (required, String) —

    The reason for the subscription request.

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

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

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

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

Returns:

See Also:



3768
3769
3770
3771
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3768

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({
  applicable_asset_types: ["TypeName"], # required
  authorized_principals: ["AuthorizedPrincipalIdentifier"], # required
  client_token: "String",
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  manage_access_role: "IamRoleArn", # required
  name: "SubscriptionTargetName", # required
  provider: "String",
  subscription_target_config: [ # required
    {
      content: "String", # required
      form_name: "FormName", # required
    },
  ],
  type: "String", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

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

    The authorized principals 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.**

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

  • :manage_access_role (required, String) —

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

  • :name (required, String) —

    The name of the subscription target.

  • :provider (String) —

    The provider of the subscription target.

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

    The configuration of the subscription target.

  • :type (required, String) —

    The type of the subscription target.

Returns:

See Also:



3874
3875
3876
3877
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3874

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.({
  client_token: "String",
  domain_identifier: "DomainId", # required
  user_identifier: "UserIdentifier", # required
  user_type: "IAM_USER", # accepts IAM_USER, IAM_ROLE, SSO_USER
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



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

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:



3956
3957
3958
3959
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3956

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.

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:



3982
3983
3984
3985
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3982

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.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4012
4013
4014
4015
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4012

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.

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:



4039
4040
4041
4042
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4039

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:



4073
4074
4075
4076
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4073

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

#delete_data_product(params = {}) ⇒ Struct

Deletes a data product in Amazon DataZone.

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:



4100
4101
4102
4103
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4100

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({
  client_token: "String",
  domain_identifier: "DomainId", # required
  identifier: "DataSourceId", # required
  retain_permissions_on_revoke_failure: false,
})

Response structure


resp.asset_forms_output #=> Array
resp.asset_forms_output[0].content #=> String
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.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> 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.redshift_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_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.connection_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.domain_id #=> String
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.environment_id #=> String
resp.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.id #=> String
resp.last_run_at #=> Time
resp.last_run_error_message.error_detail #=> String
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_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.name #=> String
resp.project_id #=> String
resp.publish_on_import #=> Boolean
resp.retain_permissions_on_revoke_failure #=> Boolean
resp.schedule.schedule #=> 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.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].failure_cause #=> 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.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].failure_cause #=> 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.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

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

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

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



4231
4232
4233
4234
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4231

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({
  client_token: "String",
  identifier: "DomainId", # required
  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):

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

  • :identifier (required, String) —

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

  • :skip_deletion_check (Boolean) —

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

Returns:

See Also:



4273
4274
4275
4276
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4273

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:



4299
4300
4301
4302
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4299

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:



4326
4327
4328
4329
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4326

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:



4358
4359
4360
4361
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4358

def delete_environment_action(params = {}, options = {})
  req = build_request(:delete_environment_action, 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:



4385
4386
4387
4388
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4385

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:



4412
4413
4414
4415
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4412

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

#delete_form_type(params = {}) ⇒ Struct

Delets and metadata form type in Amazon DataZone.

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:



4439
4440
4441
4442
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4439

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.

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:



4466
4467
4468
4469
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4466

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.

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:



4493
4494
4495
4496
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4493

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:



4519
4520
4521
4522
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4519

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:



4550
4551
4552
4553
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4550

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
  member: { # required
    group_identifier: "String",
    user_identifier: "String",
  },
  project_identifier: "ProjectId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

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

    The project member whose project membership is deleted.

  • :project_identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4585
4586
4587
4588
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4585

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:



4611
4612
4613
4614
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4611

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:



4645
4646
4647
4648
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4645

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.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.error_message #=> 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].failure_cause.message #=> String
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].granted_timestamp #=> Time
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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.id #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.subscription_id #=> String
resp.subscription_target_id #=> 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 where the subscription grant is deleted.

  • :identifier (required, String) —

    The ID of the subscription grant that is deleted.

Returns:

See Also:



4711
4712
4713
4714
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4711

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:



4738
4739
4740
4741
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4738

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:



4770
4771
4772
4773
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4770

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  form_name: "TimeSeriesFormName", # required
})

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4813
4814
4815
4816
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4813

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:



4844
4845
4846
4847
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4844

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:



4882
4883
4884
4885
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4882

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..accounts #=> Array
resp..accounts[0]. #=> String
resp..accounts[0]. #=> String
resp..accounts[0].supported_regions #=> Array
resp..accounts[0].supported_regions[0] #=> String
resp...lambda_execution_role_arn #=> String
resp...lambda_function_arn #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.resolution_strategy #=> String, one of "MANUAL"
resp.updated_by #=> 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:



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

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.

Examples:

Request syntax with placeholder values


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

Response structure


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



5035
5036
5037
5038
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5035

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.asset_id #=> String
resp.configuration.column_configuration.included_column_names #=> Array
resp.configuration.column_configuration.included_column_names[0] #=> 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.expression.equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.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.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.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.is_not_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.is_null.column_name #=> 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.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.like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.like.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.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.not_like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.value #=> String
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.description #=> String
resp.domain_id #=> String
resp.effective_column_names #=> Array
resp.effective_column_names[0] #=> String
resp.effective_row_filter #=> String
resp.error_message #=> String
resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "VALID", "INVALID"

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the asset filter.

Returns:

See Also:



5122
5123
5124
5125
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5122

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.forms_output #=> Hash
resp.forms_output["FormName"].required #=> Boolean
resp.forms_output["FormName"].type_name #=> String
resp.forms_output["FormName"].type_revision #=> String
resp.name #=> String
resp.origin_domain_id #=> String
resp.origin_project_id #=> String
resp.owning_project_id #=> String
resp.revision #=> 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:



5183
5184
5185
5186
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5183

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.expiration #=> Time
resp.connection_credentials.secret_access_key #=> String
resp.connection_credentials.session_token #=> String
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.athena_properties #=> Hash
resp.physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
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_client_application.a_ws_managed_client_application_reference #=> String
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_credentials.access_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.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.user_managed_client_application_client_secret #=> 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.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.secret_arn #=> String
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].glue_connection.connection_properties #=> Hash
resp.physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
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"
resp.physical_endpoints[0].glue_connection.creation_time #=> Time
resp.physical_endpoints[0].glue_connection.description #=> String
resp.physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.physical_endpoints[0].glue_connection.last_updated_time #=> Time
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.name #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> 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.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.python_properties #=> Hash
resp.physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> 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.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_name #=> String
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.error_message #=> String
resp.props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.hyper_pod_properties.cluster_arn #=> String
resp.props.hyper_pod_properties.cluster_name #=> 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.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.database_name #=> 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.lineage_sync.enabled #=> Boolean
resp.props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.props.redshift_properties.redshift_temp_dir #=> String
resp.props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.redshift_properties.storage.cluster_name #=> String
resp.props.redshift_properties.storage.workgroup_name #=> String
resp.props.s3_properties.error_message #=> String
resp.props.s3_properties.s3_access_grant_location_id #=> String
resp.props.s3_properties.s3_uri #=> String
resp.props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
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_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.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"

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:



5342
5343
5344
5345
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5342

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

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

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

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:



5414
5415
5416
5417
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5414

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.asset_forms_output #=> Array
resp.asset_forms_output[0].content #=> String
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.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> 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.redshift_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_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.connection_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.domain_id #=> String
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.environment_id #=> String
resp.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.id #=> String
resp.last_run_asset_count #=> Integer
resp.last_run_at #=> Time
resp.last_run_error_message.error_detail #=> String
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_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.name #=> String
resp.project_id #=> String
resp.publish_on_import #=> Boolean
resp.recommendation.enable_business_name_generation #=> Boolean
resp.schedule.schedule #=> 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.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].failure_cause #=> 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.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].failure_cause #=> 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.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.updated_at #=> Time

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:



5533
5534
5535
5536
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5533

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.created_at #=> Time
resp.data_source_configuration_snapshot #=> String
resp.data_source_id #=> String
resp.domain_id #=> String
resp.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.id #=> String
resp.lineage_summary.import_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "PARTIALLY_SUCCEEDED"
resp.project_id #=> String
resp.run_statistics_for_assets.added #=> Integer
resp.run_statistics_for_assets.failed #=> Integer
resp.run_statistics_for_assets.skipped #=> Integer
resp.run_statistics_for_assets.unchanged #=> Integer
resp.run_statistics_for_assets.updated #=> Integer
resp.started_at #=> Time
resp.status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.stopped_at #=> Time
resp.type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.updated_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:



5596
5597
5598
5599
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5596

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

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the specified Amazon DataZone domain.

Returns:

See Also:



5655
5656
5657
5658
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5655

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.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.last_updated_by #=> String
resp.name #=> String
resp.owners #=> Array
resp.owners[0].group.group_id #=> String
resp.owners[0].user.user_id #=> String
resp.parent_domain_unit_id #=> 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:



5707
5708
5709
5710
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5707

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



5805
5806
5807
5808
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5805

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.description #=> String
resp.domain_id #=> String
resp.environment_id #=> String
resp.id #=> String
resp.name #=> String
resp.parameters.aws_console_link.uri #=> 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:



5852
5853
5854
5855
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5852

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

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:



5910
5911
5912
5913
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5910

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.created_at #=> Time
resp.domain_id #=> String
resp.enabled_regions #=> Array
resp.enabled_regions[0] #=> String
resp.environment_blueprint_id #=> String
resp.environment_role_permission_boundary #=> String
resp.manage_access_role_arn #=> String
resp.provisioning_configurations #=> Array
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
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_role #=> String
resp.provisioning_role_arn #=> String
resp.regional_parameters #=> Hash
resp.regional_parameters["RegionName"] #=> Hash
resp.regional_parameters["RegionName"]["String"] #=> String
resp.updated_at #=> Time

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:



5966
5967
5968
5969
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 5966

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.expiration #=> Time
resp.secret_access_key #=> String
resp.session_token #=> String

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:



6005
6006
6007
6008
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6005

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. #=> String
resp. #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.environment_blueprint_id #=> String
resp.id #=> String
resp.name #=> String
resp.project_id #=> String
resp.updated_at #=> Time
resp.user_parameters #=> Array
resp.user_parameters[0].default_value #=> String
resp.user_parameters[0].description #=> String
resp.user_parameters[0].field_type #=> String
resp.user_parameters[0].is_editable #=> Boolean
resp.user_parameters[0].is_optional #=> Boolean
resp.user_parameters[0].key_name #=> String

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:



6066
6067
6068
6069
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6066

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.

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.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.imports #=> Array
resp.imports[0].name #=> String
resp.imports[0].revision #=> String
resp.model.smithy #=> String
resp.name #=> String
resp.origin_domain_id #=> String
resp.origin_project_id #=> String
resp.owning_project_id #=> String
resp.revision #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"

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:



6127
6128
6129
6130
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6127

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> String
resp.status #=> String, one of "DISABLED", "ENABLED"
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:



6181
6182
6183
6184
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6181

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.glossary_id #=> String
resp.id #=> String
resp.long_description #=> String
resp.name #=> String
resp.short_description #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.term_relations.classifies #=> Array
resp.term_relations.classifies[0] #=> String
resp.term_relations.is_a #=> Array
resp.term_relations.is_a[0] #=> 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:



6242
6243
6244
6245
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6242

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.group_name #=> String
resp.id #=> String
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"

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:



6281
6282
6283
6284
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6281

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:



6312
6313
6314
6315
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6312

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.created_at #=> Time
resp.created_by #=> String
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.details.lineage_run_details.sql_query_run_details.num_queries_failed #=> Integer
resp.details.lineage_run_details.sql_query_run_details.query_end_time #=> Time
resp.details.lineage_run_details.sql_query_run_details.query_start_time #=> Time
resp.details.lineage_run_details.sql_query_run_details.total_queries_processed #=> Integer
resp.domain_id #=> String
resp.end_time #=> Time
resp.error.message #=> 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.start_time #=> Time
resp.status #=> String, one of "SCHEDULED", "IN_PROGRESS", "SUCCESS", "PARTIALLY_SUCCEEDED", "FAILED", "ABORTED", "TIMED_OUT", "CANCELED"

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:



6371
6372
6373
6374
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6371

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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.event #=> String
resp.event_time #=> Time
resp.id #=> String
resp.processing_status #=> String, one of "REQUESTED", "PROCESSING", "SUCCESS", "FAILED"

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:



6415
6416
6417
6418
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6415

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
  event_timestamp: Time.now,
  identifier: "LineageNodeIdentifier", # required
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.downstream_nodes #=> Array
resp.downstream_nodes[0].event_timestamp #=> Time
resp.downstream_nodes[0].id #=> String
resp.event_timestamp #=> Time
resp.forms_output #=> Array
resp.forms_output[0].content #=> String
resp.forms_output[0].form_name #=> String
resp.forms_output[0].type_name #=> String
resp.forms_output[0].type_revision #=> String
resp.id #=> String
resp.name #=> String
resp.source_identifier #=> String
resp.type_name #=> String
resp.type_revision #=> String
resp.updated_at #=> Time
resp.updated_by #=> String
resp.upstream_nodes #=> Array
resp.upstream_nodes[0].event_timestamp #=> Time
resp.upstream_nodes[0].id #=> String

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.

  • :event_timestamp (Time, DateTime, Date, Integer, String) —

    The event time stamp for 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.

Returns:

See Also:



6493
6494
6495
6496
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6493

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.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.id #=> 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.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.latest_time_series_data_point_forms #=> Array
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].form_name #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].id #=> 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].type_identifier #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].type_revision #=> String
resp.item.asset_listing.owning_project_id #=> String
resp.item.data_product_listing.created_at #=> Time
resp.item.data_product_listing.data_product_id #=> String
resp.item.data_product_listing.data_product_revision #=> String
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.items #=> Array
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.item.data_product_listing.items[0].listing_id #=> String
resp.item.data_product_listing.items[0].listing_revision #=> String
resp.item.data_product_listing.owning_project_id #=> String
resp.listing_revision #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"
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.

  • :identifier (required, String) —

    The ID of the listing.

  • :listing_revision (String) —

    The revision of the listing.

Returns:

See Also:



6583
6584
6585
6586
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6583

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.id #=> String
resp.owning_project_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED"
resp.target.identifier #=> String
resp.target.revision #=> String
resp.target.type #=> String, one of "ASSET"
resp.type #=> String, one of "BUSINESS_DESCRIPTIONS"

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.

Returns:

See Also:



6632
6633
6634
6635
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6632

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.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
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
resp.environment_deployment_details.overall_deployment_status #=> String, one of "PENDING_DEPLOYMENT", "IN_PROGRESS", "SUCCESSFUL", "FAILED_VALIDATION", "FAILED_DEPLOYMENT"
resp.failure_reasons #=> Array
resp.failure_reasons[0].code #=> String
resp.failure_reasons[0].message #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.project_profile_id #=> String
resp.project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.user_parameters #=> Array
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_id #=> 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.user_parameters[0].. #=> String
resp.user_parameters[0]..region_name #=> String
resp.user_parameters[0].. #=> 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:



6705
6706
6707
6708
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6705

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.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.environment_configurations #=> Array
resp.environment_configurations[0]. #=> Array
resp.environment_configurations[0].[0] #=> String
resp.environment_configurations[0].. #=> String
resp.environment_configurations[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].configuration_parameters.parameter_overrides #=> Array
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].is_editable #=> Boolean
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.resolved_parameters #=> Array
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].is_editable #=> Boolean
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.ssm_path #=> String
resp.environment_configurations[0].deployment_mode #=> String, one of "ON_CREATE", "ON_DEMAND"
resp.environment_configurations[0].deployment_order #=> Integer
resp.environment_configurations[0].description #=> String
resp.environment_configurations[0].environment_blueprint_id #=> String
resp.environment_configurations[0].id #=> String
resp.environment_configurations[0].name #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"

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:



6776
6777
6778
6779
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6776

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.action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> 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.identifier #=> String
resp.last_updated_by #=> String
resp.name #=> String
resp.revision #=> String
resp.rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT"
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.target.domain_unit_target.domain_unit_id #=> String
resp.target.domain_unit_target.include_child_domain_units #=> Boolean
resp.target_type #=> String, one of "DOMAIN_UNIT"
resp.updated_at #=> Time

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:



6855
6856
6857
6858
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6855

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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.id #=> String
resp.retain_permissions #=> Boolean
resp.status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.subscribed_listing.description #=> String
resp.subscribed_listing.id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.error_message #=> 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.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.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.item.product_listing.description #=> String
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.name #=> String
resp.subscribed_listing.owner_project_id #=> String
resp.subscribed_listing.owner_project_name #=> String
resp.subscribed_listing.revision #=> String
resp.subscribed_principal.project.id #=> String
resp.subscribed_principal.project.name #=> String
resp.subscription_request_id #=> 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 subscription exists.

  • :identifier (required, String) —

    The ID of the subscription.

Returns:

See Also:



6936
6937
6938
6939
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 6936

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.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.error_message #=> 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].failure_cause.message #=> String
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].granted_timestamp #=> Time
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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.id #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.subscription_id #=> String
resp.subscription_target_id #=> 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 subscription grant exists.

  • :identifier (required, String) —

    The ID of the subscription grant.

Returns:

See Also:



7002
7003
7004
7005
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7002

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.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.existing_subscription_id #=> String
resp.id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].content #=> String
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.request_reason #=> String
resp.reviewer_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> 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.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.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].item.product_listing.description #=> String
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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> 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:



7097
7098
7099
7100
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7097

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.applicable_asset_types #=> Array
resp.applicable_asset_types[0] #=> String
resp.authorized_principals #=> Array
resp.authorized_principals[0] #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.environment_id #=> String
resp.id #=> String
resp.manage_access_role #=> String
resp.name #=> String
resp.project_id #=> String
resp.provider #=> String
resp.subscription_target_config #=> Array
resp.subscription_target_config[0].content #=> String
resp.subscription_target_config[0].form_name #=> String
resp.type #=> 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 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:



7166
7167
7168
7169
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7166

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
  form_name: "TimeSeriesFormName", # required
  identifier: "TimeSeriesDataPointIdentifier", # required
})

Response structure


resp.domain_id #=> String
resp.entity_id #=> String
resp.entity_type #=> String, one of "ASSET", "LISTING"
resp.form.content #=> String
resp.form.form_name #=> String
resp.form.id #=> String
resp.form.timestamp #=> Time
resp.form.type_identifier #=> String
resp.form.type_revision #=> String
resp.form_name #=> 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.

  • :form_name (required, String) —

    The name of the time series form that houses the data point that you want to get.

  • :identifier (required, String) —

    The ID of the data point that you want to get.

Returns:

See Also:



7225
7226
7227
7228
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7225

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
  type: "IAM", # accepts IAM, SSO
  user_identifier: "UserIdentifier", # required
})

Response structure


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

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.

  • :type (String) —

    The type of the user profile.

  • :user_identifier (required, String) —

    The identifier of the user for which you want to get the user profile.

Returns:

See Also:



7273
7274
7275
7276
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7273

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
  max_results: 1,
  name: "AccountPoolName",
  next_token: "PaginationToken",
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.items #=> Array
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].domain_unit_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].resolution_strategy #=> String, one of "MANUAL"
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.

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

  • :name (String) —

    The name of the account pool 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.

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

Returns:

See Also:



7342
7343
7344
7345
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7342

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
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].supported_regions #=> Array
resp.items[0].supported_regions[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.

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

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

Returns:

See Also:



7400
7401
7402
7403
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7400

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.

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({
  asset_identifier: "AssetId", # required
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  status: "VALID", # accepts VALID, INVALID
})

Response structure


resp.items #=> Array
resp.items[0].asset_id #=> String
resp.items[0].created_at #=> Time
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
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].error_message #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].status #=> String, one of "VALID", "INVALID"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list 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.

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

  • :status (String) —

    The status of the asset filter.

Returns:

See Also:



7468
7469
7470
7471
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7468

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.

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
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].revision #=> String
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.

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

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

Returns:

See Also:



7526
7527
7528
7529
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7526

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
  environment_identifier: "EnvironmentId",
  max_results: 1,
  name: "ConnectionName",
  next_token: "PaginationToken",
  project_identifier: "ProjectId", # required
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  type: "ATHENA", # accepts ATHENA, BIGQUERY, DATABRICKS, DOCUMENTDB, DYNAMODB, HYPERPOD, IAM, MYSQL, OPENSEARCH, ORACLE, POSTGRESQL, REDSHIFT, S3, SAPHANA, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, VERTICA, WORKFLOWS_MWAA
})

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.athena_properties #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
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.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_client_application.a_ws_managed_client_application_reference #=> String
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_credentials.access_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.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.user_managed_client_application_client_secret #=> 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.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.secret_arn #=> String
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].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.connection_schema_version #=> Integer
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"
resp.items[0].physical_endpoints[0].glue_connection.creation_time #=> Time
resp.items[0].physical_endpoints[0].glue_connection.description #=> String
resp.items[0].physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.items[0].physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.items[0].physical_endpoints[0].glue_connection.last_updated_time #=> Time
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.name #=> String
resp.items[0].physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> 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.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.python_properties #=> Hash
resp.items[0].physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> 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.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_name #=> String
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.error_message #=> 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.hyper_pod_properties.cluster_arn #=> String
resp.items[0].props.hyper_pod_properties.cluster_name #=> 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.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.database_name #=> 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.lineage_sync.enabled #=> Boolean
resp.items[0].props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.items[0].props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.items[0].props.redshift_properties.redshift_temp_dir #=> 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.storage.cluster_name #=> String
resp.items[0].props.redshift_properties.storage.workgroup_name #=> String
resp.items[0].props.s3_properties.error_message #=> String
resp.items[0].props.s3_properties.s3_access_grant_location_id #=> String
resp.items[0].props.s3_properties.s3_uri #=> 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.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_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].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"
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.

  • :environment_identifier (String) —

    The ID of the environment 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.

  • :name (String) —

    The name of the connection.

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

  • :project_identifier (required, String) —

    The ID of the project where you want to list connections.

  • :sort_by (String) —

    Specifies how you want to sort the listed connections.

  • :sort_order (String) —

    Specifies the sort order for the listed connections.

  • :type (String) —

    The type of connection.

Returns:

See Also:



7706
7707
7708
7709
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7706

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.

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].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].revision #=> 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:



7767
7768
7769
7770
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7767

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
  max_results: 1,
  next_token: "PaginationToken",
  status: "FAILED", # accepts FAILED, PUBLISHING_FAILED, SUCCEEDED_CREATED, SUCCEEDED_UPDATED, SKIPPED_ALREADY_IMPORTED, SKIPPED_ARCHIVED, SKIPPED_NO_ACCESS, UNCHANGED
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].data_asset_id #=> 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].data_source_run_id #=> String
resp.items[0].database #=> String
resp.items[0].error_message.error_detail #=> 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].lineage_summary.error_message #=> 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].project_id #=> String
resp.items[0].technical_description #=> String
resp.items[0].technical_name #=> String
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.

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

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

  • :status (String) —

    The status of the data source run.

Returns:

See Also:



7839
7840
7841
7842
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7839

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({
  data_source_identifier: "DataSourceId", # required
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  status: "REQUESTED", # accepts REQUESTED, RUNNING, FAILED, PARTIALLY_SUCCEEDED, SUCCESS
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].data_source_id #=> String
resp.items[0].error_message.error_detail #=> 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].id #=> String
resp.items[0].lineage_summary.import_status #=> String, one of "IN_PROGRESS", "SUCCESS", "FAILED", "PARTIALLY_SUCCEEDED"
resp.items[0].project_id #=> String
resp.items[0].run_statistics_for_assets.added #=> Integer
resp.items[0].run_statistics_for_assets.failed #=> Integer
resp.items[0].run_statistics_for_assets.skipped #=> Integer
resp.items[0].run_statistics_for_assets.unchanged #=> Integer
resp.items[0].run_statistics_for_assets.updated #=> Integer
resp.items[0].started_at #=> Time
resp.items[0].status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.items[0].stopped_at #=> Time
resp.items[0].type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :data_source_identifier (required, String) —

    The identifier of the data source.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

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

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

  • :status (String) —

    The status of the data source.

Returns:

See Also:



7914
7915
7916
7917
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 7914

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({
  connection_identifier: "String",
  domain_identifier: "DomainId", # required
  environment_identifier: "String",
  max_results: 1,
  name: "Name",
  next_token: "PaginationToken",
  project_identifier: "String", # required
  status: "CREATING", # accepts CREATING, FAILED_CREATION, READY, UPDATING, FAILED_UPDATE, RUNNING, DELETING, FAILED_DELETION
  type: "DataSourceType",
})

Response structure


resp.items #=> Array
resp.items[0].connection_id #=> String
resp.items[0].created_at #=> Time
resp.items[0].data_source_id #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.items[0].environment_id #=> String
resp.items[0].last_run_asset_count #=> Integer
resp.items[0].last_run_at #=> Time
resp.items[0].last_run_error_message.error_detail #=> String
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_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.items[0].name #=> String
resp.items[0].schedule.schedule #=> String
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].status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.items[0].type #=> String
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_identifier (String) —

    The ID of the connection.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to list the data sources.

  • :environment_identifier (String) —

    The identifier of the environment in which to list the 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.

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

  • :project_identifier (required, String) —

    The identifier of the project in which to list data sources.

  • :status (String) —

    The status of the data source.

  • :type (String) —

    The type of the data source.

Returns:

See Also:



8006
8007
8008
8009
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8006

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
  max_results: 1,
  next_token: "PaginationToken",
  parent_domain_unit_identifier: "DomainUnitId", # required
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> 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.

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

  • :parent_domain_unit_identifier (required, String) —

    The ID of the parent domain unit.

Returns:

See Also:



8062
8063
8064
8065
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8062

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({
  max_results: 1,
  next_token: "PaginationToken",
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATION_FAILED, DELETING, DELETED, DELETION_FAILED
})

Response structure


resp.items #=> Array
resp.items[0].arn #=> String
resp.items[0].created_at #=> Time
resp.items[0].description #=> String
resp.items[0].domain_version #=> String, one of "V1", "V2"
resp.items[0].id #=> String
resp.items[0].last_updated_at #=> Time
resp.items[0]. #=> String
resp.items[0].name #=> String
resp.items[0].portal_url #=> String
resp.items[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATION_FAILED", "DELETING", "DELETED", "DELETION_FAILED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :status (String) —

    The status of the data source.

Returns:

See Also:



8121
8122
8123
8124
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8121

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_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.owners #=> Array
resp.owners[0].group.group_id #=> String
resp.owners[0].user.user_id #=> 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_identifier (required, String) —

    The ID of the entity that you want to list.

  • :entity_type (required, String) —

    The type 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:



8180
8181
8182
8183
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8180

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
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].description #=> String
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.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.

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

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

Returns:

See Also:



8240
8241
8242
8243
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8240

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].created_at #=> Time
resp.items[0].domain_id #=> String
resp.items[0].enabled_regions #=> Array
resp.items[0].enabled_regions[0] #=> String
resp.items[0].environment_blueprint_id #=> String
resp.items[0].environment_role_permission_boundary #=> String
resp.items[0].manage_access_role_arn #=> String
resp.items[0].provisioning_configurations #=> Array
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.items[0].provisioning_configurations[0].lake_formation_configuration.location_registration_role #=> String
resp.items[0].provisioning_role_arn #=> 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].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 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:



8307
8308
8309
8310
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8307

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
  managed: false,
  max_results: 1,
  name: "EnvironmentBlueprintName",
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].description #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].provider #=> String
resp.items[0].provisioning_properties.cloud_formation.template_url #=> String
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.

  • :managed (Boolean) —

    Specifies whether the environment blueprint is managed by Amazon DataZone.

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

  • :name (String) —

    The name of the Amazon DataZone environment.

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

Returns:

See Also:



8373
8374
8375
8376
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8373

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({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId",
  max_results: 1,
  name: "EnvironmentProfileName",
  next_token: "PaginationToken",
  project_identifier: "ProjectId",
})

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].environment_blueprint_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].project_id #=> String
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_blueprint_identifier (String) —

    The identifier of the blueprint that was used to create the environment profiles that you want to list.

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

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

  • :project_identifier (String) —

    The identifier of the Amazon DataZone project.

Returns:

See Also:



8457
8458
8459
8460
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8457

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({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId",
  environment_profile_identifier: "EnvironmentProfileId",
  max_results: 1,
  name: "String",
  next_token: "PaginationToken",
  project_identifier: "ProjectId", # required
  provider: "String",
  status: "ACTIVE", # accepts ACTIVE, CREATING, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED, VALIDATION_FAILED, SUSPENDED, DISABLED, EXPIRED, DELETED, INACCESSIBLE
})

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].environment_configuration_id #=> String
resp.items[0].environment_profile_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].project_id #=> 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].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (String) —

    The identifier of the Amazon Web Services account where you want to list environments.

  • :aws_account_region (String) —

    The Amazon Web Services region where you want to list environments.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_blueprint_identifier (String) —

    The identifier of the Amazon DataZone blueprint.

  • :environment_profile_identifier (String) —

    The identifier of the environment profile.

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

  • :name (String) —

    The name of the environment.

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

  • :project_identifier (required, String) —

    The identifier of the Amazon DataZone project.

  • :provider (String) —

    The provider of the environment.

  • :status (String) —

    The status of the environments that you want to list.

Returns:

See Also:



8553
8554
8555
8556
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8553

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
  max_results: 1,
  next_token: "PaginationToken",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status: "SCHEDULED", # accepts SCHEDULED, IN_PROGRESS, SUCCESS, PARTIALLY_SUCCEEDED, FAILED, ABORTED, TIMED_OUT, CANCELED
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].end_time #=> Time
resp.items[0].error.message #=> 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].start_time #=> Time
resp.items[0].status #=> String, one of "SCHEDULED", "IN_PROGRESS", "SUCCESS", "PARTIALLY_SUCCEEDED", "FAILED", "ABORTED", "TIMED_OUT", "CANCELED"
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.

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

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

  • :sort_order (String) —

    Specifies the order in which job runs are to be sorted.

  • :status (String) —

    The status of a job run.

Returns:

See Also:



8625
8626
8627
8628
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8625

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,
  next_token: "PaginationToken",
  processing_status: "REQUESTED", # accepts REQUESTED, PROCESSING, SUCCESS, FAILED
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  timestamp_after: Time.now,
  timestamp_before: Time.now,
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
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.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.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.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].event_summary.open_lineage_run_event_summary.run_id #=> String
resp.items[0].event_time #=> Time
resp.items[0].id #=> String
resp.items[0].processing_status #=> String, one of "REQUESTED", "PROCESSING", "SUCCESS", "FAILED"
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.

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

  • :processing_status (String) —

    The processing status of a lineage event.

  • :sort_order (String) —

    The sort order of the 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.

Returns:

See Also:



8706
8707
8708
8709
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8706

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({
  direction: "UPSTREAM", # accepts UPSTREAM, DOWNSTREAM
  domain_identifier: "DomainId", # required
  event_timestamp_gte: Time.now,
  event_timestamp_lte: Time.now,
  identifier: "LineageNodeIdentifier", # required
  max_results: 1,
  next_token: "PaginationToken",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.next_token #=> String
resp.nodes #=> Array
resp.nodes[0].created_at #=> Time
resp.nodes[0].created_by #=> String
resp.nodes[0].description #=> String
resp.nodes[0].domain_id #=> String
resp.nodes[0].event_timestamp #=> Time
resp.nodes[0].id #=> String
resp.nodes[0].name #=> String
resp.nodes[0].source_identifier #=> String
resp.nodes[0].type_name #=> String
resp.nodes[0].type_revision #=> String
resp.nodes[0].updated_at #=> Time
resp.nodes[0].updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The ID of the domain where you want to list the history of the specified data lineage node.

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

  • :identifier (required, String) —

    The ID of the data lineage node whose history you want to list.

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

  • :sort_order (String) —

    The order by which you want data lineage node history to be sorted.

Returns:

See Also:



8793
8794
8795
8796
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8793

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.

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
  max_results: 1,
  next_token: "PaginationToken",
  status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELED, SUCCEEDED, FAILED
  type: "BUSINESS_DESCRIPTIONS", # accepts BUSINESS_DESCRIPTIONS
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].owning_project_id #=> String
resp.items[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED"
resp.items[0].target.identifier #=> String
resp.items[0].target.revision #=> String
resp.items[0].target.type #=> String, one of "ASSET"
resp.items[0].type #=> String, one of "BUSINESS_DESCRIPTIONS"
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.

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

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

  • :status (String) —

    The status of the metadata generation runs.

  • :type (String) —

    The type of the metadata generation runs.

Returns:

See Also:



8862
8863
8864
8865
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8862

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({
  after_timestamp: Time.now,
  before_timestamp: Time.now,
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  subjects: ["String"],
  task_status: "ACTIVE", # accepts ACTIVE, INACTIVE
  type: "TASK", # required, accepts TASK, EVENT
})

Response structure


resp.next_token #=> String
resp.notifications #=> Array
resp.notifications[0].action_link #=> String
resp.notifications[0].creation_timestamp #=> Time
resp.notifications[0].domain_identifier #=> String
resp.notifications[0].identifier #=> String
resp.notifications[0].last_updated_timestamp #=> Time
resp.notifications[0].message #=> String
resp.notifications[0].metadata #=> Hash
resp.notifications[0].metadata["String"] #=> String
resp.notifications[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.notifications[0].title #=> String
resp.notifications[0].topic.resource.id #=> String
resp.notifications[0].topic.resource.name #=> String
resp.notifications[0].topic.resource.type #=> String, one of "PROJECT"
resp.notifications[0].topic.role #=> String, one of "PROJECT_OWNER", "PROJECT_CONTRIBUTOR", "PROJECT_VIEWER", "DOMAIN_OWNER", "PROJECT_SUBSCRIBER"
resp.notifications[0].topic.subject #=> String
resp.notifications[0].type #=> String, one of "TASK", "EVENT"

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

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

  • :subjects (Array<String>) —

    The subjects of notifications.

  • :task_status (String) —

    The task status of notifications.

  • :type (required, String) —

    The type of notifications.

Returns:

See Also:



8947
8948
8949
8950
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 8947

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_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE, ASSET_TYPE
  max_results: 1,
  next_token: "PaginationToken",
  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
})

Response structure


resp.grant_list #=> Array
resp.grant_list[0].created_at #=> Time
resp.grant_list[0].created_by #=> String
resp.grant_list[0].detail.add_to_project_member_pool.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_asset_type.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_domain_unit.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_environment_profile.domain_unit_id #=> String
resp.grant_list[0].detail.create_form_type.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_glossary.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.create_project.include_child_domain_units #=> Boolean
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.override_domain_unit_owners.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.override_project_owners.include_child_domain_units #=> Boolean
resp.grant_list[0].detail.use_asset_type.domain_unit_id #=> String
resp.grant_list[0].grant_id #=> String
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].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_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.project.project_identifier #=> String
resp.grant_list[0].principal.user.user_identifier #=> 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_identifier (required, String) —

    The ID of the entity for which you want to list policy grants.

  • :entity_type (required, String) —

    The type of entity for which you want to list policy grants.

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

  • :policy_type (required, String) —

    The type of policy that you want to list.

Returns:

See Also:



9032
9033
9034
9035
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9032

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
  max_results: 1,
  next_token: "PaginationToken",
  project_identifier: "ProjectId", # required
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.members #=> Array
resp.members[0].designation #=> String, one of "PROJECT_OWNER", "PROJECT_CONTRIBUTOR", "PROJECT_CATALOG_VIEWER", "PROJECT_CATALOG_CONSUMER", "PROJECT_CATALOG_STEWARD"
resp.members[0].member_details.group.group_id #=> String
resp.members[0].member_details.user.user_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 in which you want to list project 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.

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

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

Returns:

See Also:



9097
9098
9099
9100
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9097

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
  max_results: 1,
  name: "ProjectProfileName",
  next_token: "PaginationToken",
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].domain_unit_id #=> String
resp.items[0].id #=> String
resp.items[0].last_updated_at #=> Time
resp.items[0].name #=> String
resp.items[0].status #=> String, one of "ENABLED", "DISABLED"
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.

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

  • :name (String) —

    The name of a project profile.

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

  • :sort_by (String) —

    Specifies by what to sort project profiles.

  • :sort_order (String) —

    Specifies the sort order of the project profiles.

Returns:

See Also:



9167
9168
9169
9170
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9167

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
  group_identifier: "String",
  max_results: 1,
  name: "ProjectName",
  next_token: "PaginationToken",
  user_identifier: "String",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].domain_unit_id #=> String
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].id #=> String
resp.items[0].name #=> String
resp.items[0].project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
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.

  • :group_identifier (String) —

    The identifier of a group.

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

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

  • :user_identifier (String) —

    The identifier of the Amazon DataZone user.

Returns:

See Also:



9240
9241
9242
9243
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9240

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({
  action: "CREATE_LISTING_CHANGE_SET", # accepts CREATE_LISTING_CHANGE_SET, CREATE_SUBSCRIPTION_REQUEST
  asset_types: ["AssetTypeIdentifier"],
  data_product: false,
  domain_identifier: "DomainId", # required
  include_cascaded: false,
  max_results: 1,
  next_token: "PaginationToken",
  project_ids: ["ProjectId"],
  rule_type: "METADATA_FORM_ENFORCEMENT", # accepts METADATA_FORM_ENFORCEMENT
  target_identifier: "String", # required
  target_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
})

Response structure


resp.items #=> Array
resp.items[0].action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.items[0].identifier #=> String
resp.items[0].last_updated_by #=> String
resp.items[0].name #=> String
resp.items[0].revision #=> String
resp.items[0].rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT"
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].target.domain_unit_target.domain_unit_id #=> String
resp.items[0].target.domain_unit_target.include_child_domain_units #=> Boolean
resp.items[0].target_type #=> String, one of "DOMAIN_UNIT"
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action (String) —

    The action of the rule.

  • :asset_types (Array<String>) —

    The asset types of the rule.

  • :data_product (Boolean) —

    The data product of the rule.

  • :domain_identifier (required, String) —

    The ID of the domain in which the rules are to be listed.

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

  • :project_ids (Array<String>) —

    The IDs of projects in which rules are to be listed.

  • :rule_type (String) —

    The type of the rule.

  • :target_identifier (required, String) —

    The target ID of the rule.

  • :target_type (required, String) —

    The target type of the rule.

Returns:

See Also:



9345
9346
9347
9348
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9345

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",
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_id: "ProjectId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  subscribed_listing_id: "ListingId",
  subscription_id: "SubscriptionId",
  subscription_target_id: "SubscriptionTargetId",
})

Response structure


resp.items #=> Array
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].asset_scope.asset_id #=> String
resp.items[0].assets[0].asset_scope.error_message #=> 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].failure_cause.message #=> String
resp.items[0].assets[0].failure_timestamp #=> Time
resp.items[0].assets[0].granted_timestamp #=> Time
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].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].granted_entity.listing.id #=> String
resp.items[0].granted_entity.listing.revision #=> String
resp.items[0].id #=> String
resp.items[0].status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.items[0].subscription_id #=> String
resp.items[0].subscription_target_id #=> String
resp.items[0].updated_at #=> Time
resp.items[0].updated_by #=> 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.

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

  • :owning_project_id (String) —

    The ID of the owning project of the subscription grants.

  • :sort_by (String) —

    Specifies the way of sorting the results of this action.

  • :sort_order (String) —

    Specifies the sort order of this action.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing.

  • :subscription_id (String) —

    The identifier of the subscription.

  • :subscription_target_id (String) —

    The identifier of the subscription target.

Returns:

See Also:



9446
9447
9448
9449
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9446

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({
  approver_project_id: "ProjectId",
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_id: "ProjectId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status: "PENDING", # accepts PENDING, ACCEPTED, REJECTED
  subscribed_listing_id: "ListingId",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].decision_comment #=> String
resp.items[0].domain_id #=> String
resp.items[0].existing_subscription_id #=> String
resp.items[0].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.items[0].request_reason #=> String
resp.items[0].reviewer_id #=> String
resp.items[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.items[0].subscribed_listings #=> Array
resp.items[0].subscribed_listings[0].description #=> String
resp.items[0].subscribed_listings[0].id #=> 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.error_message #=> 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.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.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].item.product_listing.description #=> String
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].name #=> String
resp.items[0].subscribed_listings[0].owner_project_id #=> String
resp.items[0].subscribed_listings[0].owner_project_name #=> String
resp.items[0].subscribed_listings[0].revision #=> 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].updated_at #=> Time
resp.items[0].updated_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :approver_project_id (String) —

    The identifier of the subscription request approver's project.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

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

  • :owning_project_id (String) —

    The identifier of the project for the subscription requests.

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

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

Returns:

See Also:



9574
9575
9576
9577
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9574

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
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.items #=> Array
resp.items[0].applicable_asset_types #=> Array
resp.items[0].applicable_asset_types[0] #=> String
resp.items[0].authorized_principals #=> Array
resp.items[0].authorized_principals[0] #=> String
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].environment_id #=> String
resp.items[0].id #=> String
resp.items[0].manage_access_role #=> String
resp.items[0].name #=> String
resp.items[0].project_id #=> String
resp.items[0].provider #=> String
resp.items[0].subscription_target_config #=> Array
resp.items[0].subscription_target_config[0].content #=> String
resp.items[0].subscription_target_config[0].form_name #=> String
resp.items[0].type #=> String
resp.items[0].updated_at #=> Time
resp.items[0].updated_by #=> String
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.

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

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

Returns:

See Also:



9659
9660
9661
9662
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9659

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({
  approver_project_id: "ProjectId",
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_id: "ProjectId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status: "APPROVED", # accepts APPROVED, REVOKED, CANCELLED
  subscribed_listing_id: "ListingId",
  subscription_request_identifier: "SubscriptionRequestId",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].retain_permissions #=> Boolean
resp.items[0].status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.items[0].subscribed_listing.description #=> String
resp.items[0].subscribed_listing.id #=> String
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.items[0].subscribed_listing.item.asset_listing.asset_scope.error_message #=> 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.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.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.item.product_listing.description #=> String
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.name #=> String
resp.items[0].subscribed_listing.owner_project_id #=> String
resp.items[0].subscribed_listing.owner_project_name #=> String
resp.items[0].subscribed_listing.revision #=> String
resp.items[0].subscribed_principal.project.id #=> String
resp.items[0].subscribed_principal.project.name #=> String
resp.items[0].subscription_request_id #=> String
resp.items[0].updated_at #=> Time
resp.items[0].updated_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :approver_project_id (String) —

    The identifier of the project for the subscription's approver.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

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

  • :owning_project_id (String) —

    The identifier of the owning project.

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

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

  • :subscription_request_identifier (String) —

    The identifier of the subscription request for the subscriptions that you want to list.

Returns:

See Also:



9784
9785
9786
9787
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9784

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:



9813
9814
9815
9816
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9813

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
  ended_at: Time.now,
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  form_name: "TimeSeriesFormName", # required
  max_results: 1,
  next_token: "PaginationToken",
  started_at: Time.now,
})

Response structure


resp.items #=> Array
resp.items[0].content_summary #=> String
resp.items[0].form_name #=> String
resp.items[0].id #=> String
resp.items[0].timestamp #=> Time
resp.items[0].type_identifier #=> String
resp.items[0].type_revision #=> 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.

  • :ended_at (Time, DateTime, Date, Integer, String) —

    The timestamp at which the data points that you wanted to list ended.

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

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

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

  • :started_at (Time, DateTime, Date, Integer, String) —

    The timestamp at which the data points that you want to list started.

Returns:

See Also:



9889
9890
9891
9892
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9889

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  event: "data", # required
})

Response structure


resp.domain_id #=> String
resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



9932
9933
9934
9935
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 9932

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  forms: [ # required
    {
      content: "TimeSeriesDataPointFormInputContentString",
      form_name: "TimeSeriesFormName", # required
      timestamp: Time.now, # required
      type_identifier: "FormTypeIdentifier", # required
      type_revision: "Revision",
    },
  ],
})

Response structure


resp.domain_id #=> String
resp.entity_id #=> String
resp.entity_type #=> String, one of "ASSET", "LISTING"
resp.forms #=> Array
resp.forms[0].content #=> String
resp.forms[0].form_name #=> String
resp.forms[0].id #=> String
resp.forms[0].timestamp #=> Time
resp.forms[0].type_identifier #=> String
resp.forms[0].type_revision #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



10003
10004
10005
10006
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10003

def post_time_series_data_points(params = {}, options = {})
  req = build_request(:post_time_series_data_points, 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
  enabled_regions: ["RegionName"], # required
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
  environment_role_permission_boundary: "PolicyArn",
  manage_access_role_arn: "RoleArn",
  provisioning_configurations: [
    {
      lake_formation_configuration: {
        location_registration_exclude_s3_locations: ["S3Location"],
        location_registration_role: "RoleArn",
      },
    },
  ],
  provisioning_role_arn: "RoleArn",
  regional_parameters: {
    "RegionName" => {
      "String" => "String",
    },
  },
})

Response structure


resp.created_at #=> Time
resp.domain_id #=> String
resp.enabled_regions #=> Array
resp.enabled_regions[0] #=> String
resp.environment_blueprint_id #=> String
resp.environment_role_permission_boundary #=> String
resp.manage_access_role_arn #=> String
resp.provisioning_configurations #=> Array
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
resp.provisioning_configurations[0].lake_formation_configuration.location_registration_role #=> String
resp.provisioning_role_arn #=> String
resp.regional_parameters #=> Hash
resp.regional_parameters["RegionName"] #=> Hash
resp.regional_parameters["RegionName"]["String"] #=> String
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

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

    Specifies the enabled Amazon Web Services Regions.

  • :environment_blueprint_identifier (required, String) —

    The identifier of the environment blueprint.

  • :environment_role_permission_boundary (String) —

    The environment role permissions boundary.

  • :manage_access_role_arn (String) —

    The ARN of the manage access role.

  • :provisioning_configurations (Array<Types::ProvisioningConfiguration>) —

    The provisioning configuration of a blueprint.

  • :provisioning_role_arn (String) —

    The ARN of the provisioning role.

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

    The regional parameters in the environment blueprint.

Returns:

See Also:



10095
10096
10097
10098
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10095

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  reject_choices: [
    {
      prediction_choices: [1],
      prediction_target: "String", # required
    },
  ],
  reject_rule: {
    rule: "ALL", # accepts ALL, NONE
    threshold: 1.0,
  },
  revision: "Revision",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :identifier (required, String) —

    The identifier of the prediction.

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

  • :reject_rule (Types::RejectRule) —

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

  • :revision (String) —

    The revision that is to be made to the asset.

Returns:

See Also:



10163
10164
10165
10166
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10163

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({
  decision_comment: "DecisionComment",
  domain_identifier: "DomainId", # required
  identifier: "SubscriptionRequestId", # required
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.existing_subscription_id #=> String
resp.id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].content #=> String
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.request_reason #=> String
resp.reviewer_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> 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.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.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].item.product_listing.description #=> String
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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :decision_comment (String) —

    The decision comment of the rejected subscription request.

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

Returns:

See Also:



10261
10262
10263
10264
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10261

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT
  owner: { # required
    group: {
      group_identifier: "GroupIdentifier", # required
    },
    user: {
      user_identifier: "UserIdentifier", # required
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The ID of the domain where you want to remove an owner from an entity.

  • :entity_identifier (required, String) —

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

  • :entity_type (required, String) —

    The type 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10310
10311
10312
10313
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10310

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({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE, ASSET_TYPE
  grant_identifier: "GrantIdentifier",
  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
    domain_unit: {
      domain_unit_designation: "OWNER", # required, accepts OWNER
      domain_unit_grant_filter: {
        all_domain_units_grant_filter: {
        },
      },
      domain_unit_identifier: "DomainUnitId",
    },
    group: {
      group_identifier: "GroupIdentifier",
    },
    project: {
      project_designation: "OWNER", # required, accepts OWNER, CONTRIBUTOR, PROJECT_CATALOG_STEWARD
      project_grant_filter: {
        domain_unit_filter: {
          domain_unit: "DomainUnitId", # required
          include_child_domain_units: false,
        },
      },
      project_identifier: "ProjectId",
    },
    user: {
      all_users_grant_filter: {
      },
      user_identifier: "UserIdentifier",
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The ID of the domain where 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.

  • :entity_type (required, String) —

    The type of the entity 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.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



10388
10389
10390
10391
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10388

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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.id #=> String
resp.retain_permissions #=> Boolean
resp.status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.subscribed_listing.description #=> String
resp.subscribed_listing.id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listing.item.asset_listing.asset_scope.error_message #=> 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.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.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.item.product_listing.description #=> String
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.name #=> String
resp.subscribed_listing.owner_project_id #=> String
resp.subscribed_listing.owner_project_name #=> String
resp.subscribed_listing.revision #=> String
resp.subscribed_principal.project.id #=> String
resp.subscribed_principal.project.name #=> String
resp.subscription_request_id #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

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:



10475
10476
10477
10478
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10475

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.

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({
  additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS, TEXT_MATCH_RATIONALE
  domain_identifier: "DomainId", # required
  filters: {
    and: [
      {
        # recursive FilterClause
      },
    ],
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString", # required
    },
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_identifier: "ProjectId",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  search_scope: "ASSET", # required, accepts ASSET, GLOSSARY, GLOSSARY_TERM, DATA_PRODUCT
  search_text: "SearchText",
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.items #=> Array
resp.items[0].asset_item.additional_attributes.forms_output #=> Array
resp.items[0].asset_item.additional_attributes.forms_output[0].content #=> String
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.latest_time_series_data_point_forms_output #=> Array
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].form_name #=> 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.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].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.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].match_offsets #=> Array
resp.items[0].asset_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
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].text #=> 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].content #=> String
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.created_at #=> Time
resp.items[0].asset_item.created_by #=> String
resp.items[0].asset_item.description #=> String
resp.items[0].asset_item.domain_id #=> String
resp.items[0].asset_item.external_identifier #=> 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.governed_glossary_terms #=> Array
resp.items[0].asset_item.governed_glossary_terms[0] #=> String
resp.items[0].asset_item.identifier #=> String
resp.items[0].asset_item.name #=> String
resp.items[0].asset_item.owning_project_id #=> String
resp.items[0].asset_item.type_identifier #=> String
resp.items[0].asset_item.type_revision #=> 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].match_offsets #=> Array
resp.items[0].data_product_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
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].text #=> 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.description #=> String
resp.items[0].data_product_item.domain_id #=> 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.glossary_terms #=> Array
resp.items[0].data_product_item.glossary_terms[0] #=> 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].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].match_offsets #=> Array
resp.items[0].glossary_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
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].text #=> String
resp.items[0].glossary_item.created_at #=> Time
resp.items[0].glossary_item.created_by #=> String
resp.items[0].glossary_item.description #=> String
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.status #=> String, one of "DISABLED", "ENABLED"
resp.items[0].glossary_item.updated_at #=> Time
resp.items[0].glossary_item.updated_by #=> String
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_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].match_offsets #=> Array
resp.items[0].glossary_term_item.additional_attributes.match_rationale[0].text_matches[0].match_offsets[0].end_offset #=> Integer
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].text #=> String
resp.items[0].glossary_term_item.created_at #=> Time
resp.items[0].glossary_term_item.created_by #=> String
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.long_description #=> String
resp.items[0].glossary_term_item.name #=> String
resp.items[0].glossary_term_item.short_description #=> String
resp.items[0].glossary_term_item.status #=> String, one of "ENABLED", "DISABLED"
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.term_relations.is_a #=> Array
resp.items[0].glossary_term_item.term_relations.is_a[0] #=> 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.usage_restrictions #=> Array
resp.items[0].glossary_term_item.usage_restrictions[0] #=> String, one of "ASSET_GOVERNED_TERMS"
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :additional_attributes (Array<String>) —

    Specifies additional attributes for the Search action.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :filters (Types::FilterClause) —

    Specifies the search filters.

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

  • :owning_project_identifier (String) —

    The identifier of the owning project specified for the search.

  • :search_in (Array<Types::SearchInItem>) —

    The details of the search.

  • :search_scope (required, String) —

    The scope of the search.

  • :search_text (String) —

    Specifies the text for which to search.

  • :sort (Types::SearchSort) —

    Specifies the way in which the search results are to be sorted.

Returns:

See Also:



10676
10677
10678
10679
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10676

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
  max_results: 1,
  next_token: "PaginationToken",
  search_text: "GroupSearchText",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].group_name #=> String
resp.items[0].id #=> String
resp.items[0].status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"
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.

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

  • :search_text (String) —

    Specifies the text for which to search.

Returns:

See Also:



10738
10739
10740
10741
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10738

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 (records of an asset at a given time) 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_listings({
  additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS, TEXT_MATCH_RATIONALE
  aggregations: [
    {
      attribute: "Attribute", # required
      display_value: "AggregationDisplayValue",
    },
  ],
  domain_identifier: "DomainId", # required
  filters: {
    and: [
      {
        # recursive FilterClause
      },
    ],
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString", # required
    },
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  max_results: 1,
  next_token: "PaginationToken",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  search_text: "SearchListingsInputSearchTextString",
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.aggregates #=> Array
resp.aggregates[0].attribute #=> String
resp.aggregates[0].display_value #=> String
resp.aggregates[0].items #=> Array
resp.aggregates[0].items[0].count #=> Integer
resp.aggregates[0].items[0].display_value #=> String
resp.aggregates[0].items[0].value #=> String
resp.items #=> Array
resp.items[0].asset_listing.additional_attributes.forms #=> String
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].content_summary #=> String
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].id #=> 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].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.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].match_offsets #=> Array
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.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].text #=> String
resp.items[0].asset_listing.created_at #=> Time
resp.items[0].asset_listing.description #=> 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.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.listing_created_by #=> String
resp.items[0].asset_listing.listing_id #=> String
resp.items[0].asset_listing.listing_revision #=> String
resp.items[0].asset_listing.listing_updated_by #=> String
resp.items[0].asset_listing.name #=> String
resp.items[0].asset_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].match_offsets #=> Array
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.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].text #=> String
resp.items[0].data_product_listing.created_at #=> Time
resp.items[0].data_product_listing.description #=> 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.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.items #=> Array
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.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.listing_created_by #=> 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.listing_updated_by #=> String
resp.items[0].data_product_listing.name #=> String
resp.items[0].data_product_listing.owning_project_id #=> String
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :additional_attributes (Array<String>) —

    Specifies additional attributes for the search.

  • :aggregations (Array<Types::AggregationListItem>) —

    Enables you to specify one or more attributes to compute and return counts grouped by field values.

  • :domain_identifier (required, String) —

    The identifier of the domain in which to search listings.

  • :filters (Types::FilterClause) —

    Specifies the filters for the search of listings.

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

  • :search_in (Array<Types::SearchInItem>) —

    The details of the search.

  • :search_text (String) —

    Specifies the text for which to search.

  • :sort (Types::SearchSort) —

    Specifies the way for sorting the search results.

Returns:

See Also:



10909
10910
10911
10912
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 10909

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.

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
  filters: {
    and: [
      {
        # recursive FilterClause
      },
    ],
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString", # required
    },
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  managed: false, # required
  max_results: 1,
  next_token: "PaginationToken",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  search_scope: "ASSET_TYPE", # required, accepts ASSET_TYPE, FORM_TYPE, LINEAGE_NODE_TYPE
  search_text: "SearchText",
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.items #=> Array
resp.items[0].asset_type_item.created_at #=> Time
resp.items[0].asset_type_item.created_by #=> String
resp.items[0].asset_type_item.description #=> String
resp.items[0].asset_type_item.domain_id #=> String
resp.items[0].asset_type_item.forms_output #=> Hash
resp.items[0].asset_type_item.forms_output["FormName"].required #=> Boolean
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.name #=> 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.owning_project_id #=> String
resp.items[0].asset_type_item.revision #=> 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.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.domain_id #=> 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].form_type_item.model.smithy #=> String
resp.items[0].form_type_item.name #=> 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.owning_project_id #=> String
resp.items[0].form_type_item.revision #=> String
resp.items[0].form_type_item.status #=> String, one of "ENABLED", "DISABLED"
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.description #=> String
resp.items[0].lineage_node_type_item.domain_id #=> String
resp.items[0].lineage_node_type_item.forms_output #=> Hash
resp.items[0].lineage_node_type_item.forms_output["FormName"].required #=> Boolean
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.name #=> String
resp.items[0].lineage_node_type_item.revision #=> String
resp.items[0].lineage_node_type_item.updated_at #=> Time
resp.items[0].lineage_node_type_item.updated_by #=> String
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.

  • :filters (Types::FilterClause) —

    The filters for the SearchTypes action.

  • :managed (required, Boolean) —

    Specifies whether the search is managed.

  • :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_in (Array<Types::SearchInItem>) —

    The details of the search.

  • :search_scope (required, String) —

    Specifies the scope of the search for types.

  • :search_text (String) —

    Specifies the text for which to search.

  • :sort (Types::SearchSort) —

    The specifies the way to sort the SearchTypes results.

Returns:

See Also:



11048
11049
11050
11051
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11048

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
  max_results: 1,
  next_token: "PaginationToken",
  search_text: "UserSearchText",
  user_type: "SSO_USER", # required, accepts SSO_USER, DATAZONE_USER, DATAZONE_SSO_USER, DATAZONE_IAM_USER
})

Response structure


resp.items #=> Array
resp.items[0].details.iam.arn #=> String
resp.items[0].details.sso.first_name #=> String
resp.items[0].details.sso.last_name #=> String
resp.items[0].details.sso.username #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].status #=> String, one of "ASSIGNED", "NOT_ASSIGNED", "ACTIVATED", "DEACTIVATED"
resp.items[0].type #=> String, one of "IAM", "SSO"
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.

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

  • :search_text (String) —

    Specifies the text for which to search.

  • :user_type (required, String) —

    Specifies the user type for the SearchUserProfiles action.

Returns:

See Also:



11114
11115
11116
11117
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11114

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({
  client_token: "String",
  data_source_identifier: "DataSourceId", # required
  domain_identifier: "DomainId", # required
})

Response structure


resp.created_at #=> Time
resp.data_source_configuration_snapshot #=> String
resp.data_source_id #=> String
resp.domain_id #=> String
resp.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.id #=> String
resp.project_id #=> String
resp.run_statistics_for_assets.added #=> Integer
resp.run_statistics_for_assets.failed #=> Integer
resp.run_statistics_for_assets.skipped #=> Integer
resp.run_statistics_for_assets.unchanged #=> Integer
resp.run_statistics_for_assets.updated #=> Integer
resp.started_at #=> Time
resp.status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.stopped_at #=> Time
resp.type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

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

  • :data_source_identifier (required, String) —

    The identifier of the data source.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to start a data source run.

Returns:

See Also:



11184
11185
11186
11187
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11184

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.

Examples:

Request syntax with placeholder values


resp = client.start_metadata_generation_run({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  owning_project_identifier: "ProjectId", # required
  target: { # required
    identifier: "String", # required
    revision: "Revision",
    type: "ASSET", # required, accepts ASSET
  },
  type: "BUSINESS_DESCRIPTIONS", # required, accepts BUSINESS_DESCRIPTIONS
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.id #=> String
resp.owning_project_id #=> String
resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "CANCELED", "SUCCEEDED", "FAILED"
resp.type #=> String, one of "BUSINESS_DESCRIPTIONS"

Parameters:

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

    ({})

Options Hash (params):

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

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where you want to start a metadata generation run.

  • :owning_project_identifier (required, String) —

    The ID of the project that owns the asset for which you want to start a metadata generation run.

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

    The asset for which you want to start a metadata generation run.

  • :type (required, String) —

    The type of the metadata generation run.

Returns:

See Also:



11250
11251
11252
11253
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11250

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:



11278
11279
11280
11281
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11278

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:



11304
11305
11306
11307
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11304

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.({
  account_source: {
    accounts: [
      {
        aws_account_id: "AwsAccountId", # required
        aws_account_name: "AwsAccountName",
        supported_regions: ["AwsRegion"], # required
      },
    ],
    custom_account_pool_handler: {
      lambda_execution_role_arn: "LambdaExecutionRoleArn",
      lambda_function_arn: "LambdaFunctionArn", # required
    },
  },
  description: "Description",
  domain_identifier: "DomainId", # required
  identifier: "AccountPoolId", # required
  name: "AccountPoolName",
  resolution_strategy: "MANUAL", # accepts MANUAL
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :description (String) —

    The description of the account pool that is to be udpated.

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

  • :resolution_strategy (String) —

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

Returns:

See Also:



11393
11394
11395
11396
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11393

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.asset_id #=> String
resp.configuration.column_configuration.included_column_names #=> Array
resp.configuration.column_configuration.included_column_names[0] #=> 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.expression.equal_to.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.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.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.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.is_not_null.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.is_null.column_name #=> 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.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.like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.like.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.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.not_like.column_name #=> String
resp.configuration.row_configuration.row_filter.expression.not_like.value #=> String
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.description #=> String
resp.domain_id #=> String
resp.effective_column_names #=> Array
resp.effective_column_names[0] #=> String
resp.effective_row_filter #=> String
resp.error_message #=> String
resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "VALID", "INVALID"

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

    The ID of the data asset.

  • :configuration (Types::AssetFilterConfiguration) —

    The configuration of the asset filter.

  • :description (String) —

    The description of the asset filter.

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the asset filter.

  • :name (String) —

    The name of the asset filter.

Returns:

See Also:



11559
11560
11561
11562
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11559

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({
  aws_location: {
    access_role: "AwsLocationAccessRoleString",
    aws_account_id: "AwsAccountId",
    aws_region: "AwsRegion",
    iam_connection_id: "ConnectionId",
  },
  description: "UpdateConnectionInputDescriptionString",
  domain_identifier: "DomainId", # required
  identifier: "ConnectionId", # required
  props: {
    athena_properties: {
      workgroup_name: "AthenaPropertiesPatchWorkgroupNameString",
    },
    glue_properties: {
      glue_connection_input: {
        authentication_configuration: {
          basic_authentication_credentials: {
            password: "BasicAuthenticationCredentialsPasswordString",
            user_name: "BasicAuthenticationCredentialsUserNameString",
          },
          secret_arn: "AuthenticationConfigurationPatchSecretArnString",
        },
        connection_properties: {
          "String" => "ConnectionPropertiesValueString",
        },
        description: "String",
      },
    },
    iam_properties: {
      glue_lineage_sync_enabled: false,
    },
    redshift_properties: {
      credentials: {
        secret_arn: "RedshiftCredentialsSecretArnString",
        username_password: {
          password: "Password", # required
          username: "Username", # required
        },
      },
      database_name: "RedshiftPropertiesPatchDatabaseNameString",
      host: "RedshiftPropertiesPatchHostString",
      lineage_sync: {
        enabled: false,
        schedule: {
          schedule: "LineageSyncScheduleScheduleString",
        },
      },
      port: 1,
      storage: {
        cluster_name: "RedshiftStoragePropertiesClusterNameString",
        workgroup_name: "RedshiftStoragePropertiesWorkgroupNameString",
      },
    },
    s3_properties: {
      s3_access_grant_location_id: "S3AccessGrantLocationId",
      s3_uri: "S3Uri", # required
    },
    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",
    },
  },
})

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.athena_properties #=> Hash
resp.physical_endpoints[0].glue_connection.athena_properties["PropertyMapKeyString"] #=> String
resp.physical_endpoints[0].glue_connection.authentication_configuration.authentication_type #=> String, one of "BASIC", "OAUTH2", "CUSTOM"
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_client_application.a_ws_managed_client_application_reference #=> String
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_credentials.access_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.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.user_managed_client_application_client_secret #=> 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.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.secret_arn #=> String
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].glue_connection.connection_properties #=> Hash
resp.physical_endpoints[0].glue_connection.connection_properties["String"] #=> String
resp.physical_endpoints[0].glue_connection.connection_schema_version #=> Integer
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"
resp.physical_endpoints[0].glue_connection.creation_time #=> Time
resp.physical_endpoints[0].glue_connection.description #=> String
resp.physical_endpoints[0].glue_connection.last_connection_validation_time #=> Time
resp.physical_endpoints[0].glue_connection.last_updated_by #=> String
resp.physical_endpoints[0].glue_connection.last_updated_time #=> Time
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.name #=> String
resp.physical_endpoints[0].glue_connection.physical_connection_requirements.availability_zone #=> 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.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.python_properties #=> Hash
resp.physical_endpoints[0].glue_connection.python_properties["PropertyMapKeyString"] #=> 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.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_name #=> String
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.error_message #=> String
resp.props.glue_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.hyper_pod_properties.cluster_arn #=> String
resp.props.hyper_pod_properties.cluster_name #=> 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.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.database_name #=> 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.lineage_sync.enabled #=> Boolean
resp.props.redshift_properties.lineage_sync.lineage_job_id #=> String
resp.props.redshift_properties.lineage_sync.schedule.schedule #=> String
resp.props.redshift_properties.redshift_temp_dir #=> String
resp.props.redshift_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
resp.props.redshift_properties.storage.cluster_name #=> String
resp.props.redshift_properties.storage.workgroup_name #=> String
resp.props.s3_properties.error_message #=> String
resp.props.s3_properties.s3_access_grant_location_id #=> String
resp.props.s3_properties.s3_uri #=> String
resp.props.s3_properties.status #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "READY", "UPDATING", "UPDATE_FAILED", "DELETED"
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_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.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"

Parameters:

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

    ({})

Options Hash (params):

  • :aws_location (Types::AwsLocation) —

    The location where a connection is to be updated.

  • :description (String) —

    The description of a connection.

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

  • :props (Types::ConnectionPropertiesPatch) —

    The connection props.

Returns:

See Also:



11781
11782
11783
11784
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 11781

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({
  asset_forms_input: [
    {
      content: "FormInputContentString",
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "RevisionInput",
    },
  ],
  configuration: {
    glue_run_configuration: {
      auto_import_data_quality_result: false,
      catalog_name: "GlueRunConfigurationInputCatalogNameString",
      data_access_role: "GlueRunConfigurationInputDataAccessRoleString",
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          filter_expressions: [
            {
              expression: "FilterExpressionExpressionString", # required
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
            },
          ],
          schema_name: "RelationalFilterConfigurationSchemaNameString",
        },
      ],
    },
    redshift_run_configuration: {
      data_access_role: "RedshiftRunConfigurationInputDataAccessRoleString",
      redshift_credential_configuration: {
        secret_manager_arn: "RedshiftCredentialConfigurationSecretManagerArnString", # required
      },
      redshift_storage: {
        redshift_cluster_source: {
          cluster_name: "RedshiftClusterStorageClusterNameString", # required
        },
        redshift_serverless_source: {
          workgroup_name: "RedshiftServerlessStorageWorkgroupNameString", # required
        },
      },
      relational_filter_configurations: [ # required
        {
          database_name: "RelationalFilterConfigurationDatabaseNameString", # required
          filter_expressions: [
            {
              expression: "FilterExpressionExpressionString", # required
              type: "INCLUDE", # required, accepts INCLUDE, EXCLUDE
            },
          ],
          schema_name: "RelationalFilterConfigurationSchemaNameString",
        },
      ],
    },
    sage_maker_run_configuration: {
      tracking_assets: { # required
        "SageMakerAssetType" => ["SageMakerResourceArn"],
      },
    },
  },
  description: "Description",
  domain_identifier: "DomainId", # required
  enable_setting: "ENABLED", # accepts ENABLED, DISABLED
  identifier: "DataSourceId", # required
  name: "Name",
  publish_on_import: false,
  recommendation: {
    enable_business_name_generation: false,
  },
  retain_permissions_on_revoke_failure: false,
  schedule: {
    schedule: "CronString",
    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
  },
})

Response structure


resp.asset_forms_output #=> Array
resp.asset_forms_output[0].content #=> String
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.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.catalog_name #=> String
resp.configuration.glue_run_configuration.data_access_role #=> String
resp.configuration.glue_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.glue_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_name #=> String
resp.configuration.redshift_run_configuration. #=> String
resp.configuration.redshift_run_configuration.data_access_role #=> 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.redshift_run_configuration.region #=> 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].filter_expressions #=> Array
resp.configuration.redshift_run_configuration.relational_filter_configurations[0].filter_expressions[0].expression #=> String
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].schema_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.connection_id #=> String
resp.created_at #=> Time
resp.description #=> String
resp.domain_id #=> String
resp.enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.environment_id #=> String
resp.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.id #=> String
resp.last_run_at #=> Time
resp.last_run_error_message.error_detail #=> String
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_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.name #=> String
resp.project_id #=> String
resp.publish_on_import #=> Boolean
resp.recommendation.enable_business_name_generation #=> Boolean
resp.retain_permissions_on_revoke_failure #=> Boolean
resp.schedule.schedule #=> 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.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].failure_cause #=> 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.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].failure_cause #=> 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.status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.type #=> String
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

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

    The asset forms to be updated as part of the UpdateDataSource action.

  • :configuration (Types::DataSourceConfigurationInput) —

    The configuration to be updated as part of the UpdateDataSource action.

  • :description (String) —

    The description to be updated as part of the UpdateDataSource action.

  • :domain_identifier (required, String) —

    The identifier of the domain in which to update a data source.

  • :enable_setting (String) —

    The enable setting to be updated as part of the UpdateDataSource action.

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

  • :publish_on_import (Boolean) —

    The publish on import setting 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.

  • :schedule (Types::ScheduleConfiguration) —

    The schedule to be updated as part of the UpdateDataSource action.

Returns:

See Also:



12004
12005
12006
12007
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12004

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({
  client_token: "String",
  description: "String",
  domain_execution_role: "RoleArn",
  identifier: "DomainId", # required
  name: "String",
  service_role: "RoleArn",
  single_sign_on: {
    idc_instance_arn: "SingleSignOnIdcInstanceArnString",
    type: "IAM_IDC", # accepts IAM_IDC, DISABLED
    user_assignment: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
  },
})

Response structure


resp.description #=> String
resp.domain_execution_role #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.root_domain_unit_id #=> String
resp.service_role #=> String
resp.single_sign_on.idc_instance_arn #=> String
resp.single_sign_on.type #=> String, one of "IAM_IDC", "DISABLED"
resp.single_sign_on.user_assignment #=> String, one of "AUTOMATIC", "MANUAL"

Parameters:

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

    ({})

Options Hash (params):

  • :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) —

    The description 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.

  • :identifier (required, String) —

    The ID of the Amazon Web Services domain that is to be updated.

  • :name (String) —

    The name to be updated as part of the UpdateDomain action.

  • :service_role (String) —

    The service role of the domain.

  • :single_sign_on (Types::SingleSignOn) —

    The single sign-on option to be updated as part of the UpdateDomain action.

Returns:

See Also:



12082
12083
12084
12085
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12082

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({
  description: "DomainUnitDescription",
  domain_identifier: "DomainId", # required
  identifier: "DomainUnitId", # required
  name: "DomainUnitName",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the domain unit that you want to update.

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

  • :name (String) —

    The name of the domain unit that you want to update.

Returns:

See Also:



12142
12143
12144
12145
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12142

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({
  blueprint_version: "String",
  description: "String",
  domain_identifier: "DomainId", # required
  glossary_terms: ["GlossaryTermId"],
  identifier: "EnvironmentId", # required
  name: "String",
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_version (String) —

    The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.

  • :description (String) —

    The description to be updated as part of the UpdateEnvironment action.

  • :domain_identifier (required, String) —

    The identifier of the domain in which the environment is to be updated.

  • :glossary_terms (Array<String>) —

    The glossary terms to be updated as part of the UpdateEnvironment action.

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

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

    The user parameters of the environment.

Returns:

See Also:



12269
12270
12271
12272
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12269

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({
  description: "String",
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "String", # required
  name: "String",
  parameters: {
    aws_console_link: {
      uri: "String",
    },
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the environment action.

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

  • :name (String) —

    The name of the environment action.

  • :parameters (Types::ActionParameters) —

    The parameters of the environment action.

Returns:

See Also:



12331
12332
12333
12334
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12331

def update_environment_action(params = {}, options = {})
  req = build_request(:update_environment_action, 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({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  description: "String",
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentProfileId", # required
  name: "EnvironmentProfileName",
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :description (String) —

    The description to be updated as part of the UpdateEnvironmentProfile action.

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

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

    The user parameters to be updated as part of the UpdateEnvironmentProfile action.

Returns:

See Also:



12422
12423
12424
12425
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12422

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.

Examples:

Request syntax with placeholder values


resp = client.update_glossary({
  client_token: "ClientToken",
  description: "GlossaryDescription",
  domain_identifier: "DomainId", # required
  identifier: "GlossaryId", # required
  name: "GlossaryName",
  status: "DISABLED", # accepts DISABLED, ENABLED
})

Response structure


resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> 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):

  • :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) —

    The description to be updated as part of the UpdateGlossary action.

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

  • :status (String) —

    The status to be updated as part of the UpdateGlossary action.

Returns:

See Also:



12488
12489
12490
12491
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12488

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_id #=> String
resp.glossary_id #=> String
resp.id #=> String
resp.long_description #=> String
resp.name #=> String
resp.short_description #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.term_relations.classifies #=> Array
resp.term_relations.classifies[0] #=> String
resp.term_relations.is_a #=> Array
resp.term_relations.is_a[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.

  • :long_description (String) —

    The long description to be updated as part of the UpdateGlossaryTerm action.

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

  • :status (String) —

    The status 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.

Returns:

See Also:



12572
12573
12574
12575
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12572

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.group_name #=> String
resp.id #=> String
resp.status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"

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:



12615
12616
12617
12618
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12615

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({
  description: "Description",
  domain_identifier: "DomainId", # required
  domain_unit_id: "DomainUnitId",
  environment_deployment_details: {
    environment_failure_reasons: {
      "String" => [
        {
          code: "String",
          message: "String", # required
        },
      ],
    },
    overall_deployment_status: "PENDING_DEPLOYMENT", # accepts PENDING_DEPLOYMENT, IN_PROGRESS, SUCCESSFUL, FAILED_VALIDATION, FAILED_DEPLOYMENT
  },
  glossary_terms: ["GlossaryTermId"],
  identifier: "ProjectId", # required
  name: "ProjectName",
  project_profile_version: "String",
  user_parameters: [
    {
      environment_configuration_name: "EnvironmentConfigurationName",
      environment_id: "EnvironmentId",
      environment_parameters: [
        {
          name: "String",
          value: "String",
        },
      ],
      environment_resolved_account: {
        aws_account_id: "AwsAccountId", # required
        region_name: "AwsRegion", # required
        source_account_pool_id: "AccountPoolId",
      },
    },
  ],
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
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
resp.environment_deployment_details.overall_deployment_status #=> String, one of "PENDING_DEPLOYMENT", "IN_PROGRESS", "SUCCESSFUL", "FAILED_VALIDATION", "FAILED_DEPLOYMENT"
resp.failure_reasons #=> Array
resp.failure_reasons[0].code #=> String
resp.failure_reasons[0].message #=> String
resp.glossary_terms #=> Array
resp.glossary_terms[0] #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.project_profile_id #=> String
resp.project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "MOVING"
resp.user_parameters #=> Array
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_id #=> 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.user_parameters[0].. #=> String
resp.user_parameters[0]..region_name #=> String
resp.user_parameters[0].. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description to be updated as part of the UpdateProject action.

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where a project is being updated.

  • :domain_unit_id (String) —

    The ID of the domain unit.

  • :environment_deployment_details (Types::EnvironmentDeploymentDetails) —

    The environment deployment details of the project.

  • :glossary_terms (Array<String>) —

    The glossary terms to be updated as part of the UpdateProject action.

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

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

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

    The user parameters of the project.

Returns:

See Also:



12745
12746
12747
12748
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12745

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({
  description: "Description",
  domain_identifier: "DomainId", # required
  domain_unit_identifier: "DomainUnitId",
  environment_configurations: [
    {
      account_pools: ["AccountPoolId"],
      aws_account: {
        aws_account_id: "AwsAccountId",
        aws_account_id_path: "ParameterStorePath",
      },
      aws_region: {
        region_name: "RegionName",
        region_name_path: "ParameterStorePath",
      },
      configuration_parameters: {
        parameter_overrides: [
          {
            is_editable: false,
            name: "EnvironmentConfigurationParameterName",
            value: "String",
          },
        ],
        resolved_parameters: [
          {
            is_editable: false,
            name: "EnvironmentConfigurationParameterName",
            value: "String",
          },
        ],
        ssm_path: "ParameterStorePath",
      },
      deployment_mode: "ON_CREATE", # accepts ON_CREATE, ON_DEMAND
      deployment_order: 1,
      description: "Description",
      environment_blueprint_id: "EnvironmentBlueprintId", # required
      id: "EnvironmentConfigurationId",
      name: "EnvironmentConfigurationName", # required
    },
  ],
  identifier: "ProjectProfileId", # required
  name: "ProjectProfileName",
  status: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.domain_unit_id #=> String
resp.environment_configurations #=> Array
resp.environment_configurations[0]. #=> Array
resp.environment_configurations[0].[0] #=> String
resp.environment_configurations[0].. #=> String
resp.environment_configurations[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].configuration_parameters.parameter_overrides #=> Array
resp.environment_configurations[0].configuration_parameters.parameter_overrides[0].is_editable #=> Boolean
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.resolved_parameters #=> Array
resp.environment_configurations[0].configuration_parameters.resolved_parameters[0].is_editable #=> Boolean
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.ssm_path #=> String
resp.environment_configurations[0].deployment_mode #=> String, one of "ON_CREATE", "ON_DEMAND"
resp.environment_configurations[0].deployment_order #=> Integer
resp.environment_configurations[0].description #=> String
resp.environment_configurations[0].environment_blueprint_id #=> String
resp.environment_configurations[0].id #=> String
resp.environment_configurations[0].name #=> String
resp.id #=> String
resp.last_updated_at #=> Time
resp.name #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of a project profile.

  • :domain_identifier (required, String) —

    The ID of the domain where a project profile is to be updated.

  • :domain_unit_identifier (String) —

    The ID of the domain unit where a project profile is to be updated.

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

    The environment configurations of a project profile.

  • :identifier (required, String) —

    The ID of a project profile that is to be updated.

  • :name (String) —

    The name of a project profile.

  • :status (String) —

    The status of a project profile.

Returns:

See Also:



12871
12872
12873
12874
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12871

def update_project_profile(params = {}, options = {})
  req = build_request(:update_project_profile, 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({
  description: "Description",
  detail: {
    metadata_form_enforcement_detail: {
      required_metadata_forms: [
        {
          type_identifier: "FormTypeIdentifier", # required
          type_revision: "Revision", # required
        },
      ],
    },
  },
  domain_identifier: "DomainId", # required
  identifier: "RuleId", # required
  include_child_domain_units: false,
  name: "RuleName",
  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"],
    },
  },
})

Response structure


resp.action #=> String, one of "CREATE_LISTING_CHANGE_SET", "CREATE_SUBSCRIPTION_REQUEST"
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> 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.identifier #=> String
resp.last_updated_by #=> String
resp.name #=> String
resp.revision #=> String
resp.rule_type #=> String, one of "METADATA_FORM_ENFORCEMENT"
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.target.domain_unit_target.domain_unit_id #=> String
resp.target.domain_unit_target.include_child_domain_units #=> Boolean
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the rule.

  • :detail (Types::RuleDetail) —

    The detail of the rule.

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

  • :include_child_domain_units (Boolean) —

    Specifies whether to update this rule in the child domain units.

  • :name (String) —

    The name of the rule.

  • :scope (Types::RuleScope) —

    The scrope of the rule.

Returns:

See Also:



12983
12984
12985
12986
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 12983

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({
  asset_identifier: "AssetId", # required
  domain_identifier: "DomainId", # required
  failure_cause: {
    message: "String",
  },
  identifier: "SubscriptionGrantId", # required
  status: "GRANT_PENDING", # required, accepts GRANT_PENDING, REVOKE_PENDING, GRANT_IN_PROGRESS, REVOKE_IN_PROGRESS, GRANTED, REVOKED, GRANT_FAILED, REVOKE_FAILED
  target_name: "String",
})

Response structure


resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> String
resp.assets[0].asset_scope.asset_id #=> String
resp.assets[0].asset_scope.error_message #=> 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].failure_cause.message #=> String
resp.assets[0].failure_timestamp #=> Time
resp.assets[0].granted_timestamp #=> Time
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.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.granted_entity.listing.id #=> String
resp.granted_entity.listing.revision #=> String
resp.id #=> String
resp.status #=> String, one of "PENDING", "IN_PROGRESS", "GRANT_FAILED", "REVOKE_FAILED", "GRANT_AND_REVOKE_FAILED", "COMPLETED", "INACCESSIBLE"
resp.subscription_id #=> String
resp.subscription_target_id #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

    The identifier of the asset the subscription grant status of which is to be updated.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

  • :failure_cause (Types::FailureCause) —

    Specifies the error message that is returned if the operation cannot be successfully completed.

  • :identifier (required, String) —

    The identifier of the subscription grant the status of which is to be updated.

  • :status (required, String) —

    The status to be updated as part of the UpdateSubscriptionGrantStatus action.

  • :target_name (String) —

    The target name to be updated as part of the UpdateSubscriptionGrantStatus action.

Returns:

See Also:



13073
13074
13075
13076
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13073

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.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.existing_subscription_id #=> String
resp.id #=> String
resp.metadata_forms #=> Array
resp.metadata_forms[0].content #=> String
resp.metadata_forms[0].form_name #=> String
resp.metadata_forms[0].type_name #=> String
resp.metadata_forms[0].type_revision #=> String
resp.request_reason #=> String
resp.reviewer_id #=> String
resp.status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.subscribed_listings #=> Array
resp.subscribed_listings[0].description #=> String
resp.subscribed_listings[0].id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.asset_id #=> String
resp.subscribed_listings[0].item.asset_listing.asset_scope.error_message #=> 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.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.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].item.product_listing.description #=> String
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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> 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:



13171
13172
13173
13174
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13171

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({
  applicable_asset_types: ["TypeName"],
  authorized_principals: ["AuthorizedPrincipalIdentifier"],
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "SubscriptionTargetId", # required
  manage_access_role: "IamRoleArn",
  name: "SubscriptionTargetName",
  provider: "String",
  subscription_target_config: [
    {
      content: "String", # required
      form_name: "FormName", # required
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :applicable_asset_types (Array<String>) —

    The applicable asset types 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.

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

  • :manage_access_role (String) —

    The manage access role to be updated as part of the UpdateSubscriptionTarget action.

  • :name (String) —

    The name to be updated as part of the UpdateSubscriptionTarget action.

  • :provider (String) —

    The provider 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.

Returns:

See Also:



13276
13277
13278
13279
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13276

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
  status: "ASSIGNED", # required, accepts ASSIGNED, NOT_ASSIGNED, ACTIVATED, DEACTIVATED
  type: "IAM", # accepts IAM, SSO
  user_identifier: "UserIdentifier", # required
})

Response structure


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

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.

  • :status (required, String) —

    The status of the user profile that are to be updated.

  • :type (String) —

    The type of the user profile that are to be updated.

  • :user_identifier (required, String) —

    The identifier of the user whose user profile is to be updated.

Returns:

See Also:



13328
13329
13330
13331
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 13328

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