Class: Aws::DataZone::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.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::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV 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:

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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



409
410
411
 
# File 'lib/aws-sdk-datazone/client.rb', line 409

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7869
7870
7871
 
# File 'lib/aws-sdk-datazone/client.rb', line 7869

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7872
7873
7874
 
# File 'lib/aws-sdk-datazone/client.rb', line 7872

def errors_module
  Errors
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:



479
480
481
482
 
# File 'lib/aws-sdk-datazone/client.rb', line 479

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({
  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.id #=> 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.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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :decision_comment (String) —

    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:



555
556
557
558
 
# File 'lib/aws-sdk-datazone/client.rb', line 555

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
 
# File 'lib/aws-sdk-datazone/client.rb', line 7847

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-datazone'
  context[:gem_version] = '1.6.0'
  Seahorse::Client::Request.new(handlers, context)
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:



582
583
584
585
 
# File 'lib/aws-sdk-datazone/client.rb', line 582

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



648
649
650
651
 
# File 'lib/aws-sdk-datazone/client.rb', line 648

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



784
785
786
787
 
# File 'lib/aws-sdk-datazone/client.rb', line 784

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



914
915
916
917
 
# File 'lib/aws-sdk-datazone/client.rb', line 914

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:



991
992
993
994
 
# File 'lib/aws-sdk-datazone/client.rb', line 991

def create_asset_type(params = {}, options = {})
  req = build_request(:create_asset_type, 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: "Revision",
    },
  ],
  client_token: "String",
  configuration: {
    glue_run_configuration: {
      auto_import_data_quality_result: false,
      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: { # required
        secret_manager_arn: "RedshiftCredentialConfigurationSecretManagerArnString", # required
      },
      redshift_storage: { # required
        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",
        },
      ],
    },
  },
  description: "Description",
  domain_identifier: "DomainId", # required
  enable_setting: "ENABLED", # accepts ENABLED, DISABLED
  environment_identifier: "String", # required
  name: "Name", # required
  project_identifier: "String", # 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.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.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`.

  • :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 (required, 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:



1198
1199
1200
1201
 
# File 'lib/aws-sdk-datazone/client.rb', line 1198

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
  kms_key_identifier: "KmsKeyArn",
  name: "String", # required
  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.id #=> String
resp.kms_key_identifier #=> String
resp.name #=> String
resp.portal_url #=> 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.

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

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



1283
1284
1285
1286
 
# File 'lib/aws-sdk-datazone/client.rb', line 1283

def create_domain(params = {}, options = {})
  req = build_request(:create_domain, 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({
  description: "String",
  domain_identifier: "DomainId", # required
  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):

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



1408
1409
1410
1411
 
# File 'lib/aws-sdk-datazone/client.rb', line 1408

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



1502
1503
1504
1505
 
# File 'lib/aws-sdk-datazone/client.rb', line 1502

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:



1566
1567
1568
1569
 
# File 'lib/aws-sdk-datazone/client.rb', line 1566

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:



1629
1630
1631
1632
 
# File 'lib/aws-sdk-datazone/client.rb', line 1629

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:



1710
1711
1712
1713
 
# File 'lib/aws-sdk-datazone/client.rb', line 1710

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:



1757
1758
1759
1760
 
# File 'lib/aws-sdk-datazone/client.rb', line 1757

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

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:



1814
1815
1816
1817
 
# File 'lib/aws-sdk-datazone/client.rb', line 1814

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
  glossary_terms: ["GlossaryTermId"],
  name: "ProjectName", # required
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
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_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED"

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.

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

Returns:

See Also:



1875
1876
1877
1878
 
# File 'lib/aws-sdk-datazone/client.rb', line 1875

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



1913
1914
1915
1916
 
# File 'lib/aws-sdk-datazone/client.rb', line 1913

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

Response structure


resp.assets #=> Array
resp.assets[0].asset_id #=> String
resp.assets[0].asset_revision #=> 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 (required, String) —

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

Returns:

See Also:



2005
2006
2007
2008
 
# File 'lib/aws-sdk-datazone/client.rb', line 2005

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
  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.id #=> 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.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].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.

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



2102
2103
2104
2105
 
# File 'lib/aws-sdk-datazone/client.rb', line 2102

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: "String", # 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:



2208
2209
2210
2211
 
# File 'lib/aws-sdk-datazone/client.rb', line 2208

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:



2264
2265
2266
2267
 
# File 'lib/aws-sdk-datazone/client.rb', line 2264

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

#delete_asset(params = {}) ⇒ Struct

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



2290
2291
2292
2293
 
# File 'lib/aws-sdk-datazone/client.rb', line 2290

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



2317
2318
2319
2320
 
# File 'lib/aws-sdk-datazone/client.rb', line 2317

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

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

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

Returns:

See Also:



2422
2423
2424
2425
 
# File 'lib/aws-sdk-datazone/client.rb', line 2422

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:



2464
2465
2466
2467
 
# File 'lib/aws-sdk-datazone/client.rb', line 2464

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



2491
2492
2493
2494
 
# File 'lib/aws-sdk-datazone/client.rb', line 2491

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



2518
2519
2520
2521
 
# File 'lib/aws-sdk-datazone/client.rb', line 2518

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:



2545
2546
2547
2548
 
# File 'lib/aws-sdk-datazone/client.rb', line 2545

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:



2572
2573
2574
2575
 
# File 'lib/aws-sdk-datazone/client.rb', line 2572

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:



2599
2600
2601
2602
 
# File 'lib/aws-sdk-datazone/client.rb', line 2599

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:



2626
2627
2628
2629
 
# File 'lib/aws-sdk-datazone/client.rb', line 2626

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:



2652
2653
2654
2655
 
# File 'lib/aws-sdk-datazone/client.rb', line 2652

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:



2683
2684
2685
2686
 
# File 'lib/aws-sdk-datazone/client.rb', line 2683

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:



2718
2719
2720
2721
 
# File 'lib/aws-sdk-datazone/client.rb', line 2718

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



2779
2780
2781
2782
 
# File 'lib/aws-sdk-datazone/client.rb', line 2779

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:



2806
2807
2808
2809
 
# File 'lib/aws-sdk-datazone/client.rb', line 2806

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:



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

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:



2881
2882
2883
2884
 
# File 'lib/aws-sdk-datazone/client.rb', line 2881

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



2967
2968
2969
2970
 
# File 'lib/aws-sdk-datazone/client.rb', line 2967

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



3028
3029
3030
3031
 
# File 'lib/aws-sdk-datazone/client.rb', line 3028

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

#get_data_source(params = {}) ⇒ Types::GetDataSourceOutput

Gets an Amazon DataZone data source.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the Amazon DataZone data source.

Returns:

See Also:



3128
3129
3130
3131
 
# File 'lib/aws-sdk-datazone/client.rb', line 3128

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

#get_data_source_run(params = {}) ⇒ Types::GetDataSourceRunOutput

Gets an Amazon DataZone data source run.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.data_source_configuration_snapshot #=> String
resp.data_source_id #=> String
resp.domain_id #=> String
resp.error_message.error_detail #=> String
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.id #=> String
resp.project_id #=> String
resp.run_statistics_for_assets.added #=> Integer
resp.run_statistics_for_assets.failed #=> Integer
resp.run_statistics_for_assets.skipped #=> Integer
resp.run_statistics_for_assets.unchanged #=> Integer
resp.run_statistics_for_assets.updated #=> Integer
resp.started_at #=> Time
resp.status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.stopped_at #=> Time
resp.type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the domain in which this data source run was performed.

  • :identifier (required, String) —

    The ID of the data source run.

Returns:

See Also:



3189
3190
3191
3192
 
# File 'lib/aws-sdk-datazone/client.rb', line 3189

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

#get_domain(params = {}) ⇒ Types::GetDomainOutput

Gets an Amazon DataZone domain.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the specified Amazon DataZone domain.

Returns:

See Also:



3241
3242
3243
3244
 
# File 'lib/aws-sdk-datazone/client.rb', line 3241

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

#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput

Gets an Amazon DataZone environment.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where the environment exists.

  • :identifier (required, String) —

    The ID of the Amazon DataZone environment.

Returns:

See Also:



3337
3338
3339
3340
 
# File 'lib/aws-sdk-datazone/client.rb', line 3337

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

#get_environment_blueprint(params = {}) ⇒ Types::GetEnvironmentBlueprintOutput

Gets an Amazon DataZone blueprint.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain in which this blueprint exists.

  • :identifier (required, String) —

    The ID of this Amazon DataZone blueprint.

Returns:

See Also:



3395
3396
3397
3398
 
# File 'lib/aws-sdk-datazone/client.rb', line 3395

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

#get_environment_blueprint_configuration(params = {}) ⇒ Types::GetEnvironmentBlueprintConfigurationOutput

Gets the blueprint configuration in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.domain_id #=> String
resp.enabled_regions #=> Array
resp.enabled_regions[0] #=> String
resp.environment_blueprint_id #=> String
resp.manage_access_role_arn #=> String
resp.provisioning_role_arn #=> String
resp.regional_parameters #=> Hash
resp.regional_parameters["RegionName"] #=> Hash
resp.regional_parameters["RegionName"]["String"] #=> String
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where this blueprint exists.

  • :environment_blueprint_identifier (required, String) —

    He ID of the blueprint.

Returns:

See Also:



3444
3445
3446
3447
 
# File 'lib/aws-sdk-datazone/client.rb', line 3444

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

#get_environment_profile(params = {}) ⇒ Types::GetEnvironmentProfileOutput

Gets an evinronment profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the environment profile.

Returns:

See Also:



3505
3506
3507
3508
 
# File 'lib/aws-sdk-datazone/client.rb', line 3505

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

#get_form_type(params = {}) ⇒ Types::GetFormTypeOutput

Gets a metadata form type in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :form_type_identifier (required, String) —

    The ID of the metadata form type.

  • :revision (String) —

    The revision of this metadata form type.

Returns:

See Also:



3566
3567
3568
3569
 
# File 'lib/aws-sdk-datazone/client.rb', line 3566

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

#get_glossary(params = {}) ⇒ Types::GetGlossaryOutput

Gets a business glossary in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> String
resp.status #=> String, one of "DISABLED", "ENABLED"
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the business glossary.

Returns:

See Also:



3617
3618
3619
3620
 
# File 'lib/aws-sdk-datazone/client.rb', line 3617

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

#get_glossary_term(params = {}) ⇒ Types::GetGlossaryTermOutput

Gets a business glossary term in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.domain_id #=> String
resp.glossary_id #=> String
resp.id #=> String
resp.long_description #=> String
resp.name #=> String
resp.short_description #=> String
resp.status #=> String, one of "ENABLED", "DISABLED"
resp.term_relations.classifies #=> Array
resp.term_relations.classifies[0] #=> String
resp.term_relations.is_a #=> Array
resp.term_relations.is_a[0] #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the business glossary term.

Returns:

See Also:



3675
3676
3677
3678
 
# File 'lib/aws-sdk-datazone/client.rb', line 3675

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

#get_group_profile(params = {}) ⇒ Types::GetGroupProfileOutput

Gets a group profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :group_identifier (required, String) —

    The identifier of the group profile.

Returns:

See Also:



3714
3715
3716
3717
 
# File 'lib/aws-sdk-datazone/client.rb', line 3714

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

#get_iam_portal_login_url(params = {}) ⇒ Types::GetIamPortalLoginUrlOutput

Gets the data portal URL for the specified Amazon DataZone domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.auth_code_url #=> String
resp. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    the ID of the Amazon DataZone domain the data portal of which you want to get.

Returns:

See Also:



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

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

#get_listing(params = {}) ⇒ Types::GetListingOutput

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.item.asset_listing.asset_id #=> String
resp.item.asset_listing.asset_revision #=> String
resp.item.asset_listing.asset_type #=> String
resp.item.asset_listing.created_at #=> Time
resp.item.asset_listing.forms #=> String
resp.item.asset_listing.glossary_terms #=> Array
resp.item.asset_listing.glossary_terms[0].name #=> String
resp.item.asset_listing.glossary_terms[0].short_description #=> String
resp.item.asset_listing.latest_time_series_data_point_forms #=> Array
resp.item.asset_listing.latest_time_series_data_point_forms[0].content_summary #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].form_name #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].id #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].timestamp #=> Time
resp.item.asset_listing.latest_time_series_data_point_forms[0].type_identifier #=> String
resp.item.asset_listing.latest_time_series_data_point_forms[0].type_revision #=> String
resp.item.asset_listing.owning_project_id #=> String
resp.listing_revision #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "INACTIVE"
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain.

  • :identifier (required, String) —

    The ID of the listing.

  • :listing_revision (String) —

    The revision of the listing.

Returns:

See Also:



3816
3817
3818
3819
 
# File 'lib/aws-sdk-datazone/client.rb', line 3816

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

#get_metadata_generation_run(params = {}) ⇒ Types::GetMetadataGenerationRunOutput

Gets a metadata generation run in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

  • :identifier (required, String) —

    The identifier of the metadata generation run.

Returns:

See Also:



3865
3866
3867
3868
 
# File 'lib/aws-sdk-datazone/client.rb', line 3865

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

#get_project(params = {}) ⇒ Types::GetProjectOutput

Gets a project in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
resp.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_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the project exists.

  • :identifier (required, String) —

    The ID of the project.

Returns:

See Also:



3918
3919
3920
3921
 
# File 'lib/aws-sdk-datazone/client.rb', line 3918

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

#get_subscription(params = {}) ⇒ Types::GetSubscriptionOutput

Gets a subscription in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which the subscription exists.

  • :identifier (required, String) —

    The ID of the subscription.

Returns:

See Also:



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

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

#get_subscription_grant(params = {}) ⇒ Types::GetSubscriptionGrantOutput

Gets the subscription grant in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The ID of the subscription grant.

Returns:

See Also:



4044
4045
4046
4047
 
# File 'lib/aws-sdk-datazone/client.rb', line 4044

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

#get_subscription_request_details(params = {}) ⇒ Types::GetSubscriptionRequestDetailsOutput

Gets the details of the specified subscription request.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.id #=> 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.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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to get the subscription request details.

  • :identifier (required, String) —

    The identifier of the subscription request the details of which to get.

Returns:

See Also:



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

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

#get_subscription_target(params = {}) ⇒ Types::GetSubscriptionTargetOutput

Gets the subscription target in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :environment_identifier (required, String) —

    The ID of the environment associated with the subscription target.

  • :identifier (required, String) —

    The ID of the subscription target.

Returns:

See Also:



4184
4185
4186
4187
 
# File 'lib/aws-sdk-datazone/client.rb', line 4184

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

#get_time_series_data_point(params = {}) ⇒ Types::GetTimeSeriesDataPointOutput

Gets the existing data point for the asset.

Examples:

Request syntax with placeholder values


resp = client.get_time_series_data_point({
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  form_name: "TimeSeriesFormName", # required
  identifier: "TimeSeriesDataPointIdentifier", # required
})

Response structure


resp.domain_id #=> String
resp.entity_id #=> String
resp.entity_type #=> String, one of "ASSET", "LISTING"
resp.form.content #=> String
resp.form.form_name #=> String
resp.form.id #=> String
resp.form.timestamp #=> Time
resp.form.type_identifier #=> String
resp.form.type_revision #=> String
resp.form_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to get the data point.

  • :entity_type (required, String) —

    The type of the asset for which you want to get the data point.

  • :form_name (required, String) —

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

  • :identifier (required, String) —

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

Returns:

See Also:



4243
4244
4245
4246
 
# File 'lib/aws-sdk-datazone/client.rb', line 4243

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

#get_user_profile(params = {}) ⇒ Types::GetUserProfileOutput

Gets a user profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  type: "IAM", # accepts IAM, SSO
  user_identifier: "UserIdentifier", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    the ID of the Amazon DataZone domain the data portal of which you want to get.

  • :type (String) —

    The type of the user profile.

  • :user_identifier (required, String) —

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

Returns:

See Also:



4291
4292
4293
4294
 
# File 'lib/aws-sdk-datazone/client.rb', line 4291

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

#list_asset_revisions(params = {}) ⇒ Types::ListAssetRevisionsOutput

Lists the revisions for the asset.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_revisions({
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].revision #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the domain.

  • :identifier (required, String) —

    The identifier of the asset.

  • :max_results (Integer) —

    The maximum number of revisions to return in a single call to ‘ListAssetRevisions`. When the number of revisions to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListAssetRevisions` to list the next set of revisions.

  • :next_token (String) —

    When the number of revisions is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of revisions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListAssetRevisions` to list the next set of revisions.

Returns:

See Also:



4349
4350
4351
4352
 
# File 'lib/aws-sdk-datazone/client.rb', line 4349

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

#list_data_source_run_activities(params = {}) ⇒ Types::ListDataSourceRunActivitiesOutput

Lists data source run activities.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_source_run_activities({
  domain_identifier: "DomainId", # required
  identifier: "DataSourceRunId", # required
  max_results: 1,
  next_token: "PaginationToken",
  status: "FAILED", # accepts FAILED, PUBLISHING_FAILED, SUCCEEDED_CREATED, SUCCEEDED_UPDATED, SKIPPED_ALREADY_IMPORTED, SKIPPED_ARCHIVED, SKIPPED_NO_ACCESS, UNCHANGED
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].data_asset_id #=> String
resp.items[0].data_asset_status #=> String, one of "FAILED", "PUBLISHING_FAILED", "SUCCEEDED_CREATED", "SUCCEEDED_UPDATED", "SKIPPED_ALREADY_IMPORTED", "SKIPPED_ARCHIVED", "SKIPPED_NO_ACCESS", "UNCHANGED"
resp.items[0].data_source_run_id #=> String
resp.items[0].database #=> String
resp.items[0].error_message.error_detail #=> String
resp.items[0].error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.items[0].project_id #=> String
resp.items[0].technical_description #=> String
resp.items[0].technical_name #=> String
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to list data source run activities.

  • :identifier (required, String) —

    The identifier of the data source run.

  • :max_results (Integer) —

    The maximum number of activities to return in a single call to ‘ListDataSourceRunActivities`. When the number of activities to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataSourceRunActivities` to list the next set of activities.

  • :next_token (String) —

    When the number of activities is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of activities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSourceRunActivities` to list the next set of activities.

  • :status (String) —

    The status of the data source run.

Returns:

See Also:



4418
4419
4420
4421
 
# File 'lib/aws-sdk-datazone/client.rb', line 4418

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

#list_data_source_runs(params = {}) ⇒ Types::ListDataSourceRunsOutput

Lists data source runs in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_source_runs({
  data_source_identifier: "DataSourceId", # required
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  status: "REQUESTED", # accepts REQUESTED, RUNNING, FAILED, PARTIALLY_SUCCEEDED, SUCCESS
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].data_source_id #=> String
resp.items[0].error_message.error_detail #=> String
resp.items[0].error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.items[0].id #=> String
resp.items[0].project_id #=> String
resp.items[0].run_statistics_for_assets.added #=> Integer
resp.items[0].run_statistics_for_assets.failed #=> Integer
resp.items[0].run_statistics_for_assets.skipped #=> Integer
resp.items[0].run_statistics_for_assets.unchanged #=> Integer
resp.items[0].run_statistics_for_assets.updated #=> Integer
resp.items[0].started_at #=> Time
resp.items[0].status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.items[0].stopped_at #=> Time
resp.items[0].type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :data_source_identifier (required, String) —

    The identifier of the data source.

  • :domain_identifier (required, String) —

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

  • :max_results (Integer) —

    The maximum number of runs to return in a single call to ‘ListDataSourceRuns`. When the number of runs to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataSourceRuns` to list the next set of runs.

  • :next_token (String) —

    When the number of runs is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of runs, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSourceRuns` to list the next set of runs.

  • :status (String) —

    The status of the data source.

Returns:

See Also:



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

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

#list_data_sources(params = {}) ⇒ Types::ListDataSourcesOutput

Lists data sources in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_sources({
  domain_identifier: "DomainId", # required
  environment_identifier: "String",
  max_results: 1,
  name: "Name",
  next_token: "PaginationToken",
  project_identifier: "String", # required
  status: "CREATING", # accepts CREATING, FAILED_CREATION, READY, UPDATING, FAILED_UPDATE, RUNNING, DELETING, FAILED_DELETION
  type: "DataSourceType",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].data_source_id #=> String
resp.items[0].domain_id #=> String
resp.items[0].enable_setting #=> String, one of "ENABLED", "DISABLED"
resp.items[0].environment_id #=> String
resp.items[0].last_run_asset_count #=> Integer
resp.items[0].last_run_at #=> Time
resp.items[0].last_run_error_message.error_detail #=> String
resp.items[0].last_run_error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.items[0].last_run_status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.items[0].name #=> String
resp.items[0].schedule.schedule #=> String
resp.items[0].schedule.timezone #=> String, one of "UTC", "AFRICA_JOHANNESBURG", "AMERICA_MONTREAL", "AMERICA_SAO_PAULO", "ASIA_BAHRAIN", "ASIA_BANGKOK", "ASIA_CALCUTTA", "ASIA_DUBAI", "ASIA_HONG_KONG", "ASIA_JAKARTA", "ASIA_KUALA_LUMPUR", "ASIA_SEOUL", "ASIA_SHANGHAI", "ASIA_SINGAPORE", "ASIA_TAIPEI", "ASIA_TOKYO", "AUSTRALIA_MELBOURNE", "AUSTRALIA_SYDNEY", "CANADA_CENTRAL", "CET", "CST6CDT", "ETC_GMT", "ETC_GMT0", "ETC_GMT_ADD_0", "ETC_GMT_ADD_1", "ETC_GMT_ADD_10", "ETC_GMT_ADD_11", "ETC_GMT_ADD_12", "ETC_GMT_ADD_2", "ETC_GMT_ADD_3", "ETC_GMT_ADD_4", "ETC_GMT_ADD_5", "ETC_GMT_ADD_6", "ETC_GMT_ADD_7", "ETC_GMT_ADD_8", "ETC_GMT_ADD_9", "ETC_GMT_NEG_0", "ETC_GMT_NEG_1", "ETC_GMT_NEG_10", "ETC_GMT_NEG_11", "ETC_GMT_NEG_12", "ETC_GMT_NEG_13", "ETC_GMT_NEG_14", "ETC_GMT_NEG_2", "ETC_GMT_NEG_3", "ETC_GMT_NEG_4", "ETC_GMT_NEG_5", "ETC_GMT_NEG_6", "ETC_GMT_NEG_7", "ETC_GMT_NEG_8", "ETC_GMT_NEG_9", "EUROPE_DUBLIN", "EUROPE_LONDON", "EUROPE_PARIS", "EUROPE_STOCKHOLM", "EUROPE_ZURICH", "ISRAEL", "MEXICO_GENERAL", "MST7MDT", "PACIFIC_AUCKLAND", "US_CENTRAL", "US_EASTERN", "US_MOUNTAIN", "US_PACIFIC"
resp.items[0].status #=> String, one of "CREATING", "FAILED_CREATION", "READY", "UPDATING", "FAILED_UPDATE", "RUNNING", "DELETING", "FAILED_DELETION"
resp.items[0].type #=> String
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :environment_identifier (String) —

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

  • :max_results (Integer) —

    The maximum number of data sources to return in a single call to ‘ListDataSources`. When the number of data sources to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataSources` to list the next set of data sources.

  • :name (String) —

    The name of the data source.

  • :next_token (String) —

    When the number of data sources is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of data sources, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSources` to list the next set of data sources.

  • :project_identifier (required, String) —

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

  • :status (String) —

    The status of the data source.

  • :type (String) —

    The type of the data source.

Returns:

See Also:



4578
4579
4580
4581
 
# File 'lib/aws-sdk-datazone/client.rb', line 4578

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

#list_domains(params = {}) ⇒ Types::ListDomainsOutput

Lists Amazon DataZone domains.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  max_results: 1,
  next_token: "PaginationToken",
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATION_FAILED, DELETING, DELETED, DELETION_FAILED
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of domains to return in a single call to ‘ListDomains`. When the number of domains to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDomains` to list the next set of domains.

  • :next_token (String) —

    When the number of domains is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of domains, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDomains` to list the next set of domains.

  • :status (String) —

    The status of the data source.

Returns:

See Also:



4636
4637
4638
4639
 
# File 'lib/aws-sdk-datazone/client.rb', line 4636

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

#list_environment_blueprint_configurations(params = {}) ⇒ Types::ListEnvironmentBlueprintConfigurationsOutput

Lists blueprint configurations for a Amazon DataZone environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_blueprint_configurations({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].domain_id #=> String
resp.items[0].enabled_regions #=> Array
resp.items[0].enabled_regions[0] #=> String
resp.items[0].environment_blueprint_id #=> String
resp.items[0].manage_access_role_arn #=> String
resp.items[0].provisioning_role_arn #=> String
resp.items[0].regional_parameters #=> Hash
resp.items[0].regional_parameters["RegionName"] #=> Hash
resp.items[0].regional_parameters["RegionName"]["String"] #=> String
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :max_results (Integer) —

    The maximum number of blueprint configurations to return in a single call to ‘ListEnvironmentBlueprintConfigurations`. When the number of configurations to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentBlueprintConfigurations` to list the next set of configurations.

  • :next_token (String) —

    When the number of blueprint configurations is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of configurations, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentBlueprintConfigurations` to list the next set of configurations.

Returns:

See Also:



4698
4699
4700
4701
 
# File 'lib/aws-sdk-datazone/client.rb', line 4698

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

#list_environment_blueprints(params = {}) ⇒ Types::ListEnvironmentBlueprintsOutput

Lists blueprints in an Amazon DataZone environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_blueprints({
  domain_identifier: "DomainId", # required
  managed: false,
  max_results: 1,
  name: "EnvironmentBlueprintName",
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].description #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].provider #=> String
resp.items[0].provisioning_properties.cloud_formation.template_url #=> String
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :managed (Boolean) —

    Specifies whether the environment blueprint is managed by Amazon DataZone.

  • :max_results (Integer) —

    The maximum number of blueprints to return in a single call to ‘ListEnvironmentBlueprints`. When the number of blueprints to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentBlueprints` to list the next set of blueprints.

  • :name (String) —

    The name of the Amazon DataZone environment.

  • :next_token (String) —

    When the number of blueprints in the environment is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of blueprints in the environment, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentBlueprints`to list the next set of blueprints.

Returns:

See Also:



4764
4765
4766
4767
 
# File 'lib/aws-sdk-datazone/client.rb', line 4764

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

#list_environment_profiles(params = {}) ⇒ Types::ListEnvironmentProfilesOutput

Lists Amazon DataZone environment profiles.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_profiles({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId",
  max_results: 1,
  name: "EnvironmentProfileName",
  next_token: "PaginationToken",
  project_identifier: "ProjectId",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (String) —

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

  • :aws_account_region (String) —

    The Amazon Web Services region where you want to list environment profiles.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_blueprint_identifier (String) —

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

  • :max_results (Integer) —

    The maximum number of environment profiles to return in a single call to ‘ListEnvironmentProfiles`. When the number of environment profiles to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentProfiles` to list the next set of environment profiles.

  • :name (String)
  • :next_token (String) —

    When the number of environment profiles is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environment profiles, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentProfiles` to list the next set of environment profiles.

  • :project_identifier (String) —

    The identifier of the Amazon DataZone project.

Returns:

See Also:



4848
4849
4850
4851
 
# File 'lib/aws-sdk-datazone/client.rb', line 4848

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

#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput

Lists Amazon DataZone environments.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environments({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  domain_identifier: "DomainId", # required
  environment_blueprint_identifier: "EnvironmentBlueprintId",
  environment_profile_identifier: "EnvironmentProfileId",
  max_results: 1,
  name: "String",
  next_token: "PaginationToken",
  project_identifier: "ProjectId", # required
  provider: "String",
  status: "ACTIVE", # accepts ACTIVE, CREATING, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED, VALIDATION_FAILED, SUSPENDED, DISABLED, EXPIRED, DELETED, INACCESSIBLE
})

Response structure


resp.items #=> Array
resp.items[0]. #=> String
resp.items[0]. #=> String
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].environment_profile_id #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].project_id #=> String
resp.items[0].provider #=> String
resp.items[0].status #=> String, one of "ACTIVE", "CREATING", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED", "VALIDATION_FAILED", "SUSPENDED", "DISABLED", "EXPIRED", "DELETED", "INACCESSIBLE"
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (String) —

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

  • :aws_account_region (String) —

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_blueprint_identifier (String) —

    The identifier of the Amazon DataZone blueprint.

  • :environment_profile_identifier (String) —

    The identifier of the environment profile.

  • :max_results (Integer) —

    The maximum number of environments to return in a single call to ‘ListEnvironments`. When the number of environments to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironments` to list the next set of environments.

  • :name (String) —

    The name of the environment.

  • :next_token (String) —

    When the number of environments is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environments, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironments` to list the next set of environments.

  • :project_identifier (required, String) —

    The identifier of the Amazon DataZone project.

  • :provider (String) —

    The provider of the environment.

  • :status (String) —

    The status of the environments that you want to list.

Returns:

See Also:



4943
4944
4945
4946
 
# File 'lib/aws-sdk-datazone/client.rb', line 4943

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

#list_metadata_generation_runs(params = {}) ⇒ Types::ListMetadataGenerationRunsOutput

Lists all metadata generation runs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_metadata_generation_runs({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, CANCELED, SUCCEEDED, FAILED
  type: "BUSINESS_DESCRIPTIONS", # accepts BUSINESS_DESCRIPTIONS
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain where you want to list metadata generation runs.

  • :max_results (Integer) —

    The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

  • :next_token (String) —

    When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

  • :status (String) —

    The status of the metadata generation runs.

  • :type (String) —

    The type of the metadata generation runs.

Returns:

See Also:



5012
5013
5014
5015
 
# File 'lib/aws-sdk-datazone/client.rb', line 5012

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

#list_notifications(params = {}) ⇒ Types::ListNotificationsOutput

Lists all Amazon DataZone notifications.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_notifications({
  after_timestamp: Time.now,
  before_timestamp: Time.now,
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  subjects: ["String"],
  task_status: "ACTIVE", # accepts ACTIVE, INACTIVE
  type: "TASK", # required, accepts TASK, EVENT
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    The time after which you want to list notifications.

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

    The time before which you want to list notifications.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :max_results (Integer) —

    The maximum number of notifications to return in a single call to ‘ListNotifications`. When the number of notifications to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListNotifications` to list the next set of notifications.

  • :next_token (String) —

    When the number of notifications is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of notifications, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListNotifications` to list the next set of notifications.

  • :subjects (Array<String>) —

    The subjects of notifications.

  • :task_status (String) —

    The task status of notifications.

  • :type (required, String) —

    The type of notifications.

Returns:

See Also:



5097
5098
5099
5100
 
# File 'lib/aws-sdk-datazone/client.rb', line 5097

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

#list_project_memberships(params = {}) ⇒ Types::ListProjectMembershipsOutput

Lists all members of the specified project.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_project_memberships({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  project_identifier: "ProjectId", # required
  sort_by: "NAME", # accepts NAME
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.members #=> Array
resp.members[0].designation #=> String, one of "PROJECT_OWNER", "PROJECT_CONTRIBUTOR"
resp.members[0].member_details.group.group_id #=> String
resp.members[0].member_details.user.user_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which you want to list project memberships.

  • :max_results (Integer) —

    The maximum number of memberships to return in a single call to ‘ListProjectMemberships`. When the number of memberships to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListProjectMemberships` to list the next set of memberships.

  • :next_token (String) —

    When the number of memberships is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of memberships, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListProjectMemberships` to list the next set of memberships.

  • :project_identifier (required, String) —

    The identifier of the project whose memberships you want to list.

  • :sort_by (String) —

    The method by which you want to sort the project memberships.

  • :sort_order (String) —

    The sort order of the project memberships.

Returns:

See Also:



5162
5163
5164
5165
 
# File 'lib/aws-sdk-datazone/client.rb', line 5162

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

#list_projects(params = {}) ⇒ Types::ListProjectsOutput

Lists Amazon DataZone projects.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  domain_identifier: "DomainId", # required
  group_identifier: "String",
  max_results: 1,
  name: "ProjectName",
  next_token: "PaginationToken",
  user_identifier: "String",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].description #=> String
resp.items[0].domain_id #=> String
resp.items[0].failure_reasons #=> Array
resp.items[0].failure_reasons[0].code #=> String
resp.items[0].failure_reasons[0].message #=> String
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].project_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED"
resp.items[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :group_identifier (String) —

    The identifier of a group.

  • :max_results (Integer) —

    The maximum number of projects to return in a single call to ‘ListProjects`. When the number of projects to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListProjects` to list the next set of projects.

  • :name (String) —

    The name of the project.

  • :next_token (String) —

    When the number of projects is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of projects, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListProjects` to list the next set of projects.

  • :user_identifier (String) —

    The identifier of the Amazon DataZone user.

Returns:

See Also:



5234
5235
5236
5237
 
# File 'lib/aws-sdk-datazone/client.rb', line 5234

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

#list_subscription_grants(params = {}) ⇒ Types::ListSubscriptionGrantsOutput

Lists subscription grants.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_grants({
  domain_identifier: "DomainId", # required
  environment_id: "EnvironmentId",
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  subscribed_listing_id: "ListingId",
  subscription_id: "SubscriptionId",
  subscription_target_id: "SubscriptionTargetId",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :environment_id (String) —

    The identifier of the Amazon DataZone environment.

  • :max_results (Integer) —

    The maximum number of subscription grants to return in a single call to ‘ListSubscriptionGrants`. When the number of subscription grants to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptionGrants` to list the next set of subscription grants.

  • :next_token (String) —

    When the number of subscription grants is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription grants, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionGrants` to list the next set of subscription grants.

  • :sort_by (String) —

    Specifies the way of sorting the results of this action.

  • :sort_order (String) —

    Specifies the sort order of this action.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing.

  • :subscription_id (String) —

    The identifier of the subscription.

  • :subscription_target_id (String) —

    The identifier of the subscription target.

Returns:

See Also:



5326
5327
5328
5329
 
# File 'lib/aws-sdk-datazone/client.rb', line 5326

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

#list_subscription_requests(params = {}) ⇒ Types::ListSubscriptionRequestsOutput

Lists Amazon DataZone subscription requests.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_requests({
  approver_project_id: "ProjectId",
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_id: "ProjectId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status: "PENDING", # accepts PENDING, ACCEPTED, REJECTED
  subscribed_listing_id: "ListingId",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].decision_comment #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].request_reason #=> String
resp.items[0].reviewer_id #=> String
resp.items[0].status #=> String, one of "PENDING", "ACCEPTED", "REJECTED"
resp.items[0].subscribed_listings #=> Array
resp.items[0].subscribed_listings[0].description #=> String
resp.items[0].subscribed_listings[0].id #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.entity_id #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.entity_revision #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.entity_type #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.forms #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.glossary_terms #=> Array
resp.items[0].subscribed_listings[0].item.asset_listing.glossary_terms[0].name #=> String
resp.items[0].subscribed_listings[0].item.asset_listing.glossary_terms[0].short_description #=> String
resp.items[0].subscribed_listings[0].name #=> String
resp.items[0].subscribed_listings[0].owner_project_id #=> String
resp.items[0].subscribed_listings[0].owner_project_name #=> String
resp.items[0].subscribed_listings[0].revision #=> String
resp.items[0].subscribed_principals #=> Array
resp.items[0].subscribed_principals[0].project.id #=> String
resp.items[0].subscribed_principals[0].project.name #=> String
resp.items[0].updated_at #=> Time
resp.items[0].updated_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :approver_project_id (String) —

    The identifier of the subscription request approver’s project.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :max_results (Integer) —

    The maximum number of subscription requests to return in a single call to ‘ListSubscriptionRequests`. When the number of subscription requests to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptionRequests` to list the next set of subscription requests.

  • :next_token (String) —

    When the number of subscription requests is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription requests, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionRequests` to list the next set of subscription requests.

  • :owning_project_id (String) —

    The identifier of the project for the subscription requests.

  • :sort_by (String) —

    Specifies the way to sort the results of this action.

  • :sort_order (String) —

    Specifies the sort order for the results of this action.

  • :status (String) —

    Specifies the status of the subscription requests.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing.

Returns:

See Also:



5428
5429
5430
5431
 
# File 'lib/aws-sdk-datazone/client.rb', line 5428

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

#list_subscription_targets(params = {}) ⇒ Types::ListSubscriptionTargetsOutput

Lists subscription targets in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscription_targets({
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain where you want to list subscription targets.

  • :environment_identifier (required, String) —

    The identifier of the environment where you want to list subscription targets.

  • :max_results (Integer) —

    The maximum number of subscription targets to return in a single call to ‘ListSubscriptionTargets`. When the number of subscription targets to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptionTargets` to list the next set of subscription targets.

  • :next_token (String) —

    When the number of subscription targets is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription targets, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionTargets` to list the next set of subscription targets.

  • :sort_by (String) —

    Specifies the way in which the results of this action are to be sorted.

  • :sort_order (String) —

    Specifies the sort order for the results of this action.

Returns:

See Also:



5513
5514
5515
5516
 
# File 'lib/aws-sdk-datazone/client.rb', line 5513

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

#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsOutput

Lists subscriptions in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_subscriptions({
  approver_project_id: "ProjectId",
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_id: "ProjectId",
  sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  status: "APPROVED", # accepts APPROVED, REVOKED, CANCELLED
  subscribed_listing_id: "ListingId",
  subscription_request_identifier: "SubscriptionRequestId",
})

Response structure


resp.items #=> Array
resp.items[0].created_at #=> Time
resp.items[0].created_by #=> String
resp.items[0].domain_id #=> String
resp.items[0].id #=> String
resp.items[0].retain_permissions #=> Boolean
resp.items[0].status #=> String, one of "APPROVED", "REVOKED", "CANCELLED"
resp.items[0].subscribed_listing.description #=> String
resp.items[0].subscribed_listing.id #=> String
resp.items[0].subscribed_listing.item.asset_listing.entity_id #=> String
resp.items[0].subscribed_listing.item.asset_listing.entity_revision #=> String
resp.items[0].subscribed_listing.item.asset_listing.entity_type #=> String
resp.items[0].subscribed_listing.item.asset_listing.forms #=> String
resp.items[0].subscribed_listing.item.asset_listing.glossary_terms #=> Array
resp.items[0].subscribed_listing.item.asset_listing.glossary_terms[0].name #=> String
resp.items[0].subscribed_listing.item.asset_listing.glossary_terms[0].short_description #=> String
resp.items[0].subscribed_listing.name #=> String
resp.items[0].subscribed_listing.owner_project_id #=> String
resp.items[0].subscribed_listing.owner_project_name #=> String
resp.items[0].subscribed_listing.revision #=> String
resp.items[0].subscribed_principal.project.id #=> String
resp.items[0].subscribed_principal.project.name #=> String
resp.items[0].subscription_request_id #=> String
resp.items[0].updated_at #=> Time
resp.items[0].updated_by #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :approver_project_id (String) —

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :max_results (Integer) —

    The maximum number of subscriptions to return in a single call to ‘ListSubscriptions`. When the number of subscriptions to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptions` to list the next set of Subscriptions.

  • :next_token (String) —

    When the number of subscriptions is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscriptions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptions` to list the next set of subscriptions.

  • :owning_project_id (String) —

    The identifier of the owning project.

  • :sort_by (String) —

    Specifies the way in which the results of this action are to be sorted.

  • :sort_order (String) —

    Specifies the sort order for the results of this action.

  • :status (String) —

    The status of the subscriptions that you want to list.

  • :subscribed_listing_id (String) —

    The identifier of the subscribed listing for the subscriptions that you want to list.

  • :subscription_request_identifier (String) —

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

Returns:

See Also:



5617
5618
5619
5620
 
# File 'lib/aws-sdk-datazone/client.rb', line 5617

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists tags for the specified resource in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource whose tags you want to list.

Returns:

See Also:



5646
5647
5648
5649
 
# File 'lib/aws-sdk-datazone/client.rb', line 5646

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

#list_time_series_data_points(params = {}) ⇒ Types::ListTimeSeriesDataPointsOutput

Lists time series data points.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_time_series_data_points({
  domain_identifier: "DomainId", # required
  ended_at: Time.now,
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  form_name: "TimeSeriesFormName", # required
  max_results: 1,
  next_token: "PaginationToken",
  started_at: Time.now,
})

Response structure


resp.items #=> Array
resp.items[0].content_summary #=> String
resp.items[0].form_name #=> String
resp.items[0].id #=> String
resp.items[0].timestamp #=> Time
resp.items[0].type_identifier #=> String
resp.items[0].type_revision #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.

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

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

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to list data points.

  • :entity_type (required, String) —

    The type of the asset for which you want to list data points.

  • :form_name (required, String) —

    The name of the time series data points form.

  • :max_results (Integer) —

    The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

  • :next_token (String) —

    When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

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

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

Returns:

See Also:



5722
5723
5724
5725
 
# File 'lib/aws-sdk-datazone/client.rb', line 5722

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

#post_time_series_data_points(params = {}) ⇒ Types::PostTimeSeriesDataPointsOutput

Posts time series data points to Amazon DataZone for the specified asset.

Examples:

Request syntax with placeholder values


resp = client.post_time_series_data_points({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  entity_identifier: "EntityIdentifier", # required
  entity_type: "ASSET", # required, accepts ASSET, LISTING
  forms: [ # required
    {
      content: "TimeSeriesDataPointFormInputContentString",
      form_name: "TimeSeriesFormName", # required
      timestamp: Time.now, # required
      type_identifier: "FormTypeIdentifier", # required
      type_revision: "Revision",
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :domain_identifier (required, String) —

    The ID of the Amazon DataZone domain in which you want to post time series data points.

  • :entity_identifier (required, String) —

    The ID of the asset for which you want to post time series data points.

  • :entity_type (required, String) —

    The type of the asset for which you want to post data points.

  • :forms (required, Array<Types::TimeSeriesDataPointFormInput>) —

    The forms that contain the data points that you want to post.

Returns:

See Also:



5793
5794
5795
5796
 
# File 'lib/aws-sdk-datazone/client.rb', line 5793

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

#put_environment_blueprint_configuration(params = {}) ⇒ Types::PutEnvironmentBlueprintConfigurationOutput

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.put_environment_blueprint_configuration({
  domain_identifier: "DomainId", # required
  enabled_regions: ["RegionName"], # required
  environment_blueprint_identifier: "EnvironmentBlueprintId", # required
  manage_access_role_arn: "RoleArn",
  provisioning_role_arn: "RoleArn",
  regional_parameters: {
    "RegionName" => {
      "String" => "String",
    },
  },
})

Response structure


resp.created_at #=> Time
resp.domain_id #=> String
resp.enabled_regions #=> Array
resp.enabled_regions[0] #=> String
resp.environment_blueprint_id #=> String
resp.manage_access_role_arn #=> String
resp.provisioning_role_arn #=> String
resp.regional_parameters #=> Hash
resp.regional_parameters["RegionName"] #=> Hash
resp.regional_parameters["RegionName"]["String"] #=> String
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

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

    Specifies the enabled Amazon Web Services Regions.

  • :environment_blueprint_identifier (required, String) —

    The identifier of the environment blueprint.

  • :manage_access_role_arn (String) —

    The ARN of the manage access role.

  • :provisioning_role_arn (String) —

    The ARN of the provisioning role.

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

    The regional parameters in the environment blueprint.

Returns:

See Also:



5863
5864
5865
5866
 
# File 'lib/aws-sdk-datazone/client.rb', line 5863

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

#reject_predictions(params = {}) ⇒ Types::RejectPredictionsOutput

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

Examples:

Request syntax with placeholder values


resp = client.reject_predictions({
  client_token: "ClientToken",
  domain_identifier: "DomainId", # required
  identifier: "AssetIdentifier", # required
  reject_choices: [
    {
      prediction_choices: [1],
      prediction_target: "String", # required
    },
  ],
  reject_rule: {
    rule: "ALL", # accepts ALL, NONE
    threshold: 1.0,
  },
  revision: "Revision",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :identifier (required, String) —

    The identifier of the prediction.

  • :reject_choices (Array<Types::RejectChoice>) —

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

  • :reject_rule (Types::RejectRule) —

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

  • :revision (String) —

    The revision that is to be made to the asset.

Returns:

See Also:



5931
5932
5933
5934
 
# File 'lib/aws-sdk-datazone/client.rb', line 5931

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

#reject_subscription_request(params = {}) ⇒ Types::RejectSubscriptionRequestOutput

Rejects the specified subscription request.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.id #=> 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.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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :decision_comment (String) —

    The decision comment of the rejected subscription request.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which the subscription request was rejected.

  • :identifier (required, String) —

    The identifier of the subscription request that was rejected.

Returns:

See Also:



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

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

#revoke_subscription(params = {}) ⇒ Types::RevokeSubscriptionOutput

Revokes a specified subscription in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain where you want to revoke a subscription.

  • :identifier (required, String) —

    The identifier of the revoked subscription.

  • :retain_permissions (Boolean) —

    Specifies whether permissions are retained when the subscription is revoked.

Returns:

See Also:



6076
6077
6078
6079
 
# File 'lib/aws-sdk-datazone/client.rb', line 6076

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

#search(params = {}) ⇒ Types::SearchOutput

Searches for assets in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search({
  additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS
  domain_identifier: "DomainId", # required
  filters: {
    and: [
      {
        # recursive FilterClause
      },
    ],
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString", # required
    },
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  max_results: 1,
  next_token: "PaginationToken",
  owning_project_identifier: "ProjectId",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  search_scope: "ASSET", # required, accepts ASSET, GLOSSARY, GLOSSARY_TERM
  search_text: "SearchText",
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.items #=> Array
resp.items[0].asset_item.additional_attributes.forms_output #=> Array
resp.items[0].asset_item.additional_attributes.forms_output[0].content #=> String
resp.items[0].asset_item.additional_attributes.forms_output[0].form_name #=> String
resp.items[0].asset_item.additional_attributes.forms_output[0].type_name #=> String
resp.items[0].asset_item.additional_attributes.forms_output[0].type_revision #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output #=> Array
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].content_summary #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].form_name #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].id #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].timestamp #=> Time
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].type_identifier #=> String
resp.items[0].asset_item.additional_attributes.latest_time_series_data_point_forms_output[0].type_revision #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output #=> Array
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].content #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].form_name #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].type_name #=> String
resp.items[0].asset_item.additional_attributes.read_only_forms_output[0].type_revision #=> String
resp.items[0].asset_item.created_at #=> Time
resp.items[0].asset_item.created_by #=> String
resp.items[0].asset_item.description #=> String
resp.items[0].asset_item.domain_id #=> String
resp.items[0].asset_item.external_identifier #=> String
resp.items[0].asset_item.first_revision_created_at #=> Time
resp.items[0].asset_item.first_revision_created_by #=> String
resp.items[0].asset_item.glossary_terms #=> Array
resp.items[0].asset_item.glossary_terms[0] #=> String
resp.items[0].asset_item.identifier #=> String
resp.items[0].asset_item.name #=> String
resp.items[0].asset_item.owning_project_id #=> String
resp.items[0].asset_item.type_identifier #=> String
resp.items[0].asset_item.type_revision #=> String
resp.items[0].data_product_item.created_at #=> Time
resp.items[0].data_product_item.created_by #=> String
resp.items[0].data_product_item.data_product_items #=> Array
resp.items[0].data_product_item.data_product_items[0].domain_id #=> String
resp.items[0].data_product_item.data_product_items[0].item_id #=> String
resp.items[0].data_product_item.description #=> String
resp.items[0].data_product_item.domain_id #=> String
resp.items[0].data_product_item.glossary_terms #=> Array
resp.items[0].data_product_item.glossary_terms[0] #=> String
resp.items[0].data_product_item.id #=> String
resp.items[0].data_product_item.name #=> String
resp.items[0].data_product_item.owning_project_id #=> String
resp.items[0].data_product_item.updated_at #=> Time
resp.items[0].data_product_item.updated_by #=> String
resp.items[0].glossary_item.created_at #=> Time
resp.items[0].glossary_item.created_by #=> String
resp.items[0].glossary_item.description #=> String
resp.items[0].glossary_item.domain_id #=> String
resp.items[0].glossary_item.id #=> String
resp.items[0].glossary_item.name #=> String
resp.items[0].glossary_item.owning_project_id #=> String
resp.items[0].glossary_item.status #=> String, one of "DISABLED", "ENABLED"
resp.items[0].glossary_item.updated_at #=> Time
resp.items[0].glossary_item.updated_by #=> String
resp.items[0].glossary_term_item.created_at #=> Time
resp.items[0].glossary_term_item.created_by #=> String
resp.items[0].glossary_term_item.domain_id #=> String
resp.items[0].glossary_term_item.glossary_id #=> String
resp.items[0].glossary_term_item.id #=> String
resp.items[0].glossary_term_item.long_description #=> String
resp.items[0].glossary_term_item.name #=> String
resp.items[0].glossary_term_item.short_description #=> String
resp.items[0].glossary_term_item.status #=> String, one of "ENABLED", "DISABLED"
resp.items[0].glossary_term_item.term_relations.classifies #=> Array
resp.items[0].glossary_term_item.term_relations.classifies[0] #=> String
resp.items[0].glossary_term_item.term_relations.is_a #=> Array
resp.items[0].glossary_term_item.term_relations.is_a[0] #=> String
resp.items[0].glossary_term_item.updated_at #=> Time
resp.items[0].glossary_term_item.updated_by #=> String
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :additional_attributes (Array<String>) —

    Specifies additional attributes for the ‘Search` action.

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain.

  • :filters (Types::FilterClause) —

    Specifies the search filters.

  • :max_results (Integer) —

    The maximum number of results to return in a single call to ‘Search`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `Search` to list the next set of results.

  • :next_token (String) —

    When the number of results is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `Search` to list the next set of results.

  • :owning_project_identifier (String) —

    The identifier of the owning project specified for the search.

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

    The details of the search.

  • :search_scope (required, String) —

    The scope of the search.

  • :search_text (String) —

    Specifies the text for which to search.

  • :sort (Types::SearchSort) —

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

Returns:

See Also:



6246
6247
6248
6249
 
# File 'lib/aws-sdk-datazone/client.rb', line 6246

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

#search_group_profiles(params = {}) ⇒ Types::SearchGroupProfilesOutput

Searches group profiles in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_group_profiles({
  domain_identifier: "DomainId", # required
  group_type: "SSO_GROUP", # required, accepts SSO_GROUP, DATAZONE_SSO_GROUP
  max_results: 1,
  next_token: "PaginationToken",
  search_text: "GroupSearchText",
})

Response structure


resp.items #=> Array
resp.items[0].domain_id #=> String
resp.items[0].group_name #=> String
resp.items[0].id #=> String
resp.items[0].status #=> String, one of "ASSIGNED", "NOT_ASSIGNED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which you want to search group profiles.

  • :group_type (required, String) —

    The group type for which to search.

  • :max_results (Integer) —

    The maximum number of results to return in a single call to ‘SearchGroupProfiles`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `SearchGroupProfiles` to list the next set of results.

  • :next_token (String) —

    When the number of results is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchGroupProfiles` to list the next set of results.

  • :search_text (String) —

    Specifies the text for which to search.

Returns:

See Also:



6308
6309
6310
6311
 
# File 'lib/aws-sdk-datazone/client.rb', line 6308

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

#search_listings(params = {}) ⇒ Types::SearchListingsOutput

Searches listings (records of an asset at a given time) in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_listings({
  additional_attributes: ["FORMS"], # accepts FORMS, TIME_SERIES_DATA_POINT_FORMS
  domain_identifier: "DomainId", # required
  filters: {
    and: [
      {
        # recursive FilterClause
      },
    ],
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString", # required
    },
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  max_results: 1,
  next_token: "PaginationToken",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  search_text: "String",
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.items #=> Array
resp.items[0].asset_listing.additional_attributes.forms #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms #=> Array
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].content_summary #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].form_name #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].id #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].timestamp #=> Time
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].type_identifier #=> String
resp.items[0].asset_listing.additional_attributes.latest_time_series_data_point_forms[0].type_revision #=> String
resp.items[0].asset_listing.created_at #=> Time
resp.items[0].asset_listing.description #=> String
resp.items[0].asset_listing.entity_id #=> String
resp.items[0].asset_listing.entity_revision #=> String
resp.items[0].asset_listing.entity_type #=> String
resp.items[0].asset_listing.glossary_terms #=> Array
resp.items[0].asset_listing.glossary_terms[0].name #=> String
resp.items[0].asset_listing.glossary_terms[0].short_description #=> String
resp.items[0].asset_listing.listing_created_by #=> String
resp.items[0].asset_listing.listing_id #=> String
resp.items[0].asset_listing.listing_revision #=> String
resp.items[0].asset_listing.listing_updated_by #=> String
resp.items[0].asset_listing.name #=> String
resp.items[0].asset_listing.owning_project_id #=> String
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :additional_attributes (Array<String>) —

    Specifies additional attributes for the search.

  • :domain_identifier (required, String) —

    The identifier of the domain in which to search listings.

  • :filters (Types::FilterClause) —

    Specifies the filters for the search of listings.

  • :max_results (Integer) —

    The maximum number of results to return in a single call to ‘SearchListings`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `SearchListings` to list the next set of results.

  • :next_token (String) —

    When the number of results is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchListings` to list the next set of results.

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

    The details of the search.

  • :search_text (String) —

    Specifies the text for which to search.

  • :sort (Types::SearchSort) —

    Specifies the way for sorting the search results.

Returns:

See Also:



6424
6425
6426
6427
 
# File 'lib/aws-sdk-datazone/client.rb', line 6424

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

#search_types(params = {}) ⇒ Types::SearchTypesOutput

Searches for types in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_types({
  domain_identifier: "DomainId", # required
  filters: {
    and: [
      {
        # recursive FilterClause
      },
    ],
    filter: {
      attribute: "Attribute", # required
      value: "FilterValueString", # required
    },
    or: [
      {
        # recursive FilterClause
      },
    ],
  },
  managed: false, # required
  max_results: 1,
  next_token: "PaginationToken",
  search_in: [
    {
      attribute: "Attribute", # required
    },
  ],
  search_scope: "ASSET_TYPE", # required, accepts ASSET_TYPE, FORM_TYPE
  search_text: "SearchText",
  sort: {
    attribute: "Attribute", # required
    order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.items #=> Array
resp.items[0].asset_type_item.created_at #=> Time
resp.items[0].asset_type_item.created_by #=> String
resp.items[0].asset_type_item.description #=> String
resp.items[0].asset_type_item.domain_id #=> String
resp.items[0].asset_type_item.forms_output #=> Hash
resp.items[0].asset_type_item.forms_output["FormName"].required #=> Boolean
resp.items[0].asset_type_item.forms_output["FormName"].type_name #=> String
resp.items[0].asset_type_item.forms_output["FormName"].type_revision #=> String
resp.items[0].asset_type_item.name #=> String
resp.items[0].asset_type_item.origin_domain_id #=> String
resp.items[0].asset_type_item.origin_project_id #=> String
resp.items[0].asset_type_item.owning_project_id #=> String
resp.items[0].asset_type_item.revision #=> String
resp.items[0].asset_type_item.updated_at #=> Time
resp.items[0].asset_type_item.updated_by #=> String
resp.items[0].form_type_item.created_at #=> Time
resp.items[0].form_type_item.created_by #=> String
resp.items[0].form_type_item.description #=> String
resp.items[0].form_type_item.domain_id #=> String
resp.items[0].form_type_item.imports #=> Array
resp.items[0].form_type_item.imports[0].name #=> String
resp.items[0].form_type_item.imports[0].revision #=> String
resp.items[0].form_type_item.model.smithy #=> String
resp.items[0].form_type_item.name #=> String
resp.items[0].form_type_item.origin_domain_id #=> String
resp.items[0].form_type_item.origin_project_id #=> String
resp.items[0].form_type_item.owning_project_id #=> String
resp.items[0].form_type_item.revision #=> String
resp.items[0].form_type_item.status #=> String, one of "ENABLED", "DISABLED"
resp.next_token #=> String
resp.total_match_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which to invoke the ‘SearchTypes` action.

  • :filters (Types::FilterClause) —

    The filters for the ‘SearchTypes` action.

  • :managed (required, Boolean) —

    Specifies whether the search is managed.

  • :max_results (Integer) —

    The maximum number of results to return in a single call to ‘SearchTypes`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `SearchTypes` to list the next set of results.

  • :next_token (String) —

    When the number of results is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchTypes` to list the next set of results.

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

    The details of the search.

  • :search_scope (required, String) —

    Specifies the scope of the search for types.

  • :search_text (String) —

    Specifies the text for which to search.

  • :sort (Types::SearchSort) —

    The specifies the way to sort the ‘SearchTypes` results.

Returns:

See Also:



6551
6552
6553
6554
 
# File 'lib/aws-sdk-datazone/client.rb', line 6551

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

#search_user_profiles(params = {}) ⇒ Types::SearchUserProfilesOutput

Searches user profiles in Amazon DataZone.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_user_profiles({
  domain_identifier: "DomainId", # required
  max_results: 1,
  next_token: "PaginationToken",
  search_text: "UserSearchText",
  user_type: "SSO_USER", # required, accepts SSO_USER, DATAZONE_USER, DATAZONE_SSO_USER, DATAZONE_IAM_USER
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which you want to search user profiles.

  • :max_results (Integer) —

    The maximum number of results to return in a single call to ‘SearchUserProfiles`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `SearchUserProfiles` to list the next set of results.

  • :next_token (String) —

    When the number of results is greater than the default value for the ‘MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchUserProfiles` to list the next set of results.

  • :search_text (String) —

    Specifies the text for which to search.

  • :user_type (required, String) —

    Specifies the user type for the ‘SearchUserProfiles` action.

Returns:

See Also:



6617
6618
6619
6620
 
# File 'lib/aws-sdk-datazone/client.rb', line 6617

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

#start_data_source_run(params = {}) ⇒ Types::StartDataSourceRunOutput

Start the run of the specified data source in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.start_data_source_run({
  client_token: "String",
  data_source_identifier: "DataSourceId", # required
  domain_identifier: "DomainId", # required
})

Response structure


resp.created_at #=> Time
resp.data_source_configuration_snapshot #=> String
resp.data_source_id #=> String
resp.domain_id #=> String
resp.error_message.error_detail #=> String
resp.error_message.error_type #=> String, one of "ACCESS_DENIED_EXCEPTION", "CONFLICT_EXCEPTION", "INTERNAL_SERVER_EXCEPTION", "RESOURCE_NOT_FOUND_EXCEPTION", "SERVICE_QUOTA_EXCEEDED_EXCEPTION", "THROTTLING_EXCEPTION", "VALIDATION_EXCEPTION"
resp.id #=> String
resp.project_id #=> String
resp.run_statistics_for_assets.added #=> Integer
resp.run_statistics_for_assets.failed #=> Integer
resp.run_statistics_for_assets.skipped #=> Integer
resp.run_statistics_for_assets.unchanged #=> Integer
resp.run_statistics_for_assets.updated #=> Integer
resp.started_at #=> Time
resp.status #=> String, one of "REQUESTED", "RUNNING", "FAILED", "PARTIALLY_SUCCEEDED", "SUCCESS"
resp.stopped_at #=> Time
resp.type #=> String, one of "PRIORITIZED", "SCHEDULED"
resp.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :data_source_identifier (required, String) —

    The identifier of the data source.

  • :domain_identifier (required, String) —

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

Returns:

See Also:



6687
6688
6689
6690
 
# File 'lib/aws-sdk-datazone/client.rb', line 6687

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

#start_metadata_generation_run(params = {}) ⇒ Types::StartMetadataGenerationRunOutput

Starts the metadata generation run.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :domain_identifier (required, String) —

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

  • :owning_project_identifier (required, String) —

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

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

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

  • :type (required, String) —

    The type of the metadata generation run.

Returns:

See Also:



6753
6754
6755
6756
 
# File 'lib/aws-sdk-datazone/client.rb', line 6753

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

#tag_resource(params = {}) ⇒ Struct

Tags a resource in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be tagged in Amazon DataZone.

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

    Specifies the tags for the ‘TagResource` action.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6781
6782
6783
6784
 
# File 'lib/aws-sdk-datazone/client.rb', line 6781

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

#untag_resource(params = {}) ⇒ Struct

Untags a resource in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to be untagged in Amazon DataZone.

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

    Specifies the tag keys for the ‘UntagResource` action.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6807
6808
6809
6810
 
# File 'lib/aws-sdk-datazone/client.rb', line 6807

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

#update_data_source(params = {}) ⇒ Types::UpdateDataSourceOutput

Updates the specified data source in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_data_source({
  asset_forms_input: [
    {
      content: "FormInputContentString",
      form_name: "FormName", # required
      type_identifier: "FormTypeIdentifier",
      type_revision: "Revision",
    },
  ],
  configuration: {
    glue_run_configuration: {
      auto_import_data_quality_result: false,
      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: { # required
        secret_manager_arn: "RedshiftCredentialConfigurationSecretManagerArnString", # required
      },
      redshift_storage: { # required
        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",
        },
      ],
    },
  },
  description: "Description",
  domain_identifier: "DomainId", # required
  enable_setting: "ENABLED", # accepts ENABLED, DISABLED
  identifier: "DataSourceId", # required
  name: "Name",
  publish_on_import: false,
  recommendation: {
    enable_business_name_generation: false,
  },
  schedule: {
    schedule: "CronString",
    timezone: "UTC", # accepts UTC, AFRICA_JOHANNESBURG, AMERICA_MONTREAL, AMERICA_SAO_PAULO, ASIA_BAHRAIN, ASIA_BANGKOK, ASIA_CALCUTTA, ASIA_DUBAI, ASIA_HONG_KONG, ASIA_JAKARTA, ASIA_KUALA_LUMPUR, ASIA_SEOUL, ASIA_SHANGHAI, ASIA_SINGAPORE, ASIA_TAIPEI, ASIA_TOKYO, AUSTRALIA_MELBOURNE, AUSTRALIA_SYDNEY, CANADA_CENTRAL, CET, CST6CDT, ETC_GMT, ETC_GMT0, ETC_GMT_ADD_0, ETC_GMT_ADD_1, ETC_GMT_ADD_10, ETC_GMT_ADD_11, ETC_GMT_ADD_12, ETC_GMT_ADD_2, ETC_GMT_ADD_3, ETC_GMT_ADD_4, ETC_GMT_ADD_5, ETC_GMT_ADD_6, ETC_GMT_ADD_7, ETC_GMT_ADD_8, ETC_GMT_ADD_9, ETC_GMT_NEG_0, ETC_GMT_NEG_1, ETC_GMT_NEG_10, ETC_GMT_NEG_11, ETC_GMT_NEG_12, ETC_GMT_NEG_13, ETC_GMT_NEG_14, ETC_GMT_NEG_2, ETC_GMT_NEG_3, ETC_GMT_NEG_4, ETC_GMT_NEG_5, ETC_GMT_NEG_6, ETC_GMT_NEG_7, ETC_GMT_NEG_8, ETC_GMT_NEG_9, EUROPE_DUBLIN, EUROPE_LONDON, EUROPE_PARIS, EUROPE_STOCKHOLM, EUROPE_ZURICH, ISRAEL, MEXICO_GENERAL, MST7MDT, PACIFIC_AUCKLAND, US_CENTRAL, US_EASTERN, US_MOUNTAIN, US_PACIFIC
  },
})

Response structure


resp.asset_forms_output #=> Array
resp.asset_forms_output[0].content #=> String
resp.asset_forms_output[0].form_name #=> String
resp.asset_forms_output[0].type_name #=> String
resp.asset_forms_output[0].type_revision #=> String
resp.configuration.glue_run_configuration. #=> String
resp.configuration.glue_run_configuration.auto_import_data_quality_result #=> Boolean
resp.configuration.glue_run_configuration.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.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 asset forms to be updated as part of the ‘UpdateDataSource` action.

  • :configuration (Types::DataSourceConfigurationInput) —

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

  • :description (String) —

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

  • :domain_identifier (required, String) —

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

  • :enable_setting (String) —

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

  • :identifier (required, String) —

    The identifier of the data source to be updated.

  • :name (String) —

    The name to be updated as part of the ‘UpdateDataSource` action.

  • :publish_on_import (Boolean) —

    The publish on import setting to be updated as part of the ‘UpdateDataSource` action.

  • :recommendation (Types::RecommendationConfiguration) —

    The recommendation to be updated as part of the ‘UpdateDataSource` action.

  • :schedule (Types::ScheduleConfiguration) —

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

Returns:

See Also:



6998
6999
7000
7001
 
# File 'lib/aws-sdk-datazone/client.rb', line 6998

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

#update_domain(params = {}) ⇒ Types::UpdateDomainOutput

Updates a Amazon DataZone domain.

Examples:

Request syntax with placeholder values


resp = client.update_domain({
  client_token: "String",
  description: "String",
  domain_execution_role: "RoleArn",
  identifier: "DomainId", # required
  name: "String",
  single_sign_on: {
    type: "IAM_IDC", # accepts IAM_IDC, DISABLED
    user_assignment: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :description (String) —

    The description to be updated as part of the ‘UpdateDomain` action.

  • :domain_execution_role (String) —

    The domain execution role to be updated as part of the ‘UpdateDomain` action.

  • :identifier (required, String) —

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

  • :name (String) —

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

  • :single_sign_on (Types::SingleSignOn) —

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

Returns:

See Also:



7066
7067
7068
7069
 
# File 'lib/aws-sdk-datazone/client.rb', line 7066

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

#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput

Updates the specified environment in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_environment({
  description: "String",
  domain_identifier: "DomainId", # required
  glossary_terms: ["GlossaryTermId"],
  identifier: "EnvironmentId", # required
  name: "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):

  • :description (String) —

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

  • :domain_identifier (required, String) —

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

  • :glossary_terms (Array<String>) —

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

  • :identifier (required, String) —

    The identifier of the environment that is to be updated.

  • :name (String) —

    The name to be updated as part of the ‘UpdateEnvironment` action.

Returns:

See Also:



7177
7178
7179
7180
 
# File 'lib/aws-sdk-datazone/client.rb', line 7177

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

#update_environment_profile(params = {}) ⇒ Types::UpdateEnvironmentProfileOutput

Updates the specified environment profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_environment_profile({
  aws_account_id: "AwsAccountId",
  aws_account_region: "AwsRegion",
  description: "String",
  domain_identifier: "DomainId", # required
  identifier: "EnvironmentProfileId", # required
  name: "EnvironmentProfileName",
  user_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :aws_account_id (String) —

    The Amazon Web Services account in which a specified environment profile is to be udpated.

  • :aws_account_region (String) —

    The Amazon Web Services Region in which a specified environment profile is to be updated.

  • :description (String) —

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

  • :identifier (required, String) —

    The identifier of the environment profile that is to be updated.

  • :name (String) —

    The name to be updated as part of the ‘UpdateEnvironmentProfile` action.

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

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

Returns:

See Also:



7268
7269
7270
7271
 
# File 'lib/aws-sdk-datazone/client.rb', line 7268

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

#update_glossary(params = {}) ⇒ Types::UpdateGlossaryOutput

Updates the business glossary in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


resp.description #=> String
resp.domain_id #=> String
resp.id #=> String
resp.name #=> String
resp.owning_project_id #=> String
resp.status #=> String, one of "DISABLED", "ENABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

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

  • :description (String) —

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

  • :identifier (required, String) —

    The identifier of the business glossary to be updated.

  • :name (String) —

    The name to be updated as part of the ‘UpdateGlossary` action.

  • :status (String) —

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

Returns:

See Also:



7331
7332
7333
7334
 
# File 'lib/aws-sdk-datazone/client.rb', line 7331

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

#update_glossary_term(params = {}) ⇒ Types::UpdateGlossaryTermOutput

Updates a business glossary term in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

  • :glossary_identifier (String) —

    The identifier of the business glossary in which a term is to be updated.

  • :identifier (required, String) —

    The identifier of the business glossary term that is to be updated.

  • :long_description (String) —

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

  • :name (String) —

    The name to be updated as part of the ‘UpdateGlossaryTerm` action.

  • :short_description (String) —

    The short description to be updated as part of the ‘UpdateGlossaryTerm` action.

  • :status (String) —

    The status to be updated as part of the ‘UpdateGlossaryTerm` action.

  • :term_relations (Types::TermRelations) —

    The term relations to be updated as part of the ‘UpdateGlossaryTerm` action.

Returns:

See Also:



7412
7413
7414
7415
 
# File 'lib/aws-sdk-datazone/client.rb', line 7412

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

#update_group_profile(params = {}) ⇒ Types::UpdateGroupProfileOutput

Updates the specified group profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_group_profile({
  domain_identifier: "DomainId", # required
  group_identifier: "GroupIdentifier", # required
  status: "ASSIGNED", # required, accepts ASSIGNED, NOT_ASSIGNED
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :group_identifier (required, String) —

    The identifier of the group profile that is updated.

  • :status (required, String) —

    The status of the group profile that is updated.

Returns:

See Also:



7455
7456
7457
7458
 
# File 'lib/aws-sdk-datazone/client.rb', line 7455

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

#update_project(params = {}) ⇒ Types::UpdateProjectOutput

Updates the specified project in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_project({
  description: "Description",
  domain_identifier: "DomainId", # required
  glossary_terms: ["GlossaryTermId"],
  identifier: "ProjectId", # required
  name: "ProjectName",
})

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.domain_id #=> String
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_status #=> String, one of "ACTIVE", "DELETING", "DELETE_FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

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

  • :domain_identifier (required, String) —

    The identifier of the Amazon DataZone domain in which a project is to be updated.

  • :glossary_terms (Array<String>) —

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

  • :identifier (required, String) —

    The identifier of the project that is to be updated.

  • :name (String) —

    The name to be updated as part of the ‘UpdateProject` action.

Returns:

See Also:



7522
7523
7524
7525
 
# File 'lib/aws-sdk-datazone/client.rb', line 7522

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

#update_subscription_grant_status(params = {}) ⇒ Types::UpdateSubscriptionGrantStatusOutput

Updates the status of the specified subscription grant status in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_subscription_grant_status({
  asset_identifier: "AssetId", # required
  domain_identifier: "DomainId", # required
  failure_cause: {
    message: "String",
  },
  identifier: "SubscriptionGrantId", # required
  status: "GRANT_PENDING", # required, accepts GRANT_PENDING, REVOKE_PENDING, GRANT_IN_PROGRESS, REVOKE_IN_PROGRESS, GRANTED, REVOKED, GRANT_FAILED, REVOKE_FAILED
  target_name: "String",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :asset_identifier (required, String) —

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

  • :domain_identifier (required, String) —

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

  • :failure_cause (Types::FailureCause) —

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

  • :identifier (required, String) —

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

  • :status (required, String) —

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

  • :target_name (String) —

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

Returns:

See Also:



7607
7608
7609
7610
 
# File 'lib/aws-sdk-datazone/client.rb', line 7607

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

#update_subscription_request(params = {}) ⇒ Types::UpdateSubscriptionRequestOutput

Updates a specified subscription request in Amazon DataZone.

Examples:

Request syntax with placeholder values


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

Response structure


resp.created_at #=> Time
resp.created_by #=> String
resp.decision_comment #=> String
resp.domain_id #=> String
resp.id #=> 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.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].name #=> String
resp.subscribed_listings[0].owner_project_id #=> String
resp.subscribed_listings[0].owner_project_name #=> String
resp.subscribed_listings[0].revision #=> String
resp.subscribed_principals #=> Array
resp.subscribed_principals[0].project.id #=> String
resp.subscribed_principals[0].project.name #=> String
resp.updated_at #=> Time
resp.updated_by #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :identifier (required, String) —

    The identifier of the subscription request that is to be updated.

  • :request_reason (required, String) —

    The reason for the ‘UpdateSubscriptionRequest` action.

Returns:

See Also:



7681
7682
7683
7684
 
# File 'lib/aws-sdk-datazone/client.rb', line 7681

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

#update_subscription_target(params = {}) ⇒ Types::UpdateSubscriptionTargetOutput

Updates the specified subscription target in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.update_subscription_target({
  applicable_asset_types: ["TypeName"],
  authorized_principals: ["AuthorizedPrincipalIdentifier"],
  domain_identifier: "DomainId", # required
  environment_identifier: "EnvironmentId", # required
  identifier: "SubscriptionTargetId", # required
  manage_access_role: "String",
  name: "SubscriptionTargetName",
  provider: "String",
  subscription_target_config: [
    {
      content: "String", # required
      form_name: "FormName", # required
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :applicable_asset_types (Array<String>) —

    The applicable asset types to be updated as part of the ‘UpdateSubscriptionTarget` action.

  • :authorized_principals (Array<String>) —

    The authorized principals to be updated as part of the ‘UpdateSubscriptionTarget` action.

  • :domain_identifier (required, String) —

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

  • :environment_identifier (required, String) —

    The identifier of the environment in which a subscription target is to be updated.

  • :identifier (required, String) —

    Identifier of the subscription target that is to be updated.

  • :manage_access_role (String) —

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

  • :name (String) —

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

  • :provider (String) —

    The provider to be updated as part of the ‘UpdateSubscriptionTarget` action.

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

    The configuration to be updated as part of the ‘UpdateSubscriptionTarget` action.

Returns:

See Also:



7786
7787
7788
7789
 
# File 'lib/aws-sdk-datazone/client.rb', line 7786

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

#update_user_profile(params = {}) ⇒ Types::UpdateUserProfileOutput

Updates the specified user profile in Amazon DataZone.

Examples:

Request syntax with placeholder values


resp = client.({
  domain_identifier: "DomainId", # required
  status: "ASSIGNED", # required, accepts ASSIGNED, NOT_ASSIGNED, ACTIVATED, DEACTIVATED
  type: "IAM", # accepts IAM, SSO
  user_identifier: "UserIdentifier", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_identifier (required, String) —

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

  • :status (required, String) —

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

  • :type (String) —

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

  • :user_identifier (required, String) —

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

Returns:

See Also:



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

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


7862
7863
7864
 
# File 'lib/aws-sdk-datazone/client.rb', line 7862

def waiter_names
  []
end