Interface InvokeEndpointAsyncRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<InvokeEndpointAsyncRequest.Builder,
,InvokeEndpointAsyncRequest> SageMakerRuntimeRequest.Builder
,SdkBuilder<InvokeEndpointAsyncRequest.Builder,
,InvokeEndpointAsyncRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
InvokeEndpointAsyncRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe desired MIME type of the inference response from the model container.contentType
(String contentType) The MIME type of the input data in the request body.customAttributes
(String customAttributes) Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.endpointName
(String endpointName) The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.inferenceId
(String inferenceId) The identifier for the inference request.inputLocation
(String inputLocation) The Amazon S3 URI where the inference request payload is stored.invocationTimeoutSeconds
(Integer invocationTimeoutSeconds) Maximum amount of time in seconds a request can be processed before it is marked as expired.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestTTLSeconds
(Integer requestTTLSeconds) Maximum age in seconds a request can be in the queue before it is marked as expired.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemakerruntime.model.SageMakerRuntimeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
endpointName
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
- Parameters:
endpointName
- The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentType
The MIME type of the input data in the request body.
- Parameters:
contentType
- The MIME type of the input data in the request body.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accept
The desired MIME type of the inference response from the model container.
- Parameters:
accept
- The desired MIME type of the inference response from the model container.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customAttributes
Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).
The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with
Trace ID:
in your post-processing function.This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
- Parameters:
customAttributes
- Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with
Trace ID:
in your post-processing function.This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inferenceId
The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.
- Parameters:
inferenceId
- The identifier for the inference request. Amazon SageMaker will generate an identifier for you if none is specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputLocation
The Amazon S3 URI where the inference request payload is stored.
- Parameters:
inputLocation
- The Amazon S3 URI where the inference request payload is stored.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestTTLSeconds
Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.
- Parameters:
requestTTLSeconds
- Maximum age in seconds a request can be in the queue before it is marked as expired. The default is 6 hours, or 21,600 seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
invocationTimeoutSeconds
Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.
- Parameters:
invocationTimeoutSeconds
- Maximum amount of time in seconds a request can be processed before it is marked as expired. The default is 15 minutes, or 900 seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
InvokeEndpointAsyncRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
InvokeEndpointAsyncRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-