Interface ListCustomModelsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BedrockRequest.Builder
,Buildable
,CopyableBuilder<ListCustomModelsRequest.Builder,
,ListCustomModelsRequest> SdkBuilder<ListCustomModelsRequest.Builder,
,ListCustomModelsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListCustomModelsRequest
-
Method Summary
Modifier and TypeMethodDescriptionbaseModelArnEquals
(String baseModelArnEquals) Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.creationTimeAfter
(Instant creationTimeAfter) Return custom models created after the specified time.creationTimeBefore
(Instant creationTimeBefore) Return custom models created before the specified time.foundationModelArnEquals
(String foundationModelArnEquals) Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.Return custom models depending on if the current account owns them (true
) or if they were shared with the current account (false
).maxResults
(Integer maxResults) The maximum number of results to return in the response.modelStatus
(String modelStatus) The status of them model to filter results by.modelStatus
(ModelStatus modelStatus) The status of them model to filter results by.nameContains
(String nameContains) Return custom models only if the job name contains these characters.If the total number of results is greater than themaxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The field to sort by in the returned list of models.sortBy
(SortModelsBy sortBy) The field to sort by in the returned list of models.The sort order of the results.The sort order of the results.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
creationTimeBefore
Return custom models created before the specified time.
- Parameters:
creationTimeBefore
- Return custom models created before the specified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTimeAfter
Return custom models created after the specified time.
- Parameters:
creationTimeAfter
- Return custom models created after the specified time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nameContains
Return custom models only if the job name contains these characters.
- Parameters:
nameContains
- Return custom models only if the job name contains these characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
baseModelArnEquals
Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
- Parameters:
baseModelArnEquals
- Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
foundationModelArnEquals
Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
- Parameters:
foundationModelArnEquals
- Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results.- Parameters:
maxResults
- The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in thenextToken
field when making another request to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.- Parameters:
nextToken
- If the total number of results is greater than themaxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
The field to sort by in the returned list of models.
- Parameters:
sortBy
- The field to sort by in the returned list of models.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortBy
The field to sort by in the returned list of models.
- Parameters:
sortBy
- The field to sort by in the returned list of models.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The sort order of the results.
- Parameters:
sortOrder
- The sort order of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The sort order of the results.
- Parameters:
sortOrder
- The sort order of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isOwned
Return custom models depending on if the current account owns them (
true
) or if they were shared with the current account (false
).- Parameters:
isOwned
- Return custom models depending on if the current account owns them (true
) or if they were shared with the current account (false
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
modelStatus
The status of them model to filter results by. Possible values include:
-
Creating
- Include only models that are currently being created and validated. -
Active
- Include only models that have been successfully created and are ready for use. -
Failed
- Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
- Parameters:
modelStatus
- The status of them model to filter results by. Possible values include:-
Creating
- Include only models that are currently being created and validated. -
Active
- Include only models that have been successfully created and are ready for use. -
Failed
- Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
modelStatus
The status of them model to filter results by. Possible values include:
-
Creating
- Include only models that are currently being created and validated. -
Active
- Include only models that have been successfully created and are ready for use. -
Failed
- Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
- Parameters:
modelStatus
- The status of them model to filter results by. Possible values include:-
Creating
- Include only models that are currently being created and validated. -
Active
- Include only models that have been successfully created and are ready for use. -
Failed
- Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
overrideConfiguration
ListCustomModelsRequest.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
ListCustomModelsRequest.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.
-