Class: Aws::BedrockDataAutomation::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]

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

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

    • ~/.aws/credentials

    • ~/.aws/config

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

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

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

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

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

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

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

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

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

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

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

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

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

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

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

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



478
479
480
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#copy_blueprint_stage(params = {}) ⇒ Struct

Copies a Blueprint from one stage to another

Examples:

Request syntax with placeholder values


resp = client.copy_blueprint_stage({
  blueprint_arn: "BlueprintArn", # required
  source_stage: "DEVELOPMENT", # required, accepts DEVELOPMENT, LIVE
  target_stage: "DEVELOPMENT", # required, accepts DEVELOPMENT, LIVE
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_arn (required, String) —

    Blueprint to be copied

  • :source_stage (required, String) —

    Source stage to copy from

  • :target_stage (required, String) —

    Target stage to copy to

  • :client_token (String) —

    Client token for idempotency

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



516
517
518
519
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 516

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

#create_blueprint(params = {}) ⇒ Types::CreateBlueprintResponse

Creates an Amazon Bedrock Data Automation Blueprint

Examples:

Request syntax with placeholder values


resp = client.create_blueprint({
  blueprint_name: "BlueprintName", # required
  type: "DOCUMENT", # required, accepts DOCUMENT, IMAGE, AUDIO, VIDEO
  blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  schema: "BlueprintSchema", # required
  client_token: "ClientToken",
  encryption_configuration: {
    kms_key_id: "KmsKeyId", # required
    kms_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.blueprint.blueprint_arn #=> String
resp.blueprint.schema #=> String
resp.blueprint.type #=> String, one of "DOCUMENT", "IMAGE", "AUDIO", "VIDEO"
resp.blueprint.creation_time #=> Time
resp.blueprint.last_modified_time #=> Time
resp.blueprint.blueprint_name #=> String
resp.blueprint.blueprint_version #=> String
resp.blueprint.blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.blueprint.kms_key_id #=> String
resp.blueprint.kms_encryption_context #=> Hash
resp.blueprint.kms_encryption_context["EncryptionContextKey"] #=> String
resp.blueprint.optimization_samples #=> Array
resp.blueprint.optimization_samples[0].asset_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].asset_s3_object.version #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.version #=> String
resp.blueprint.optimization_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_name (required, String) —

    Name of the Blueprint

  • :type (required, String) —

    Type

  • :blueprint_stage (String) —

    Stage of the Blueprint

  • :schema (required, String) —

    Schema of the blueprint

  • :client_token (String) —

    Client specified token used for idempotency checks

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

  • :encryption_configuration (Types::EncryptionConfiguration) —

    KMS Encryption Configuration

  • :tags (Array<Types::Tag>) —

    List of tags

Returns:

See Also:



597
598
599
600
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 597

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

#create_blueprint_version(params = {}) ⇒ Types::CreateBlueprintVersionResponse

Creates a new version of an existing Amazon Bedrock Data Automation Blueprint

Examples:

Request syntax with placeholder values


resp = client.create_blueprint_version({
  blueprint_arn: "BlueprintArn", # required
  client_token: "ClientToken",
})

Response structure


resp.blueprint.blueprint_arn #=> String
resp.blueprint.schema #=> String
resp.blueprint.type #=> String, one of "DOCUMENT", "IMAGE", "AUDIO", "VIDEO"
resp.blueprint.creation_time #=> Time
resp.blueprint.last_modified_time #=> Time
resp.blueprint.blueprint_name #=> String
resp.blueprint.blueprint_version #=> String
resp.blueprint.blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.blueprint.kms_key_id #=> String
resp.blueprint.kms_encryption_context #=> Hash
resp.blueprint.kms_encryption_context["EncryptionContextKey"] #=> String
resp.blueprint.optimization_samples #=> Array
resp.blueprint.optimization_samples[0].asset_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].asset_s3_object.version #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.version #=> String
resp.blueprint.optimization_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_arn (required, String) —

    ARN generated at the server side when a Blueprint is created

  • :client_token (String) —

    Client specified token used for idempotency checks

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

Returns:

See Also:



649
650
651
652
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 649

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

#create_data_automation_library(params = {}) ⇒ Types::CreateDataAutomationLibraryResponse

Creates an Amazon Bedrock Data Automation Library

Examples:

Request syntax with placeholder values


resp = client.create_data_automation_library({
  library_name: "DataAutomationLibraryName", # required
  library_description: "DataAutomationLibraryDescription",
  client_token: "ClientToken",
  encryption_configuration: {
    kms_key_id: "KmsKeyId", # required
    kms_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.library_arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

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

    ({})

Options Hash (params):

  • :library_name (required, String) —

    Name of the DataAutomationLibrary

  • :library_description (String) —

    Description of the DataAutomationLibrary

  • :client_token (String) —

    Client specified token used for idempotency checks

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

  • :encryption_configuration (Types::EncryptionConfiguration) —

    KMS Encryption Configuration

  • :tags (Array<Types::Tag>) —

    List of tags

Returns:

See Also:



708
709
710
711
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 708

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

#create_data_automation_project(params = {}) ⇒ Types::CreateDataAutomationProjectResponse

Creates an Amazon Bedrock Data Automation Project

Examples:

Request syntax with placeholder values


resp = client.create_data_automation_project({
  project_name: "DataAutomationProjectName", # required
  project_description: "DataAutomationProjectDescription",
  project_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  project_type: "ASYNC", # accepts ASYNC, SYNC
  standard_output_configuration: { # required
    document: {
      extraction: {
        granularity: { # required
          types: ["DOCUMENT"], # accepts DOCUMENT, PAGE, ELEMENT, WORD, LINE
        },
        bounding_box: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
      },
      output_format: {
        text_format: { # required
          types: ["PLAIN_TEXT"], # accepts PLAIN_TEXT, MARKDOWN, HTML, CSV
        },
        additional_file_format: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
    },
    image: {
      extraction: {
        category: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
          types: ["CONTENT_MODERATION"], # accepts CONTENT_MODERATION, TEXT_DETECTION, LOGOS
        },
        bounding_box: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        types: ["IMAGE_SUMMARY"], # accepts IMAGE_SUMMARY, IAB
      },
    },
    video: {
      extraction: {
        category: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
          types: ["CONTENT_MODERATION"], # accepts CONTENT_MODERATION, TEXT_DETECTION, TRANSCRIPT, LOGOS
        },
        bounding_box: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        types: ["VIDEO_SUMMARY"], # accepts VIDEO_SUMMARY, IAB, CHAPTER_SUMMARY
      },
    },
    audio: {
      extraction: {
        category: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
          types: ["AUDIO_CONTENT_MODERATION"], # accepts AUDIO_CONTENT_MODERATION, TRANSCRIPT, TOPIC_CONTENT_MODERATION
          type_configuration: {
            transcript: {
              speaker_labeling: {
                state: "ENABLED", # required, accepts ENABLED, DISABLED
              },
              channel_labeling: {
                state: "ENABLED", # required, accepts ENABLED, DISABLED
              },
            },
          },
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        types: ["AUDIO_SUMMARY"], # accepts AUDIO_SUMMARY, IAB, TOPIC_SUMMARY
      },
    },
  },
  custom_output_configuration: {
    blueprints: [
      {
        blueprint_arn: "BlueprintArn", # required
        blueprint_version: "BlueprintVersion",
        blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
      },
    ],
    document: {
      fallback_blueprints: [
        {
          blueprint_arn: "BlueprintArn", # required
          blueprint_version: "BlueprintVersion",
          blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
        },
      ],
    },
  },
  override_configuration: {
    document: {
      splitter: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    image: {
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    video: {
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    audio: {
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      language_configuration: {
        input_languages: ["EN"], # accepts EN, DE, ES, FR, IT, PT, JA, KO, CN, TW, HK
        generative_output_language: "DEFAULT", # accepts DEFAULT, EN
        identify_multiple_languages: false,
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    modality_routing: {
      jpeg: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
      png: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
      mp4: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
      mov: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
    },
  },
  data_automation_library_configuration: {
    libraries: [
      {
        library_arn: "DataAutomationLibraryArn", # required
      },
    ],
  },
  client_token: "ClientToken",
  encryption_configuration: {
    kms_key_id: "KmsKeyId", # required
    kms_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.project_arn #=> String
resp.project_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :project_name (required, String) —

    Name of the DataAutomationProject

  • :project_description (String) —

    Description of the DataAutomationProject

  • :project_stage (String) —

    Stage of the Project

  • :project_type (String) —

    Type of the DataAutomationProject

  • :standard_output_configuration (required, Types::StandardOutputConfiguration) —

    Standard output configuration

  • :custom_output_configuration (Types::CustomOutputConfiguration) —

    Custom output configuration

  • :override_configuration (Types::OverrideConfiguration) —

    Override configuration

  • :data_automation_library_configuration (Types::DataAutomationLibraryConfiguration) —

    DataAutomation Library configuration

  • :client_token (String) —

    Client specified token used for idempotency checks

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

  • :encryption_configuration (Types::EncryptionConfiguration) —

    KMS Encryption Configuration

  • :tags (Array<Types::Tag>) —

    List of tags

Returns:

See Also:



957
958
959
960
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 957

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

#delete_blueprint(params = {}) ⇒ Struct

Deletes an existing Amazon Bedrock Data Automation Blueprint

Examples:

Request syntax with placeholder values


resp = client.delete_blueprint({
  blueprint_arn: "BlueprintArn", # required
  blueprint_version: "BlueprintVersion",
})

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_arn (required, String) —

    ARN generated at the server side when a Blueprint is created

  • :blueprint_version (String) —

    Optional field to delete a specific Blueprint version

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



983
984
985
986
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 983

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

#delete_data_automation_library(params = {}) ⇒ Types::DeleteDataAutomationLibraryResponse

Deletes an existing Amazon Bedrock Data Automation Library

Examples:

Request syntax with placeholder values


resp = client.delete_data_automation_library({
  library_arn: "DataAutomationLibraryArn", # required
})

Response structure


resp.library_arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

Returns:

See Also:



1014
1015
1016
1017
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1014

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

#delete_data_automation_project(params = {}) ⇒ Types::DeleteDataAutomationProjectResponse

Deletes an existing Amazon Bedrock Data Automation Project

Examples:

Request syntax with placeholder values


resp = client.delete_data_automation_project({
  project_arn: "DataAutomationProjectArn", # required
})

Response structure


resp.project_arn #=> String
resp.status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :project_arn (required, String) —

    ARN generated at the server side when a DataAutomationProject is created

Returns:

See Also:



1045
1046
1047
1048
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1045

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

#get_blueprint(params = {}) ⇒ Types::GetBlueprintResponse

Gets an existing Amazon Bedrock Data Automation Blueprint

Examples:

Request syntax with placeholder values


resp = client.get_blueprint({
  blueprint_arn: "BlueprintArn", # required
  blueprint_version: "BlueprintVersion",
  blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
})

Response structure


resp.blueprint.blueprint_arn #=> String
resp.blueprint.schema #=> String
resp.blueprint.type #=> String, one of "DOCUMENT", "IMAGE", "AUDIO", "VIDEO"
resp.blueprint.creation_time #=> Time
resp.blueprint.last_modified_time #=> Time
resp.blueprint.blueprint_name #=> String
resp.blueprint.blueprint_version #=> String
resp.blueprint.blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.blueprint.kms_key_id #=> String
resp.blueprint.kms_encryption_context #=> Hash
resp.blueprint.kms_encryption_context["EncryptionContextKey"] #=> String
resp.blueprint.optimization_samples #=> Array
resp.blueprint.optimization_samples[0].asset_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].asset_s3_object.version #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.version #=> String
resp.blueprint.optimization_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_arn (required, String) —

    ARN generated at the server side when a Blueprint is created

  • :blueprint_version (String) —

    Optional field to get a specific Blueprint version

  • :blueprint_stage (String) —

    Optional field to get a specific Blueprint stage

Returns:

See Also:



1097
1098
1099
1100
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1097

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

#get_blueprint_optimization_status(params = {}) ⇒ Types::GetBlueprintOptimizationStatusResponse

API used to get blueprint optimization status.

Examples:

Request syntax with placeholder values


resp = client.get_blueprint_optimization_status({
  invocation_arn: "BlueprintOptimizationInvocationArn", # required
})

Response structure


resp.status #=> String, one of "Created", "InProgress", "Success", "ServiceError", "ClientError"
resp.error_type #=> String
resp.error_message #=> String
resp.output_configuration.s3_object.s3_uri #=> String
resp.output_configuration.s3_object.version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :invocation_arn (required, String) —

    Invocation arn.

Returns:

See Also:



1132
1133
1134
1135
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1132

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

#get_data_automation_library(params = {}) ⇒ Types::GetDataAutomationLibraryResponse

Gets an existing Amazon Bedrock Data Automation Library

Examples:

Request syntax with placeholder values


resp = client.get_data_automation_library({
  library_arn: "DataAutomationLibraryArn", # required
})

Response structure


resp.library.library_arn #=> String
resp.library.creation_time #=> Time
resp.library.library_name #=> String
resp.library.library_description #=> String
resp.library.status #=> String, one of "ACTIVE", "DELETING"
resp.library.entity_types #=> Array
resp.library.entity_types[0].entity_type #=> String, one of "VOCABULARY"
resp.library.entity_types[0].entity_metadata #=> String
resp.library.kms_key_id #=> String
resp.library.kms_encryption_context #=> Hash
resp.library.kms_encryption_context["EncryptionContextKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

Returns:

See Also:



1171
1172
1173
1174
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1171

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

#get_data_automation_library_entity(params = {}) ⇒ Types::GetDataAutomationLibraryEntityResponse

Gets an existing entity based on entity type from the library

Examples:

Request syntax with placeholder values


resp = client.get_data_automation_library_entity({
  library_arn: "DataAutomationLibraryArn", # required
  entity_type: "VOCABULARY", # required, accepts VOCABULARY
  entity_id: "EntityId", # required
})

Response structure


resp.entity.vocabulary.entity_id #=> String
resp.entity.vocabulary.description #=> String
resp.entity.vocabulary.language #=> String, one of "EN", "DE", "ES", "FR", "IT", "PT", "JA", "KO", "CN", "TW", "HK"
resp.entity.vocabulary.phrases #=> Array
resp.entity.vocabulary.phrases[0].text #=> String
resp.entity.vocabulary.phrases[0].display_as_text #=> String
resp.entity.vocabulary.last_modified_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

  • :entity_type (required, String) —

    The entity type for which the entity is requested

  • :entity_id (required, String) —

    Unique identifier for the entity

Returns:

See Also:



1214
1215
1216
1217
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1214

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

#get_data_automation_library_ingestion_job(params = {}) ⇒ Types::GetDataAutomationLibraryIngestionJobResponse

API used to get status of data automation library ingestion job

Examples:

Request syntax with placeholder values


resp = client.get_data_automation_library_ingestion_job({
  library_arn: "DataAutomationLibraryArn", # required
  job_arn: "DataAutomationLibraryIngestionJobArn", # required
})

Response structure


resp.job.job_arn #=> String
resp.job.creation_time #=> Time
resp.job.entity_type #=> String, one of "VOCABULARY"
resp.job.operation_type #=> String, one of "UPSERT", "DELETE"
resp.job.job_status #=> String, one of "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.job.output_configuration.s3_uri #=> String
resp.job.completion_time #=> Time
resp.job.error_message #=> String
resp.job.error_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

  • :job_arn (required, String) —

    ARN of the DataAutomationLibraryIngestionJob

Returns:

See Also:



1255
1256
1257
1258
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1255

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

#get_data_automation_project(params = {}) ⇒ Types::GetDataAutomationProjectResponse

Gets an existing Amazon Bedrock Data Automation Project

Examples:

Request syntax with placeholder values


resp = client.get_data_automation_project({
  project_arn: "DataAutomationProjectArn", # required
  project_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
})

Response structure


resp.project.project_arn #=> String
resp.project.creation_time #=> Time
resp.project.last_modified_time #=> Time
resp.project.project_name #=> String
resp.project.project_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.project.project_type #=> String, one of "ASYNC", "SYNC"
resp.project.project_description #=> String
resp.project.standard_output_configuration.document.extraction.granularity.types #=> Array
resp.project.standard_output_configuration.document.extraction.granularity.types[0] #=> String, one of "DOCUMENT", "PAGE", "ELEMENT", "WORD", "LINE"
resp.project.standard_output_configuration.document.extraction.bounding_box.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.document.generative_field.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.document.output_format.text_format.types #=> Array
resp.project.standard_output_configuration.document.output_format.text_format.types[0] #=> String, one of "PLAIN_TEXT", "MARKDOWN", "HTML", "CSV"
resp.project.standard_output_configuration.document.output_format.additional_file_format.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.image.extraction.category.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.image.extraction.category.types #=> Array
resp.project.standard_output_configuration.image.extraction.category.types[0] #=> String, one of "CONTENT_MODERATION", "TEXT_DETECTION", "LOGOS"
resp.project.standard_output_configuration.image.extraction.bounding_box.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.image.generative_field.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.image.generative_field.types #=> Array
resp.project.standard_output_configuration.image.generative_field.types[0] #=> String, one of "IMAGE_SUMMARY", "IAB"
resp.project.standard_output_configuration.video.extraction.category.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.video.extraction.category.types #=> Array
resp.project.standard_output_configuration.video.extraction.category.types[0] #=> String, one of "CONTENT_MODERATION", "TEXT_DETECTION", "TRANSCRIPT", "LOGOS"
resp.project.standard_output_configuration.video.extraction.bounding_box.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.video.generative_field.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.video.generative_field.types #=> Array
resp.project.standard_output_configuration.video.generative_field.types[0] #=> String, one of "VIDEO_SUMMARY", "IAB", "CHAPTER_SUMMARY"
resp.project.standard_output_configuration.audio.extraction.category.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.audio.extraction.category.types #=> Array
resp.project.standard_output_configuration.audio.extraction.category.types[0] #=> String, one of "AUDIO_CONTENT_MODERATION", "TRANSCRIPT", "TOPIC_CONTENT_MODERATION"
resp.project.standard_output_configuration.audio.extraction.category.type_configuration.transcript.speaker_labeling.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.audio.extraction.category.type_configuration.transcript.channel_labeling.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.audio.generative_field.state #=> String, one of "ENABLED", "DISABLED"
resp.project.standard_output_configuration.audio.generative_field.types #=> Array
resp.project.standard_output_configuration.audio.generative_field.types[0] #=> String, one of "AUDIO_SUMMARY", "IAB", "TOPIC_SUMMARY"
resp.project.custom_output_configuration.blueprints #=> Array
resp.project.custom_output_configuration.blueprints[0].blueprint_arn #=> String
resp.project.custom_output_configuration.blueprints[0].blueprint_version #=> String
resp.project.custom_output_configuration.blueprints[0].blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.project.custom_output_configuration.document.fallback_blueprints #=> Array
resp.project.custom_output_configuration.document.fallback_blueprints[0].blueprint_arn #=> String
resp.project.custom_output_configuration.document.fallback_blueprints[0].blueprint_version #=> String
resp.project.custom_output_configuration.document.fallback_blueprints[0].blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.project.override_configuration.document.splitter.state #=> String, one of "ENABLED", "DISABLED"
resp.project.override_configuration.document.modality_processing.state #=> String, one of "ENABLED", "DISABLED"
resp.project.override_configuration.document.sensitive_data_configuration.detection_mode #=> String, one of "DETECTION", "DETECTION_AND_REDACTION"
resp.project.override_configuration.document.sensitive_data_configuration.detection_scope #=> Array
resp.project.override_configuration.document.sensitive_data_configuration.detection_scope[0] #=> String, one of "STANDARD", "CUSTOM"
resp.project.override_configuration.document.sensitive_data_configuration.pii_entities_configuration.pii_entity_types #=> Array
resp.project.override_configuration.document.sensitive_data_configuration.pii_entities_configuration.pii_entity_types[0] #=> String, one of "ALL", "ADDRESS", "AGE", "NAME", "EMAIL", "PHONE", "USERNAME", "PASSWORD", "DRIVER_ID", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "PIN", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "IP_ADDRESS", "MAC_ADDRESS", "URL", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
resp.project.override_configuration.document.sensitive_data_configuration.pii_entities_configuration.redaction_mask_mode #=> String, one of "PII", "ENTITY_TYPE"
resp.project.override_configuration.image.modality_processing.state #=> String, one of "ENABLED", "DISABLED"
resp.project.override_configuration.image.sensitive_data_configuration.detection_mode #=> String, one of "DETECTION", "DETECTION_AND_REDACTION"
resp.project.override_configuration.image.sensitive_data_configuration.detection_scope #=> Array
resp.project.override_configuration.image.sensitive_data_configuration.detection_scope[0] #=> String, one of "STANDARD", "CUSTOM"
resp.project.override_configuration.image.sensitive_data_configuration.pii_entities_configuration.pii_entity_types #=> Array
resp.project.override_configuration.image.sensitive_data_configuration.pii_entities_configuration.pii_entity_types[0] #=> String, one of "ALL", "ADDRESS", "AGE", "NAME", "EMAIL", "PHONE", "USERNAME", "PASSWORD", "DRIVER_ID", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "PIN", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "IP_ADDRESS", "MAC_ADDRESS", "URL", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
resp.project.override_configuration.image.sensitive_data_configuration.pii_entities_configuration.redaction_mask_mode #=> String, one of "PII", "ENTITY_TYPE"
resp.project.override_configuration.video.modality_processing.state #=> String, one of "ENABLED", "DISABLED"
resp.project.override_configuration.video.sensitive_data_configuration.detection_mode #=> String, one of "DETECTION", "DETECTION_AND_REDACTION"
resp.project.override_configuration.video.sensitive_data_configuration.detection_scope #=> Array
resp.project.override_configuration.video.sensitive_data_configuration.detection_scope[0] #=> String, one of "STANDARD", "CUSTOM"
resp.project.override_configuration.video.sensitive_data_configuration.pii_entities_configuration.pii_entity_types #=> Array
resp.project.override_configuration.video.sensitive_data_configuration.pii_entities_configuration.pii_entity_types[0] #=> String, one of "ALL", "ADDRESS", "AGE", "NAME", "EMAIL", "PHONE", "USERNAME", "PASSWORD", "DRIVER_ID", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "PIN", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "IP_ADDRESS", "MAC_ADDRESS", "URL", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
resp.project.override_configuration.video.sensitive_data_configuration.pii_entities_configuration.redaction_mask_mode #=> String, one of "PII", "ENTITY_TYPE"
resp.project.override_configuration.audio.modality_processing.state #=> String, one of "ENABLED", "DISABLED"
resp.project.override_configuration.audio.language_configuration.input_languages #=> Array
resp.project.override_configuration.audio.language_configuration.input_languages[0] #=> String, one of "EN", "DE", "ES", "FR", "IT", "PT", "JA", "KO", "CN", "TW", "HK"
resp.project.override_configuration.audio.language_configuration.generative_output_language #=> String, one of "DEFAULT", "EN"
resp.project.override_configuration.audio.language_configuration.identify_multiple_languages #=> Boolean
resp.project.override_configuration.audio.sensitive_data_configuration.detection_mode #=> String, one of "DETECTION", "DETECTION_AND_REDACTION"
resp.project.override_configuration.audio.sensitive_data_configuration.detection_scope #=> Array
resp.project.override_configuration.audio.sensitive_data_configuration.detection_scope[0] #=> String, one of "STANDARD", "CUSTOM"
resp.project.override_configuration.audio.sensitive_data_configuration.pii_entities_configuration.pii_entity_types #=> Array
resp.project.override_configuration.audio.sensitive_data_configuration.pii_entities_configuration.pii_entity_types[0] #=> String, one of "ALL", "ADDRESS", "AGE", "NAME", "EMAIL", "PHONE", "USERNAME", "PASSWORD", "DRIVER_ID", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "PIN", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "IP_ADDRESS", "MAC_ADDRESS", "URL", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
resp.project.override_configuration.audio.sensitive_data_configuration.pii_entities_configuration.redaction_mask_mode #=> String, one of "PII", "ENTITY_TYPE"
resp.project.override_configuration.modality_routing.jpeg #=> String, one of "IMAGE", "DOCUMENT", "AUDIO", "VIDEO"
resp.project.override_configuration.modality_routing.png #=> String, one of "IMAGE", "DOCUMENT", "AUDIO", "VIDEO"
resp.project.override_configuration.modality_routing.mp4 #=> String, one of "IMAGE", "DOCUMENT", "AUDIO", "VIDEO"
resp.project.override_configuration.modality_routing.mov #=> String, one of "IMAGE", "DOCUMENT", "AUDIO", "VIDEO"
resp.project.data_automation_library_configuration.libraries #=> Array
resp.project.data_automation_library_configuration.libraries[0].library_arn #=> String
resp.project.status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"
resp.project.kms_key_id #=> String
resp.project.kms_encryption_context #=> Hash
resp.project.kms_encryption_context["EncryptionContextKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :project_arn (required, String) —

    ARN generated at the server side when a DataAutomationProject is created

  • :project_stage (String) —

    Optional field to delete a specific DataAutomationProject stage

Returns:

See Also:



1374
1375
1376
1377
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1374

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

#invoke_blueprint_optimization_async(params = {}) ⇒ Types::InvokeBlueprintOptimizationAsyncResponse

Invoke an async job to perform Blueprint Optimization

Examples:

Request syntax with placeholder values


resp = client.invoke_blueprint_optimization_async({
  blueprint: { # required
    blueprint_arn: "BlueprintArn", # required
    stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  },
  samples: [ # required
    {
      asset_s3_object: { # required
        s3_uri: "S3Uri", # required
        version: "S3ObjectVersion",
      },
      ground_truth_s3_object: { # required
        s3_uri: "S3Uri", # required
        version: "S3ObjectVersion",
      },
    },
  ],
  output_configuration: { # required
    s3_object: { # required
      s3_uri: "S3Uri", # required
      version: "S3ObjectVersion",
    },
  },
  data_automation_profile_arn: "DataAutomationProfileArn", # required
  encryption_configuration: {
    kms_key_id: "KmsKeyId", # required
    kms_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.invocation_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1451
1452
1453
1454
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1451

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

#invoke_data_automation_library_ingestion_job(params = {}) ⇒ Types::InvokeDataAutomationLibraryIngestionJobResponse

Async API: Invoke data automation library ingestion job

Examples:

Request syntax with placeholder values


resp = client.invoke_data_automation_library_ingestion_job({
  library_arn: "DataAutomationLibraryArn", # required
  client_token: "ClientToken",
  input_configuration: { # required
    s3_object: {
      s3_uri: "S3Uri", # required
      version: "S3ObjectVersion",
    },
    inline_payload: {
      upsert_entities_info: [
        {
          vocabulary: {
            entity_id: "EntityId",
            description: "EntityDescription",
            language: "EN", # required, accepts EN, DE, ES, FR, IT, PT, JA, KO, CN, TW, HK
            phrases: [ # required
              {
                text: "PhraseText", # required
                display_as_text: "PhraseDisplayAsText",
              },
            ],
          },
        },
      ],
      delete_entities_info: {
        entity_ids: ["EntityId"], # required
      },
    },
  },
  entity_type: "VOCABULARY", # required, accepts VOCABULARY
  operation_type: "UPSERT", # required, accepts UPSERT, DELETE
  output_configuration: { # required
    s3_uri: "S3Uri", # required
  },
  notification_configuration: {
    event_bridge_configuration: { # required
      event_bridge_enabled: false, # required
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.job_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

  • :client_token (String) —

    Idempotency token

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

  • :input_configuration (required, Types::InputConfiguration) —

    Input configuration of DataAutomationLibraryIngestionJob request

  • :entity_type (required, String) —

    The entity type for which DataAutomationLibraryIngestionJob is being run

  • :operation_type (required, String) —

    The operation to be performed by DataAutomationLibraryIngestionJob

  • :output_configuration (required, Types::OutputConfiguration) —

    Output configuration of DataAutomationLibraryIngestionJob

  • :notification_configuration (Types::NotificationConfiguration) —

    Notification configuration.

  • :tags (Array<Types::Tag>) —

    List of tags

Returns:

See Also:



1548
1549
1550
1551
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1548

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

#list_blueprints(params = {}) ⇒ Types::ListBlueprintsResponse

Lists all existing Amazon Bedrock Data Automation Blueprints

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_blueprints({
  blueprint_arn: "BlueprintArn",
  resource_owner: "SERVICE", # accepts SERVICE, ACCOUNT
  blueprint_stage_filter: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE, ALL
  max_results: 1,
  next_token: "NextToken",
  project_filter: {
    project_arn: "DataAutomationProjectArn", # required
    project_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  },
})

Response structure


resp.blueprints #=> Array
resp.blueprints[0].blueprint_arn #=> String
resp.blueprints[0].blueprint_version #=> String
resp.blueprints[0].blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.blueprints[0].blueprint_name #=> String
resp.blueprints[0].creation_time #=> Time
resp.blueprints[0].last_modified_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_arn (String) —

    ARN of a Blueprint

  • :resource_owner (String) —

    Resource Owner

  • :blueprint_stage_filter (String) —

    Blueprint Stage filter

  • :max_results (Integer) —

    Max Results

  • :next_token (String) —

    Pagination token

  • :project_filter (Types::DataAutomationProjectFilter) —

    Data Automation Project Filter

Returns:

See Also:



1609
1610
1611
1612
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1609

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

#list_data_automation_libraries(params = {}) ⇒ Types::ListDataAutomationLibrariesResponse

Lists all existing Amazon Bedrock Data Automation Libraries

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_automation_libraries({
  max_results: 1,
  next_token: "NextToken",
  project_filter: {
    project_arn: "DataAutomationProjectArn", # required
    project_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  },
})

Response structure


resp.libraries #=> Array
resp.libraries[0].library_arn #=> String
resp.libraries[0].library_name #=> String
resp.libraries[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Max Results

  • :next_token (String) —

    Pagination token

  • :project_filter (Types::DataAutomationProjectFilter) —

    Data Automation Project Filter

Returns:

See Also:



1655
1656
1657
1658
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1655

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

#list_data_automation_library_entities(params = {}) ⇒ Types::ListDataAutomationLibraryEntitiesResponse

Lists all stored entities in the library

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_automation_library_entities({
  library_arn: "DataAutomationLibraryArn", # required
  entity_type: "VOCABULARY", # required, accepts VOCABULARY
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.entities #=> Array
resp.entities[0].vocabulary.entity_id #=> String
resp.entities[0].vocabulary.description #=> String
resp.entities[0].vocabulary.language #=> String, one of "EN", "DE", "ES", "FR", "IT", "PT", "JA", "KO", "CN", "TW", "HK"
resp.entities[0].vocabulary.num_of_phrases #=> Integer
resp.entities[0].vocabulary.last_modified_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

  • :entity_type (required, String) —

    The entity type for which the entity list is requested

  • :max_results (Integer) —

    Max Results

  • :next_token (String) —

    Pagination token for retrieving the next set of results

Returns:

See Also:



1705
1706
1707
1708
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1705

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

#list_data_automation_library_ingestion_jobs(params = {}) ⇒ Types::ListDataAutomationLibraryIngestionJobsResponse

Lists all data automation library ingestion jobs

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_automation_library_ingestion_jobs({
  library_arn: "DataAutomationLibraryArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_arn #=> String
resp.jobs[0].job_status #=> String, one of "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.jobs[0].entity_type #=> String, one of "VOCABULARY"
resp.jobs[0].operation_type #=> String, one of "UPSERT", "DELETE"
resp.jobs[0].creation_time #=> Time
resp.jobs[0].completion_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

  • :max_results (Integer) —

    Max Results

  • :next_token (String) —

    Pagination token for retrieving the next set of results

Returns:

See Also:



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

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

#list_data_automation_projects(params = {}) ⇒ Types::ListDataAutomationProjectsResponse

Lists all existing Amazon Bedrock Data Automation 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_data_automation_projects({
  max_results: 1,
  next_token: "NextToken",
  project_stage_filter: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE, ALL
  blueprint_filter: {
    blueprint_arn: "BlueprintArn", # required
    blueprint_version: "BlueprintVersion",
    blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  },
  resource_owner: "SERVICE", # accepts SERVICE, ACCOUNT
  library_filter: {
    library_arn: "DataAutomationLibraryArn", # required
  },
})

Response structure


resp.projects #=> Array
resp.projects[0].project_arn #=> String
resp.projects[0].project_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.projects[0].project_type #=> String, one of "ASYNC", "SYNC"
resp.projects[0].project_name #=> String
resp.projects[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Max Results

  • :next_token (String) —

    Pagination token

  • :project_stage_filter (String) —

    Project Stage filter

  • :blueprint_filter (Types::BlueprintFilter) —

    Blueprint Filter

  • :resource_owner (String) —

    Resource Owner

  • :library_filter (Types::DataAutomationLibraryFilter) —

    Data Automation Library Filter

Returns:

See Also:



1815
1816
1817
1818
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1815

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

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

List tags for an Amazon Bedrock Data Automation resource

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of a taggable resource

Returns:

See Also:



1845
1846
1847
1848
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1845

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

#tag_resource(params = {}) ⇒ Struct

Tag an Amazon Bedrock Data Automation resource

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of a taggable resource

  • :tags (required, Array<Types::Tag>) —

    List of tags

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1876
1877
1878
1879
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1876

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

#untag_resource(params = {}) ⇒ Struct

Untag an Amazon Bedrock Data Automation resource

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of a taggable resource

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

    List of tag keys

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1902
1903
1904
1905
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1902

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

#update_blueprint(params = {}) ⇒ Types::UpdateBlueprintResponse

Updates an existing Amazon Bedrock Data Automation Blueprint

Examples:

Request syntax with placeholder values


resp = client.update_blueprint({
  blueprint_arn: "BlueprintArn", # required
  schema: "BlueprintSchema", # required
  blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  encryption_configuration: {
    kms_key_id: "KmsKeyId", # required
    kms_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
})

Response structure


resp.blueprint.blueprint_arn #=> String
resp.blueprint.schema #=> String
resp.blueprint.type #=> String, one of "DOCUMENT", "IMAGE", "AUDIO", "VIDEO"
resp.blueprint.creation_time #=> Time
resp.blueprint.last_modified_time #=> Time
resp.blueprint.blueprint_name #=> String
resp.blueprint.blueprint_version #=> String
resp.blueprint.blueprint_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.blueprint.kms_key_id #=> String
resp.blueprint.kms_encryption_context #=> Hash
resp.blueprint.kms_encryption_context["EncryptionContextKey"] #=> String
resp.blueprint.optimization_samples #=> Array
resp.blueprint.optimization_samples[0].asset_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].asset_s3_object.version #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.s3_uri #=> String
resp.blueprint.optimization_samples[0].ground_truth_s3_object.version #=> String
resp.blueprint.optimization_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :blueprint_arn (required, String) —

    ARN generated at the server side when a Blueprint is created

  • :schema (required, String) —

    Schema of the blueprint

  • :blueprint_stage (String) —

    Stage of the Blueprint

  • :encryption_configuration (Types::EncryptionConfiguration) —

    KMS Encryption Configuration

Returns:

See Also:



1963
1964
1965
1966
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 1963

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

#update_data_automation_library(params = {}) ⇒ Types::UpdateDataAutomationLibraryResponse

Updates an existing Amazon Bedrock Data Automation Library

Examples:

Request syntax with placeholder values


resp = client.update_data_automation_library({
  library_arn: "DataAutomationLibraryArn", # required
  library_description: "DataAutomationLibraryDescription",
  client_token: "ClientToken",
})

Response structure


resp.library_arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING"

Parameters:

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

    ({})

Options Hash (params):

  • :library_arn (required, String) —

    ARN generated at the server side when a DataAutomationLibrary is created

  • :library_description (String) —

    Description of the DataAutomationLibrary

  • :client_token (String) —

    Client specified token used for idempotency checks

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

Returns:

See Also:



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

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

#update_data_automation_project(params = {}) ⇒ Types::UpdateDataAutomationProjectResponse

Updates an existing Amazon Bedrock Data Automation Project

Examples:

Request syntax with placeholder values


resp = client.update_data_automation_project({
  project_arn: "DataAutomationProjectArn", # required
  project_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  project_description: "DataAutomationProjectDescription",
  standard_output_configuration: { # required
    document: {
      extraction: {
        granularity: { # required
          types: ["DOCUMENT"], # accepts DOCUMENT, PAGE, ELEMENT, WORD, LINE
        },
        bounding_box: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
      },
      output_format: {
        text_format: { # required
          types: ["PLAIN_TEXT"], # accepts PLAIN_TEXT, MARKDOWN, HTML, CSV
        },
        additional_file_format: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
    },
    image: {
      extraction: {
        category: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
          types: ["CONTENT_MODERATION"], # accepts CONTENT_MODERATION, TEXT_DETECTION, LOGOS
        },
        bounding_box: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        types: ["IMAGE_SUMMARY"], # accepts IMAGE_SUMMARY, IAB
      },
    },
    video: {
      extraction: {
        category: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
          types: ["CONTENT_MODERATION"], # accepts CONTENT_MODERATION, TEXT_DETECTION, TRANSCRIPT, LOGOS
        },
        bounding_box: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        types: ["VIDEO_SUMMARY"], # accepts VIDEO_SUMMARY, IAB, CHAPTER_SUMMARY
      },
    },
    audio: {
      extraction: {
        category: { # required
          state: "ENABLED", # required, accepts ENABLED, DISABLED
          types: ["AUDIO_CONTENT_MODERATION"], # accepts AUDIO_CONTENT_MODERATION, TRANSCRIPT, TOPIC_CONTENT_MODERATION
          type_configuration: {
            transcript: {
              speaker_labeling: {
                state: "ENABLED", # required, accepts ENABLED, DISABLED
              },
              channel_labeling: {
                state: "ENABLED", # required, accepts ENABLED, DISABLED
              },
            },
          },
        },
      },
      generative_field: {
        state: "ENABLED", # required, accepts ENABLED, DISABLED
        types: ["AUDIO_SUMMARY"], # accepts AUDIO_SUMMARY, IAB, TOPIC_SUMMARY
      },
    },
  },
  custom_output_configuration: {
    blueprints: [
      {
        blueprint_arn: "BlueprintArn", # required
        blueprint_version: "BlueprintVersion",
        blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
      },
    ],
    document: {
      fallback_blueprints: [
        {
          blueprint_arn: "BlueprintArn", # required
          blueprint_version: "BlueprintVersion",
          blueprint_stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
        },
      ],
    },
  },
  override_configuration: {
    document: {
      splitter: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    image: {
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    video: {
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    audio: {
      modality_processing: {
        state: "ENABLED", # accepts ENABLED, DISABLED
      },
      language_configuration: {
        input_languages: ["EN"], # accepts EN, DE, ES, FR, IT, PT, JA, KO, CN, TW, HK
        generative_output_language: "DEFAULT", # accepts DEFAULT, EN
        identify_multiple_languages: false,
      },
      sensitive_data_configuration: {
        detection_mode: "DETECTION", # required, accepts DETECTION, DETECTION_AND_REDACTION
        detection_scope: ["STANDARD"], # accepts STANDARD, CUSTOM
        pii_entities_configuration: {
          pii_entity_types: ["ALL"], # accepts ALL, ADDRESS, AGE, NAME, EMAIL, PHONE, USERNAME, PASSWORD, DRIVER_ID, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, PIN, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, IP_ADDRESS, MAC_ADDRESS, URL, AWS_ACCESS_KEY, AWS_SECRET_KEY, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
          redaction_mask_mode: "PII", # accepts PII, ENTITY_TYPE
        },
      },
    },
    modality_routing: {
      jpeg: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
      png: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
      mp4: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
      mov: "IMAGE", # accepts IMAGE, DOCUMENT, AUDIO, VIDEO
    },
  },
  data_automation_library_configuration: {
    libraries: [
      {
        library_arn: "DataAutomationLibraryArn", # required
      },
    ],
  },
  encryption_configuration: {
    kms_key_id: "KmsKeyId", # required
    kms_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
})

Response structure


resp.project_arn #=> String
resp.project_stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.status #=> String, one of "COMPLETED", "IN_PROGRESS", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



2235
2236
2237
2238
 
# File 'gems/aws-sdk-bedrockdataautomation/lib/aws-sdk-bedrockdataautomation/client.rb', line 2235

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