Interface DescribeModelCardRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeModelCardRequest.Builder,DescribeModelCardRequest>, SageMakerRequest.Builder, SdkBuilder<DescribeModelCardRequest.Builder,DescribeModelCardRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeModelCardRequest
@Mutable @NotThreadSafe public static interface DescribeModelCardRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<DescribeModelCardRequest.Builder,DescribeModelCardRequest>

  • Method Details

    • modelCardName

      DescribeModelCardRequest.Builder modelCardName(String modelCardName)

      The name or Amazon Resource Name (ARN) of the model card to describe.

      Parameters:
      modelCardName - The name or Amazon Resource Name (ARN) of the model card to describe.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelCardVersion

      DescribeModelCardRequest.Builder modelCardVersion(Integer modelCardVersion)

      The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

      Parameters:
      modelCardVersion - The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includedData

      DescribeModelCardRequest.Builder includedData(String includedData)

      Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

      • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

      • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

      If you don't specify a value, SageMaker returns AllData.

      Parameters:
      includedData - Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

      • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

      • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

      If you don't specify a value, SageMaker returns AllData.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includedData

      DescribeModelCardRequest.Builder includedData(IncludedData includedData)

      Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

      • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

      • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

      If you don't specify a value, SageMaker returns AllData.

      Parameters:
      includedData - Specifies the level of model card data to include in the response. Use this parameter to call DescribeModelCard without requiring kms:Decrypt permission on the customer-managed Amazon Web Services KMS key.

      • AllData: Returns the full model card Content. This option requires kms:Decrypt permission on the customer-managed key, if one is associated with the model card. This is the default.

      • MetadataOnly: Returns the model card with sanitized Content that includes only a small set of unencrypted metadata fields. This option does not require kms:Decrypt permission. For the list of fields preserved in the response, see Content.

      If you don't specify a value, SageMaker returns AllData.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DescribeModelCardRequest.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

      DescribeModelCardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.