BatchDataCaptureConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class BatchDataCaptureConfig

java.lang.Object
- com.amazonaws.services.sagemaker.model.BatchDataCaptureConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchDataCaptureConfig
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Configuration to control how SageMaker captures inference data for batch transform jobs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BatchDataCaptureConfig ()

Constructors
Constructor and Description
`BatchDataCaptureConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`BatchDataCaptureConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getDestinationS3Uri ()` The Amazon S3 location being used to capture the data.
`Boolean`	`getGenerateInferenceId ()` Flag that indicates whether to append inference id to the output.
`String`	`getKmsKeyId ()` The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
`int`	`hashCode ()`
`Boolean`	`isGenerateInferenceId ()` Flag that indicates whether to append inference id to the output.
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDestinationS3Uri (String destinationS3Uri)` The Amazon S3 location being used to capture the data.
`void`	`setGenerateInferenceId (Boolean generateInferenceId)` Flag that indicates whether to append inference id to the output.
`void`	`setKmsKeyId (String kmsKeyId)` The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
`String`	`toString ()` Returns a string representation of this object.
`BatchDataCaptureConfig`	`withDestinationS3Uri (String destinationS3Uri)` The Amazon S3 location being used to capture the data.
`BatchDataCaptureConfig`	`withGenerateInferenceId (Boolean generateInferenceId)` Flag that indicates whether to append inference id to the output.
`BatchDataCaptureConfig`	`withKmsKeyId (String kmsKeyId)` The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchDataCaptureConfig
```
public BatchDataCaptureConfig()
```
- Method Detail
  - setDestinationS3Uri
```
public void setDestinationS3Uri(String destinationS3Uri)
```
    The Amazon S3 location being used to capture the data.
    
    Parameters:
    
    destinationS3Uri - The Amazon S3 location being used to capture the data.
  - getDestinationS3Uri
```
public String getDestinationS3Uri()
```
    The Amazon S3 location being used to capture the data.
    
    Returns:
    
    The Amazon S3 location being used to capture the data.
  - withDestinationS3Uri
```
public BatchDataCaptureConfig withDestinationS3Uri(String destinationS3Uri)
```
    The Amazon S3 location being used to capture the data.
    
    Parameters:
    
    destinationS3Uri - The Amazon S3 location being used to capture the data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
    
    The KmsKeyId can be any of the following formats:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Parameters:
    kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
    
    The KmsKeyId can be any of the following formats:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
    
    The KmsKeyId can be any of the following formats:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Returns:
    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
    
    The KmsKeyId can be any of the following formats:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
  - withKmsKeyId
```
public BatchDataCaptureConfig withKmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
    
    The KmsKeyId can be any of the following formats:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Parameters:
    kmsKeyId - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.
    
    The KmsKeyId can be any of the following formats:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGenerateInferenceId
```
public void setGenerateInferenceId(Boolean generateInferenceId)
```
    Flag that indicates whether to append inference id to the output.
    
    Parameters:
    
    generateInferenceId - Flag that indicates whether to append inference id to the output.
  - getGenerateInferenceId
```
public Boolean getGenerateInferenceId()
```
    Flag that indicates whether to append inference id to the output.
    
    Returns:
    
    Flag that indicates whether to append inference id to the output.
  - withGenerateInferenceId
```
public BatchDataCaptureConfig withGenerateInferenceId(Boolean generateInferenceId)
```
    Flag that indicates whether to append inference id to the output.
    
    Parameters:
    
    generateInferenceId - Flag that indicates whether to append inference id to the output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isGenerateInferenceId
```
public Boolean isGenerateInferenceId()
```
    Flag that indicates whether to append inference id to the output.
    
    Returns:
    
    Flag that indicates whether to append inference id to the output.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public BatchDataCaptureConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class BatchDataCaptureConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BatchDataCaptureConfig

Method Detail

setDestinationS3Uri

getDestinationS3Uri

withDestinationS3Uri

setKmsKeyId

getKmsKeyId

withKmsKeyId

setGenerateInferenceId

getGenerateInferenceId

withGenerateInferenceId

isGenerateInferenceId

toString

equals

hashCode

clone

marshall