Interface SageMakerMetricsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SageMakerMetricsClient extends AwsClient
Service client for accessing SageMaker Metrics. This can be created using the staticbuilder()method.Contains all data plane API operations and data types for Amazon SageMaker Metrics. Use these APIs to put and retrieve (get) features related to your training run.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default BatchPutMetricsResponsebatchPutMetrics(Consumer<BatchPutMetricsRequest.Builder> batchPutMetricsRequest)Used to ingest training metrics into SageMaker.default BatchPutMetricsResponsebatchPutMetrics(BatchPutMetricsRequest batchPutMetricsRequest)Used to ingest training metrics into SageMaker.static SageMakerMetricsClientBuilderbuilder()Create a builder that can be used to configure and create aSageMakerMetricsClient.static SageMakerMetricsClientcreate()Create aSageMakerMetricsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default SageMakerMetricsServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchPutMetrics
default BatchPutMetricsResponse batchPutMetrics(BatchPutMetricsRequest batchPutMetricsRequest) throws AwsServiceException, SdkClientException, SageMakerMetricsException
Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and retrieved with the
GetMetricsAPI.- Parameters:
batchPutMetricsRequest-- Returns:
- Result of the BatchPutMetrics operation returned by the service.
- Throws:
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.SageMakerMetricsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutMetrics
default BatchPutMetricsResponse batchPutMetrics(Consumer<BatchPutMetricsRequest.Builder> batchPutMetricsRequest) throws AwsServiceException, SdkClientException, SageMakerMetricsException
Used to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio and retrieved with the
GetMetricsAPI.
This is a convenience which creates an instance of the
BatchPutMetricsRequest.Builderavoiding the need to create one manually viaBatchPutMetricsRequest.builder()- Parameters:
batchPutMetricsRequest- AConsumerthat will call methods onBatchPutMetricsRequest.Builderto create a request.- Returns:
- Result of the BatchPutMetrics operation returned by the service.
- Throws:
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.SageMakerMetricsException- 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 SageMakerMetricsClient create()
Create aSageMakerMetricsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SageMakerMetricsClientBuilder builder()
Create a builder that can be used to configure and create aSageMakerMetricsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SageMakerMetricsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-