Interface ListCustomModelsRequest.Builder

  • Method Details

    • creationTimeBefore

      ListCustomModelsRequest.Builder creationTimeBefore(Instant 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

      ListCustomModelsRequest.Builder creationTimeAfter(Instant 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

      ListCustomModelsRequest.Builder nameContains(String 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

      ListCustomModelsRequest.Builder baseModelArnEquals(String 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

      ListCustomModelsRequest.Builder foundationModelArnEquals(String 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

      ListCustomModelsRequest.Builder maxResults(Integer 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 the nextToken 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 the nextToken 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 the maxResults value provided in the request, enter the token returned in the nextToken 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

      ListCustomModelsRequest.Builder modelStatus(String 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

      ListCustomModelsRequest.Builder modelStatus(ModelStatus 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 interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.