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. This can be an 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.

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

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

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

    A Bearer Token Provider. This can be an 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.



467
468
469
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 467

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:



537
538
539
540
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 537

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:



646
647
648
649
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 646

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:



695
696
697
698
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 695

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

#add_policy_grant(params = {}) ⇒ Struct

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,
    },
  },
  domain_identifier: "DomainId", # required
  entity_identifier: "String", # required
  entity_type: "DOMAIN_UNIT", # required, accepts DOMAIN_UNIT, ENVIRONMENT_BLUEPRINT_CONFIGURATION, ENVIRONMENT_PROFILE
  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
  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.**

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

  • (Struct) —

    Returns an empty response.

See Also:



813
814
815
816
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 813

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:



844
845
846
847
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 844

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



871
872
873
874
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 871

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:



953
954
955
956
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 953

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

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



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

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:



1259
1260
1261
1262
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1259

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



1389
1390
1391
1392
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1389

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:



1466
1467
1468
1469
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1466

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",
      },
    },
    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", "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.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", "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:



1753
1754
1755
1756
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1753

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:



1863
1864
1865
1866
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1863

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:



1973
1974
1975
1976
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 1973

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.

Returns:

See Also:



2198
2199
2200
2201
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2198

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



2297
2298
2299
2300
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2297

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:



2364
2365
2366
2367
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2364

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", # required
  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_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 (required, 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:



2509
2510
2511
2512
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2509

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:



2570
2571
2572
2573
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2570

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:



2664
2665
2666
2667
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2664

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:



2728
2729
2730
2731
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2728

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

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"

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.

Returns:

See Also:



2791
2792
2793
2794
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2791

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

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:



2872
2873
2874
2875
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2872

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:



2919
2920
2921
2922
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2919

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:



2976
2977
2978
2979
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 2976

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_parameters: [
        {
          name: "String",
          value: "String",
        },
      ],
    },
  ],
})

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"
resp.user_parameters #=> Array
resp.user_parameters[0].environment_configuration_name #=> String
resp.user_parameters[0].environment_parameters #=> Array
resp.user_parameters[0].environment_parameters[0].name #=> String
resp.user_parameters[0].environment_parameters[0].value #=> String

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:



3077
3078
3079
3080
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3077

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:



3115
3116
3117
3118
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3115

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: [
    {
      aws_account: { # required
        aws_account_id: "AwsAccountId",
        aws_account_id_path: "ParameterStorePath",
      },
      aws_region: { # required
        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].. #=> 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:



3234
3235
3236
3237
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3234

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_SUBSCRIPTION_REQUEST", # required, accepts 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_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:



3355
3356
3357
3358
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3355

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:



3452
3453
3454
3455
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3452

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:



3584
3585
3586
3587
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3584

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:



3690
3691
3692
3693
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3690

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:



3746
3747
3748
3749
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3746

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



3772
3773
3774
3775
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3772

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:



3802
3803
3804
3805
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3802

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:



3829
3830
3831
3832
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3829

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:



3863
3864
3865
3866
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3863

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:



3890
3891
3892
3893
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 3890

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:



4021
4022
4023
4024
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4021

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:



4063
4064
4065
4066
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4063

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:



4089
4090
4091
4092
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4089

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:



4116
4117
4118
4119
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4116

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:



4148
4149
4150
4151
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4148

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:



4175
4176
4177
4178
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4175

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:



4202
4203
4204
4205
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4202

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:



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

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:



4256
4257
4258
4259
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4256

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:



4283
4284
4285
4286
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4283

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:



4309
4310
4311
4312
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4309

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:



4340
4341
4342
4343
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4340

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:



4375
4376
4377
4378
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4375

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:



4401
4402
4403
4404
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4401

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:



4435
4436
4437
4438
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4435

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:



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

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:



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

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:



4560
4561
4562
4563
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4560

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:



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

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:



4634
4635
4636
4637
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4634

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

  • :revision (String) —

    The revision of the Amazon DataZone asset.

Returns:

See Also:



4720
4721
4722
4723
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4720

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:



4807
4808
4809
4810
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4807

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:



4868
4869
4870
4871
 
# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/client.rb', line 4868

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