Package software.amazon.awssdk.services.bedrockdataautomationruntime

Interface BedrockDataAutomationRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BedrockDataAutomationRuntimeClient
extends AwsClient

Service client for accessing Runtime for Amazon Bedrock Data Automation. This can be created using the static builder() method.

Amazon Bedrock Data Automation Runtime

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static BedrockDataAutomationRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a BedrockDataAutomationRuntimeClient.
static BedrockDataAutomationRuntimeClient	create()	Create a BedrockDataAutomationRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetDataAutomationStatusResponse	getDataAutomationStatus(Consumer<GetDataAutomationStatusRequest.Builder> getDataAutomationStatusRequest)	API used to get data automation status.
default GetDataAutomationStatusResponse	getDataAutomationStatus(GetDataAutomationStatusRequest getDataAutomationStatusRequest)	API used to get data automation status.
default InvokeDataAutomationAsyncResponse	invokeDataAutomationAsync(Consumer<InvokeDataAutomationAsyncRequest.Builder> invokeDataAutomationAsyncRequest)	Async API: Invoke data automation.
default InvokeDataAutomationAsyncResponse	invokeDataAutomationAsync(InvokeDataAutomationAsyncRequest invokeDataAutomationAsyncRequest)	Async API: Invoke data automation.
default BedrockDataAutomationRuntimeServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

getDataAutomationStatus

default GetDataAutomationStatusResponse getDataAutomationStatus(GetDataAutomationStatusRequest getDataAutomationStatusRequest)
                                                         throws AccessDeniedException,
                                                                ValidationException,
                                                                InternalServerException,
                                                                ThrottlingException,
                                                                ResourceNotFoundException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                BedrockDataAutomationRuntimeException

API used to get data automation status.

Parameters:

getDataAutomationStatusRequest - Structure for request of GetDataAutomationStatus API.

Returns:

Result of the GetDataAutomationStatus operation returned by the service.

Throws:

AccessDeniedException - This exception will be thrown when customer does not have access to API.

ValidationException - This exception will be thrown when customer provided invalid parameters.

InternalServerException - This exception is for any internal un-expected service errors.

ThrottlingException - This exception will be thrown when customer reached API TPS limit.

ResourceNotFoundException - This exception will be thrown when resource provided from customer not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockDataAutomationRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getDataAutomationStatus

default GetDataAutomationStatusResponse getDataAutomationStatus(Consumer<GetDataAutomationStatusRequest.Builder> getDataAutomationStatusRequest)
                                                         throws AccessDeniedException,
                                                                ValidationException,
                                                                InternalServerException,
                                                                ThrottlingException,
                                                                ResourceNotFoundException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                BedrockDataAutomationRuntimeException

API used to get data automation status.

This is a convenience which creates an instance of the GetDataAutomationStatusRequest.Builder avoiding the need to create one manually via GetDataAutomationStatusRequest.builder()

Parameters:

getDataAutomationStatusRequest - A Consumer that will call methods on GetDataAutomationStatusRequest.Builder to create a request. Structure for request of GetDataAutomationStatus API.

Returns:

Result of the GetDataAutomationStatus operation returned by the service.

Throws:

AccessDeniedException - This exception will be thrown when customer does not have access to API.

ValidationException - This exception will be thrown when customer provided invalid parameters.

InternalServerException - This exception is for any internal un-expected service errors.

ThrottlingException - This exception will be thrown when customer reached API TPS limit.

ResourceNotFoundException - This exception will be thrown when resource provided from customer not found.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockDataAutomationRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

invokeDataAutomationAsync

default InvokeDataAutomationAsyncResponse invokeDataAutomationAsync(InvokeDataAutomationAsyncRequest invokeDataAutomationAsyncRequest)
                                                             throws ServiceQuotaExceededException,
                                                                    AccessDeniedException,
                                                                    ValidationException,
                                                                    InternalServerException,
                                                                    ThrottlingException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    BedrockDataAutomationRuntimeException

Async API: Invoke data automation.

Parameters:

invokeDataAutomationAsyncRequest - Invoke Data Automation Async Request

Returns:

Result of the InvokeDataAutomationAsync operation returned by the service.

Throws:

ServiceQuotaExceededException - This exception will be thrown when service quota is exceeded.

AccessDeniedException - This exception will be thrown when customer does not have access to API.

ValidationException - This exception will be thrown when customer provided invalid parameters.

InternalServerException - This exception is for any internal un-expected service errors.

ThrottlingException - This exception will be thrown when customer reached API TPS limit.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockDataAutomationRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

invokeDataAutomationAsync

default InvokeDataAutomationAsyncResponse invokeDataAutomationAsync(Consumer<InvokeDataAutomationAsyncRequest.Builder> invokeDataAutomationAsyncRequest)
                                                             throws ServiceQuotaExceededException,
                                                                    AccessDeniedException,
                                                                    ValidationException,
                                                                    InternalServerException,
                                                                    ThrottlingException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    BedrockDataAutomationRuntimeException

Async API: Invoke data automation.

This is a convenience which creates an instance of the InvokeDataAutomationAsyncRequest.Builder avoiding the need to create one manually via InvokeDataAutomationAsyncRequest.builder()

Parameters:

invokeDataAutomationAsyncRequest - A Consumer that will call methods on InvokeDataAutomationAsyncRequest.Builder to create a request. Invoke Data Automation Async Request

Returns:

Result of the InvokeDataAutomationAsync operation returned by the service.

Throws:

ServiceQuotaExceededException - This exception will be thrown when service quota is exceeded.

AccessDeniedException - This exception will be thrown when customer does not have access to API.

ValidationException - This exception will be thrown when customer provided invalid parameters.

InternalServerException - This exception is for any internal un-expected service errors.

ThrottlingException - This exception will be thrown when customer reached API TPS limit.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockDataAutomationRuntimeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static BedrockDataAutomationRuntimeClient create()

Create a BedrockDataAutomationRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BedrockDataAutomationRuntimeClientBuilder builder()

Create a builder that can be used to configure and create a BedrockDataAutomationRuntimeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BedrockDataAutomationRuntimeServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient